taxonomy_menu.inc in Taxonomy menu 5

taxonomy_menu.inc @author Jonathan Chaffer <[e-mail]> @author Bruno Massa <http://drupal.org/user/67164> It Generates menu links for all taxonomy terms

File

taxonomy_menu.inc

<?php

/**
 * @file taxonomy_menu.inc
 * @author Jonathan Chaffer   <[e-mail]>
 * @author Bruno Massa        <http://drupal.org/user/67164>
 * It Generates menu links for all taxonomy terms
 */

/**
 * Admin area. Configure the module, setting which
 * vocabularies will be converted into menus items
 *
 * @return
 *   Array. The form fields.
 */
function _taxonomy_menu_admin() {
  $options = array(
    TAXONOMY_MENU_NONE => t('No'),
    TAXONOMY_MENU_NORMAL => t('Normal'),
  );

  // If the Views module is enabled, add some special
  // new features
  if (module_exists('views')) {

    // Add the Views file with more functions
    require_once drupal_get_path('module', 'views') . '/views_cache.inc';

    // Add a new options on Categories
    $options[TAXONOMY_MENU_VIEW] = t('Views');

    // Get the list of User generated views
    $views = db_query("SELECT * FROM {view_view}");
    while ($view = db_fetch_array($views)) {
      $views_list[$view['name']] = $view['page_title'];
    }

    // Now get a list of default Views
    foreach (_views_get_default_views() as $view => $viewdata) {
      $views_list[$view] = $viewdata->name;
    }
  }

  // Create some options for each of the vocabularies
  foreach (taxonomy_get_vocabularies() as $vocab) {
    $form[$vocab->vid] = array(
      '#title' => $vocab->name,
      '#tree' => FALSE,
      '#type' => 'fieldset',
    );
    $form[$vocab->vid]['taxonomy_menu_show_' . $vocab->vid] = array(
      '#default_value' => variable_get('taxonomy_menu_show_' . $vocab->vid, TAXONOMY_MENU_NONE),
      '#options' => $options,
      '#title' => t('Show this category in menu'),
      '#type' => 'radios',
    );

    // In case of View options selected, select Views
    if (module_exists('views')) {
      $form[$vocab->vid]['taxonomy_menu_show_view_' . $vocab->vid] = array(
        '#default_value' => variable_get('taxonomy_menu_show_views_' . $vocab->vid, ''),
        '#options' => $views_list,
        '#title' => t('Views available'),
        '#type' => 'select',
      );
    }
  }

  // General options
  $form['taxonomy_menu_display_page'] = array(
    '#default_value' => variable_get('taxonomy_menu_display_page', 'category'),
    '#description' => t('How should be the first item on the menu? Example: categories/1/2/3, technology/1/2/3'),
    '#title' => t('Module page'),
    '#type' => 'textfield',
  );
  $form['taxonomy_menu_hide_module_page'] = array(
    '#default_value' => variable_get('taxonomy_menu_hide_module_page', FALSE),
    '#description' => t('If checked, links to module page removes from all paths. path will be like "1/2/3" instead of "categories/1/2/3"'),
    '#title' => t('Hide link to module page'),
    '#type' => 'checkbox',
  );
  $form['taxonomy_menu_display_num'] = array(
    '#default_value' => variable_get('taxonomy_menu_display_num', FALSE),
    '#description' => t('If checked, number of node per term will be displayed in the menu.'),
    '#title' => t('Display number of nodes per terms'),
    '#type' => 'checkbox',
  );
  $form['taxonomy_menu_hide_empty'] = array(
    '#default_value' => variable_get('taxonomy_menu_hide_empty', FALSE),
    '#description' => t('If checked, only taxonomy terms with members will be shown in the menu.'),
    '#title' => t('Hide Empty Terms'),
    '#type' => 'checkbox',
  );
  $form['taxonomy_menu_display_descendants'] = array(
    '#default_value' => variable_get('taxonomy_menu_display_descendants', TRUE),
    '#description' => t('If checked, then when a term is selected all nodes belonging to subterms are also displayed.'),
    '#title' => t('Display descendants'),
    '#type' => 'checkbox',
  );
  $form['taxonomy_menu_display_context'] = array(
    '#default_value' => variable_get('taxonomy_menu_display_context', TRUE),
    '#description' => t('Display an active menu item for the first matching taxonomy term of the current node.'),
    '#title' => t('Display in context.'),
    '#type' => 'checkbox',
  );
  $form['submit'] = array(
    '#value' => t('Submit'),
    '#type' => 'submit',
  );
  return $form;
}

