ack_menu.pages.inc in Access Control Kit 7

Page callbacks for managing menu links in assigned realms.

File

ack_menu/ack_menu.pages.inc

<?php

/**
 * @file
 * Page callbacks for managing menu links in assigned realms.
 */

/**
 * Menu page callback which shows an overview of all accessible menus.
 *
 * @see menu_overview_page()
 */
function ack_menu_admin_page() {
  $result = db_query("SELECT * FROM {menu_custom} ORDER BY title", array(), array(
    'fetch' => PDO::FETCH_ASSOC,
  ));
  $header = array(
    t('Title'),
    array(
      'data' => t('Operations'),
      'colspan' => '3',
    ),
  );
  $rows = array();
  foreach ($result as $menu) {
    if (ack_menu_menu_access($menu)) {
      $row = array(
        theme('menu_admin_overview', array(
          'title' => $menu['title'],
          'name' => $menu['menu_name'],
          'description' => $menu['description'],
        )),
      );
      $row[] = array(
        'data' => l(t('list links'), 'admin/structure/menu/manage/' . $menu['menu_name']),
      );
      $row[] = array(
        'data' => l(t('edit menu'), 'admin/structure/menu/manage/' . $menu['menu_name'] . '/edit'),
      );
      $row[] = array(
        'data' => l(t('add link'), 'admin/structure/menu/manage/' . $menu['menu_name'] . '/add'),
      );
      $rows[] = $row;
    }
  }
  return theme('table', array(
    'header' => $header,
    'rows' => $rows,
  ));
}

/**
 * Menu page callback to list the realms wherein the user may manage menu links.
 *
 * @return array
 *   A renderable array.
 */
function ack_menu_overview_page() {
  $scheme_realms = _ack_menu_user_realms();
  $number_of_user_schemes = count($scheme_realms);
  $render = array();
  foreach ($scheme_realms as $scheme_machine_name => $realms) {
    if (!empty($realms)) {
      $scheme = access_scheme_machine_name_load($scheme_machine_name);
      $label = check_plain($scheme->name);
      if ($number_of_user_schemes > 1) {
        $render[$scheme_machine_name]['header'] = array(
          '#type' => 'markup',
          '#markup' => '<h2>' . $label . '</h2>',
        );
      }
      $header = array(
        $label,
        array(
          'data' => t('Operations'),
          'colspan' => 2,
        ),
      );
      $rows = array();
      foreach ($realms as $realm) {
        $row = array();
        $row[] = check_plain($scheme->realms[$realm]);
        $row[] = array(
          'data' => l(t('list links'), 'ack_menu/manage/' . $scheme_machine_name . '/' . $realm),
        );
        $row[] = array(
          'data' => l(t('add link'), 'ack_menu/manage/' . $scheme_machine_name . '/' . $realm . '/add'),
        );
        $rows[] = $row;
      }
      $render[$scheme_machine_name]['table'] = array(
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
      );
    }
  }
  if (empty($render)) {
    if (ack_menu_admin_access()) {
      $empty = t('No access schemes have been configured to manage menu links.');
      if (user_access('administer access schemes')) {
        $empty .= ' ' . t('To configure an access scheme to manage the menu, use the <a href="@url">access scheme administration page</a> to add a menu access handler to a scheme.', array(
          '@url' => url('admin/structure/access'),
        ));
      }
    }
    else {
      $empty = t('You have not been granted access to any menu trees.');
    }
    $render['empty'] = array(
      '#type' => 'markup',
      '#markup' => $empty,
    );
  }
  return $render;
}

/**
 * Form for editing the menu tree for a realm.
 *
 * Shows all of the menu links for the given realm and relevant operations.
 *
 * @param object $scheme
 *   An access scheme.
 * @param int $realm
 *   A realm value.
 *
 * @return array
 *   A form array.
 *
 * @see ack_menu_overview_form_submit()
 */
