menu_tree.inc in Menu Block 6.2

Provides ctools integration for "Menu block" trees.

"Menu block" trees operate with no context at all. They are basically the same as a 'custom content' block, but not even that sophisticated.

File

plugins/content_types/menu_tree/menu_tree.inc

<?php

/**
 * @file
 * Provides ctools integration for "Menu block" trees.
 *
 * "Menu block" trees operate with no context at all. They are basically the
 * same as a 'custom content' block, but not even that sophisticated.
 */

/**
 * Plugins are described by creating a $plugin array which will be used
 * by the system that includes this file.
 */
$plugin = array(
  // And this is just the administrative title.
  // All our callbacks are named according to the standard pattern and can be deduced.
  'title' => t('Menu tree'),
);

/**
 * Supplies a list of menu tree content sub-types.
 */
function menu_block_menu_tree_content_type_content_types() {
  $common_plugin = array(
    'description' => t('A configurable tree provided by Menu block.'),
    'icon' => 'icon_contrib_menu.png',
    'category' => array(
      t('Menus'),
      -9,
    ),
    // The default context.
    'defaults' => menu_block_get_config(),
    // JavaScript and CSS for the config form.
    'js' => array(
      drupal_get_path('module', 'menu_block') . '/menu-block.js',
    ),
    'css' => array(
      drupal_get_path('module', 'menu_block') . '/menu-block-admin.css',
    ),
  );
  unset($common_plugin['defaults']['delta']);
  $menus = menu_block_get_all_menus();
  $items = array();
  foreach ($menus as $menu_name => $title) {
    $items[$menu_name] = $common_plugin;
    $items[$menu_name]['title'] = t('%menu menu tree', array(
      '%menu' => $title,
    ));
    $items[$menu_name]['defaults']['menu_name'] = $menu_name;
    $items[$menu_name]['menu_title'] = $title;

    // Custom icons/titles for some menus.
    switch ($menu_name) {
      case MENU_TREE__CURRENT_PAGE_MENU:
        $items[$menu_name]['title'] = t('menu tree of %menu', array(
          '%menu' => 'the menu selected by the page',
        ));
        break;
      case 'primary-links':
      case 'secondary-links':
        $items[$menu_name]['icon'] = 'icon_contrib_primarylinks.png';
        break;
      case 'navigation':
        $items[$menu_name]['icon'] = 'icon_contrib_navigation.png';
        break;
    }
    if (strpos($menu_name, 'book-toc-') === 0) {
      $items[$menu_name]['icon'] = 'icon_contrib_booknavigation.png';
    }
  }
  return $items;
}

/**
 * Renders a menu_tree content type based on the delta supplied in the configuration.
 *
 * @param $subtype
 * @param $conf
 *   Configuration as done at admin time.
 * @param $args
 * @param $context
 *   Context; in this case we don't have any.
 * @return
 *   object An object with at least title and content members.
 */
function menu_block_menu_tree_content_type_render($subtype, $conf, $args, $context) {

  // Ensure the delta is unique.
  static $ids = array();
  if (empty($ids[$conf['menu_name']])) {
    $ids[$conf['menu_name']] = 0;
  }
  $delta = ++$ids[$conf['menu_name']];
  $conf['delta'] = 'ctools-' . $conf['menu_name'] . '-' . $delta;
  $tree = menu_tree_build($conf);
  $block = new stdClass();
  $block->subtype = $conf['menu_name'];
  $block->title = $tree['subject'];
  $block->content = $tree['content'];
  return $block;
}

/**
 * 'Edit form' callback for the content type.
 */
function menu_block_menu_tree_content_type_edit_form(&$form, &$form_state) {
  $conf = $form_state['conf'];

  // Load the standard config form.
  module_load_include('inc', 'menu_block', 'menu_block.admin');

  // Create a pseudo form state.
  $sub_form_state = array(
    'values' => $conf,
  );
  $form += menu_block_configure_form($sub_form_state);

  // Set the options to a simple list of menu links for the configured menu.
  $menus = menu_block_get_all_menus();
  $form['parent']['#options'] = menu_parent_options(array(
    $conf['menu_name'] => $menus[$conf['menu_name']],
  ), array(
    'mlid' => 0,
  ));

  // Hide the Parent item option for the special "active" menu.
  if ($conf['menu_name'] == MENU_TREE__CURRENT_PAGE_MENU) {
    $form['parent']['#type'] = 'hidden';
    $form['admin_title']['#suffix'] = '<div id="edit-parent-wrapper"><strong>' . t('Parent item:') . '</strong><br />' . t('<em>The menu selected by the page</em> can be customized on the <a href="!url">Menu block settings page</a>.', array(
      '!url' => url('admin/settings/menu_block'),
    )) . '</div>';
  }

  // Add classes for jQuery script.
  $form['menu-block-wrapper-start']['#value'] = '<div id="menu-block-settings" class="menu-block-menu-tree-configure-form">';
  if (empty($form['override_title']['#attributes']['class'])) {
    $form['override_title']['#attributes']['class'] = 'menu-block-override-title';
  }
  else {
    $form['override_title']['#attributes']['class'] .= ' menu-block-override-title';
  }
}

/**
 * Submit callback for content type editing form.
 */
function menu_block_menu_tree_content_type_edit_form_submit(&$form, &$form_state) {
  foreach (array_keys($form_state['subtype']['defaults']) as $key) {
    if (!empty($form_state['values'][$key])) {
      $form_state['conf'][$key] = $form_state['values'][$key];
    }
  }
}

/**
 * Return the tree's title with an admin-sensitive prefix.
 */
function menu_block_menu_tree_content_type_admin_title($subtype, $conf, $context = NULL) {
  if (!empty($conf['admin_title'])) {
    $output = filter_xss_admin($conf['admin_title']);
  }
  else {

    // Build the menu tree.
    module_load_include('inc', 'menu_block', 'menu_block.admin');
    $output = _menu_block_format_title($conf);
  }
  return $output;
}

/**
 * Callback to provide administrative info (the preview in panels when building a panel).
 */
function menu_block_menu_tree_content_type_admin_info($subtype, $conf, $context = NULL) {

  // Ensure the delta is unique.
  static $ids = array();
  if (empty($ids[$conf['menu_name']])) {
    $ids[$conf['menu_name']] = 0;
  }
  $delta = ++$ids[$conf['menu_name']];
  $conf['delta'] = 'ctools-' . $conf['menu_name'] . '-' . $delta;

  // Force the title to not be a link.
  $conf['title_link'] = 0;
  $tree = menu_tree_build($conf);
  $block = new stdClass();
  $block->subtype = $conf['menu_name'];
  $block->title = $tree['subject'];
  $block->content = $tree['content'];
  return $block;
}

Functions

Name	Description
menu_block_menu_tree_content_type_admin_info	Callback to provide administrative info (the preview in panels when building a panel).
menu_block_menu_tree_content_type_admin_title	Return the tree's title with an admin-sensitive prefix.
menu_block_menu_tree_content_type_content_types	Supplies a list of menu tree content sub-types.
menu_block_menu_tree_content_type_edit_form	'Edit form' callback for the content type.
menu_block_menu_tree_content_type_edit_form_submit	Submit callback for content type editing form.
menu_block_menu_tree_content_type_render	Renders a menu_tree content type based on the delta supplied in the configuration.