/**
 * Implementation of hook_menu().
 *
 * Its the main function for this module.
 */
function _taxonomy_menu_menu() {
  if (module_exists('pathauto')) {
    $pathauto_exists = true;
    _pathauto_include();
  }
  $items['admin/settings/taxonomy_menu'] = array(
    'access' => user_access('administer site configuration'),
    'callback' => 'drupal_get_form',
    'callback arguments' => array(
      '__taxonomy_menu_admin',
    ),
    'file' => 'taxonomy_menu.inc',
    'description' => t('Global configuration of taxonomy menu functionality.'),
    'path' => 'admin/settings/taxonomy_menu',
    'title' => t('Taxonomy Menu'),
    'type' => MENU_NORMAL_ITEM,
  );

  // This user access function will be used for
  // all menu items
  $access = user_access('access content');
  foreach (taxonomy_get_vocabularies() as $vocabulary) {
    if (variable_get('taxonomy_menu_show_' . $vocabulary->vid, TAXONOMY_MENU_NONE)) {

      //  $path =  variable_get('taxonomy_menu_display_page', 'category') .'/'. $vocabulary->vid;
      if (variable_get('taxonomy_menu_hide_module_page', FALSE)) {
        $path = $vocabulary->vid;
      }
      else {
        $path = variable_get('taxonomy_menu_display_page', 'category') . '/' . $vocabulary->vid;
      }
      $items[$path] = array(
        'access' => $access,
        'callback' => '__taxonomy_menu_page',
        'file' => 'taxonomy_menu.inc',
        'page callback' => '__taxonomy_menu_page',
        'path' => $path,
        'title' => t($vocabulary->name),
        'weight' => $vocabulary->weight,
      );
      if ($pathauto_exists) {
        $placeholders = pathauto_get_placeholders('taxonomy', $vocabulary);
        $alias = pathauto_create_alias('taxonomy_menu', 'update', $placeholders, $path, $vocabulary->vid);
      }
      $tree = taxonomy_get_tree($vocabulary->vid);
      $old_depth = -1;
      $old_path = $path;
      if ($pathauto_exists) {
        $placeholders = pathauto_get_placeholders('taxonomy', $term);
        $alias = pathauto_create_alias('taxonomy_menu', 'update', $placeholders, $path, $term->tid);
      }
      foreach ($tree as $term) {
        if ($term->depth <= $old_depth) {
          $slashes_to_remove = $old_depth - $term->depth + 1;
          for ($i = 0; $i < $slashes_to_remove; $i++) {
            $old_path = substr($old_path, 0, strrpos($old_path, '/'));
          }
        }
        $path = $old_path . '/' . $term->tid;
        $old_depth = $term->depth;
        $old_path = $path;

        // Calculate the numbers of children nodes
        $num = taxonomy_term_count_nodes($term->tid);

        // If the number of children nodes of this term is
        // zero and the Hide Empty Terms option is enabled,
        // dont create the menu item
        if (variable_get('taxonomy_menu_hide_empty', FALSE) == FALSE or $num != 0) {
          $name = t($term->name);
          if (variable_get('taxonomy_menu_display_num', FALSE) == TRUE) {
            $name .= ' (' . $num . ')';
          }
          $items[$path] = array(
            'access' => $access,
            'callback' => '__taxonomy_menu_page',
            'description' => t($term->description),
            'file' => 'taxonomy_menu.inc',
            'page callback' => '__taxonomy_menu_page',
            'path' => $path,
            'title' => $name,
            'weight' => $term->weight,
          );
        }
      }
    }
  }
  return $items;
}

/**
 * Generates the breadcumb for nodes that
 * have a category listed as a menu
 *
 * @param
 *   Object. The node object
 * @param
 *   Array. The list of all taxonomy vocabs and
 *   terms that this node have and are also
 *   menus
 */
function _taxonomy_menu_node_view(&$node, &$vocabs) {
  foreach ($vocabs as $vid => $vocab) {
    if (variable_get('taxonomy_menu_hide_module_page', FALSE)) {
      $path = $vid;
    }
    else {
      $path = variable_get('taxonomy_menu_display_page', 'category') . '/' . $vid;
    }
    $getvoc = taxonomy_get_vocabulary($vid);
    $breadcrumb_items = array(
      'path' => $path,
      'title' => t($getvoc->name),
    ) + _taxonomy_menu_get_term_breadcrumb_items($vocab[0], $path) + array(
      'path' => 'node/' . $node->nid,
      'title' => $node->title,
    );
    menu_set_location($breadcrumb_items);
    return;
  }
}