function ack_menu_overview_form($form, &$form_state, $scheme, $realm) {
  global $menu_admin;
  module_load_include('inc', 'menu', 'menu.admin');
  $form['#attached']['css'] = array(
    drupal_get_path('module', 'menu') . '/menu.css',
  );
  $form_state['scheme'] = $scheme;
  $form_state['realm'] = $realm;
  if (isset($scheme->handlers['menu_link'])) {
    $links = ack_menu_realm_links($scheme, $realm);
    if (!empty($links)) {
      $tree = ack_menu_tree_data($links);
      $count = count($tree);

      // Loop through the links at the top level of the tree.
      foreach ($tree as $data) {
        $item = $data['link'];

        // Don't show callbacks; these have $item['hidden'] < 0.
        if ($item && $item['hidden'] >= 0) {
          _menu_link_translate($item);
          $element = array(
            '#type' => $count > 1 ? 'fieldset' : 'container',
            '#tree' => TRUE,
          );
          if ($count > 1) {
            $element['#title'] = l($item['title'], $item['href'], $item['localized_options']);
          }
          $destination = drupal_get_destination();
          $element['link'] = array(
            '#type' => 'link',
            '#title' => t('Edit the parent link'),
            '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/edit',
            '#prefix' => '<ul class="action-links"><li>',
            '#suffix' => '</li></ul>',
            '#options' => array(
              'query' => $destination,
            ),
          );
          $element['depth'] = array(
            '#type' => 'value',
            '#value' => $item['depth'],
          );
          if (!empty($data['below'])) {

            // Build the subtree form in the same way as menu_overview_form().
            $node_links = array();
            menu_tree_collect_node_links($data['below'], $node_links);
            $menu_admin = TRUE;
            menu_tree_check_access($data['below'], $node_links);
            $menu_admin = FALSE;
            drupal_static_reset('_menu_overview_tree_form');
            $element['subtree'] = _menu_overview_tree_form($data['below']);
            $element['subtree']['#theme'] = 'menu_overview_form';
            foreach (element_children($element['subtree']) as $key) {

              // Adjust depth so links cannot be moved above the subtree parent.
              if (isset($element['subtree'][$key]['#item'])) {
                $element['subtree'][$key]['#item']['depth'] -= $item['depth'];

                // Remove the edit/delete links for inaccessible branches.
                if (!ack_menu_link_access($element['subtree'][$key]['#item'])) {
                  $element['subtree'][$key]['operations'] = array();
                }
              }

              // Set the redirect destination on the edit/delete links.
              foreach (element_children($element['subtree'][$key]['operations']) as $op) {
                $element['subtree'][$key]['operations'][$op]['#options']['query'] = $destination;
              }
            }
          }
          $form[$item['mlid']] = $element;
        }
      }
    }
  }
  if (element_children($form)) {
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save configuration'),
    );
    $form['actions']['cancel'] = array(
      '#type' => 'link',
      '#title' => t('Cancel'),
      '#href' => 'ack_menu',
    );
  }
  else {
    $form['empty'] = array(
      '#type' => 'markup',
      '#markup' => t('There are no menu links yet for @realm. <a href="@link">Add a link</a>.', array(
        '@realm' => $scheme->realms[$realm],
        '@link' => url('ack_menu/manage/' . $scheme->machine_name . '/' . $realm . '/add'),
      )),
    );
  }
  return $form;
}

/**
 * Sorts and returns a realm's links as a menu tree.
 *
 * @param array $links
 *   A flat array of menu links, as returned by ack_menu_realm_links().
 *
 * @return array
 *   An array of menu links in the form of a tree. Each item in the tree is an
 *   associative array containing:
 *   - link: The menu link item from $links.
 *   - below: An array containing the subtree of this item, where each element
 *     is a tree item array with 'link' and 'below' elements. This array will be
 *     empty if the menu item has no accessible items in its subtree.
 */