/**
 * Generates location items for specifyed term and parent terms
 *
 * @param
 *   Number. Term identificator.
 * @param
 *   Array. Base path for term (vocabulary path).
 */
function _taxonomy_menu_get_term_breadcrumb_items($tid, $path) {
  $tree = taxonomy_get_tree(taxonomy_get_term($tid)->vid);
  foreach ($tree as $term_node) {
    if ($term_node->tid == $tid) {
      $parent_items = array();
      if ($term_node->parents[0] != 0) {
        $parent_items = _taxonomy_menu_get_term_breadcrumb_items($term_node->parents[0], $path);
        $parent = end($parent_items);
        $path = $parent['path'];
      }
      array_push($parent_items, array(
        'path' => $path . '/' . $term_node->tid,
        'title' => t($term_node->name),
      ));
      return $parent_items;
    }
  }
}

/**
 * Page callback that renders a node listing for the selected term.
 */
function _taxonomy_menu_page() {

  // Check if the Vocabulary ID is set
  if (($vid = arg(0)) || ($vid = variable_get('taxonomy_menu_hide_module_page', FALSE) ? arg(0) : FALSE)) {

    // Depending on what Output technique is used,
    // show the nodes' list
    if (variable_get('taxonomy_menu_show_' . $vid, TAXONOMY_MENU_NORMAL) == TAXONOMY_MENU_NORMAL) {
      if ($tid = variable_get('taxonomy_menu_hide_module_page', FALSE) ? arg(1) : arg(2)) {
        $tid = explode('/', $_GET['q']);
        $tid = db_escape_string(array_pop($tid));
        $feed = url('taxonomy/term/' . $tid . '/' . (variable_get('taxonomy_menu_display_descendants', TRUE) ? 'all' : 0) . '/feed');
        drupal_add_feed($feed);
        $result = taxonomy_select_nodes(array(
          $tid,
        ), 'or', variable_get('taxonomy_menu_display_descendants', TRUE) ? 'all' : 0);
      }
      else {

        // If no arg(2), we're looking at just the vid. If
        // display_descendants is on, grab all terms regardless
        // of depth. If off, grab depth 0 terms.
        $tree = taxonomy_get_tree($vid);
        $descendants = variable_get('taxonomy_menu_display_descendants', 1);
        foreach ($tree as $term) {
          if ($descendants or $term->depth == 0) {
            $tids[] = $term->tid;
          }
        }

        // The requested terms have already been determined,
        // so don't request descendants here.
        $result = taxonomy_select_nodes($tids, 'or', 0);
      }

      // Render the selected nodes
      $output = taxonomy_render_nodes($result);
    }
    elseif (variable_get('taxonomy_menu_show_' . $vid, TAXONOMY_MENU_NORMAL) == TAXONOMY_MENU_VIEW) {

      // Get the last page argument
      $tid = explode('/', $_GET['q']);
      $tid = db_escape_string(array_pop($tid));
      $arguments[] = $vid;

      // Only add the Term ID if its not the Vocabulary ID
      if ($vid != $tid) {
        $arguments[] = $tid;
      }

      // Embed the views output into the page
      $view = views_get_view(variable_get('taxonomy_menu_show_views_' . $vid, ''));
      $view_empty_text = $view->page_empty;
      if ($view) {

        // set $view->url to current page
        $view->url = $_GET['q'];
        $output = views_build_view('embed', $view, $arguments, $view->use_pager, $view->nodes_per_page);
      }
      else {
        $output = '';
      }
    }
  }

  // If no content found, return a "error" message

  //return empty($output) ? t('No content for this category.') : $output;
  return empty($output) ? $view_empty_text ? $view_empty_text : t('No content for this category.') : $output;
}

Functions

Name	Description
_taxonomy_menu_admin	Admin area. Configure the module, setting which vocabularies will be converted into menus items
_taxonomy_menu_get_term_breadcrumb_items	Generates location items for specifyed term and parent terms
_taxonomy_menu_menu	Implementation of hook_menu().
_taxonomy_menu_node_view	Generates the breadcumb for nodes that have a category listed as a menu
_taxonomy_menu_page	Page callback that renders a node listing for the selected term.