function ack_menu_tree_data(array $links) {

  // Reverse the array so we can use the more efficient array_pop() function.
  $links = array_reverse($links);
  return _ack_menu_tree_data($links);
}

/**
 * Helper function for ack_menu_tree_data() to build a realm menu tree.
 */
function _ack_menu_tree_data(&$links, $plid = 0) {
  $tree = array();
  while ($item = array_pop($links)) {

    // _menu_tree_check_access() expects a value for 'in_active_trail', which
    // we'll just set to FALSE here because ack_menu is not used when building
    // the active trail and breadcrumb.
    $item['in_active_trail'] = FALSE;

    // Add the current link to the tree.
    $tree[$item['mlid']] = array(
      'link' => $item,
      'below' => array(),
    );

    // If the next link is a child of the current link, start a subtree.
    $next = end($links);
    if ($next && $next['plid'] == $item['mlid']) {
      $subtree = _ack_menu_tree_data($links, $item['mlid']);
      if (ack_menu_link_access($item)) {
        $tree[$item['mlid']]['below'] = $subtree;
      }
      $next = end($links);
    }

    // If this is a subtree ($plid > 0) and the next link is not in the subtree,
    // then we need to exit the loop and return.
    if (!$next || $plid && $next['plid'] != $plid) {
      break;
    }
  }
  return $tree;
}

/**
 * Submit handler for editing the menu tree for a realm.
 *
 * @see ack_menu_overview_form()
 */
function ack_menu_overview_form_submit($form, &$form_state) {
  foreach (element_children($form) as $mlid) {

    // Save the descendant links.
    if (isset($form[$mlid]['subtree'])) {

      // Undo the depth adjustment from ack_menu_overview_form().
      $depth = $form_state['values'][$mlid]['depth'];
      $subtree =& $form[$mlid]['subtree'];
      foreach (element_children($subtree) as $key) {
        if (isset($subtree[$key]['#item'])) {
          $subtree[$key]['#item']['depth'] += $depth;
        }
      }

      // Prepare a faux $form_state array that represents the subtree in the
      // format expected by menu_overview_form_submit().
      $subtree_form_state = array(
        'input' => $form_state['input'][$mlid]['subtree'],
        'values' => $form_state['values'][$mlid]['subtree'],
      );
      menu_overview_form_submit($subtree, $subtree_form_state);
    }
  }
}

/**
 * Menu page callback to add a menu link to a realm.
 *
 * @param object $scheme
 *   An access scheme.
 * @param int $realm
 *   A realm value.
 *
 * @return array
 *   A renderable form.
 */
function ack_menu_link_add($scheme, $realm) {
  module_load_include('inc', 'menu', 'menu.admin');
  $handler = $scheme->handlers['menu_link'];
  $menu_name = $handler
    ->realmMenu($realm);
  $menu = empty($menu_name) ? menu_load('navigation') : menu_load($menu_name);
  $form_state = array(
    'ack_menu' => array(
      'schemes' => array(
        $scheme,
      ),
      'realms' => array(
        $scheme->machine_name => array(
          $realm,
        ),
      ),
      'destination' => 'ack_menu/manage/' . $scheme->machine_name . '/' . $realm,
    ),
    'build_info' => array(
      'args' => array(
        'add',
        NULL,
        $menu,
      ),
    ),
  );
  return drupal_build_form('menu_edit_item', $form_state);
}

Functions

Name	Description
ack_menu_admin_page	Menu page callback which shows an overview of all accessible menus.
ack_menu_link_add	Menu page callback to add a menu link to a realm.
ack_menu_overview_form	Form for editing the menu tree for a realm.
ack_menu_overview_form_submit	Submit handler for editing the menu tree for a realm.
ack_menu_overview_page	Menu page callback to list the realms wherein the user may manage menu links.
ack_menu_tree_data	Sorts and returns a realm's links as a menu tree.
_ack_menu_tree_data	Helper function for ack_menu_tree_data() to build a realm menu tree.