/[drupal]/contributions/modules/taxonomy_breadcrumb/taxonomy_breadcrumb.module

Diff of /contributions/modules/taxonomy_breadcrumb/taxonomy_breadcrumb.module

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.5.2.9,
Thu Mar 15 23:37:31 2007 UTC
+revision 1.5.2.10,
Thu Mar 12 19:16:56 2009 UTC
 Line 1
  <?php
- // $Id: taxonomy_breadcrumb.module,v 1.5.2.8 2007/02/25 01:33:10 craig Exp $.
+ // $Id: taxonomy_breadcrumb.module,v 1.5.2.9 2007/03/15 23:37:31 craig Exp $.
  /**
   * @file
   * The taxonomy_breadcrumb module generates taxonomy based breadcrumbs on node
   * pages and taxonomy/term pages.  The breadcrumb trail takes on the form:
   *   [HOME] >> [VOCABULARY] >> TERM >> [TERM] ...
   *
   *   - The HOME breadcrumb (if present) links to the homepage.  The text
   *     displayed for HOME is administrator configurable.  If the HOME
   *     breadcrumb is not defined by the administrator, it will not appear
   *     in the breadcrumb trail.
   *   - The VOCABULARY breadcrumb (if present) will link to an administrator
   *     defined page.  If the VOCABULARY does not have an administrator
   *     defined page, it will not appear in the breadcrumb trail.
   *   - Each TERM breadcrumb will link to either
   *     (1) taxonomy/term/tid by default, or
   *     (2) an administrator defined page if one is defined for the term.
   *   - These administrator defined "breadcrumb links" for VOCABULARIES and TERMS
   *     are controlled from the add/edit vocabulary and add/edit term
 Line 35
   *     taxonomy_get_parents_all.
   */
  // default value for Advanced Settings, Node Types
  define('TAXONOMY_BREADCRUMB_NODE_TYPES_DEFAULT', 'book');
  /**
   * Return lightest term for given node ($nid).
   * Similar to taxonomy_node_get_terms, but only return the lightest term in the
   * lightest vocab for the node.
   */
  function taxonomy_breadcrumb_node_get_lightest_term($nid) {
    // We only want the first row of the result--this is the lightest term of the
    // lightest vocab.  This query should be the same as the query found in
    // taxonomy_node_get_terms.
    $result = db_query(db_rewrite_sql('SELECT t.* FROM {term_node} r INNER JOIN {term_data} t ON r.tid = t.tid INNER JOIN {vocabulary} v ON t.vid = v.vid WHERE r.nid = %d ORDER BY v.weight, t.weight, t.name', 't', 'tid'), $nid);
    $term = db_fetch_object($result);  // extract first row of query
    return $term;
  }
  /**
   * Return the administrator defined vocabulary path for a given vocabulary
   * ($vid).  If a path doesn't exist, NULL is returned.
   */
  function taxonomy_breadcrumb_get_vocabulary_path($vid) {
-Line 66 
 function taxonomy_breadcrumb_get_vocabul
+Line 63 
 function taxonomy_breadcrumb_get_vocabul
      $path = $row['path'];
    }
    return $path;
  }
  /**
   * Return the administrator defined term path for a given term ($tid).
-Line 79 
 function taxonomy_breadcrumb_get_term_pa
+Line 75 
 function taxonomy_breadcrumb_get_term_pa
    if ($row = db_fetch_array($result)) {
      $path = $row['path'];
    }
    return $path;
  }
  /**
   * If the current drupal path (q=) is /node/nid, generate the breadcrumb trail
-Line 90 
 function taxonomy_breadcrumb_get_term_pa
+Line 85 
 function taxonomy_breadcrumb_get_term_pa
  function taxonomy_breadcrumb_generate_breadcrumb($tid, $is_term_page = FALSE) {
    $term = taxonomy_get_term($tid);
    // HOME breadcrumb generation
    $home_text = variable_get('taxonomy_breadcrumb_home', '');
    if ($home_text != '') {
-Line 101 
 function taxonomy_breadcrumb_generate_br
+Line 96 
 function taxonomy_breadcrumb_generate_br
    $vocabulary_path = taxonomy_breadcrumb_get_vocabulary_path($term->vid);
    if ($vocabulary_path != NULL) {
      $vocabulary = taxonomy_get_vocabulary($term->vid);
      $breadcrumb[] = l($vocabulary->name, $vocabulary_path);
    }
    // TERM breadcrumb generation
-Line 122 
 function taxonomy_breadcrumb_generate_br
+Line 117 
 function taxonomy_breadcrumb_generate_br
    // Remove current TERM from end of breadcrumb trail
    if (!variable_get('taxonomy_breadcrumb_show_current_term', TRUE) && !is_null($breadcrumb)) {
-       array_pop($breadcrumb);
+     array_pop($breadcrumb);
    }
    return $breadcrumb;
  }
  /**
   * Implementation of hook_menu().
   */
-Line 145 
 function taxonomy_breadcrumb_menu($may_c
+Line 138 
 function taxonomy_breadcrumb_menu($may_c
        'access' => user_access('administer site configuration'),
        'type' => MENU_NORMAL_ITEM, // optional
      );
      // Similiar to core menu item in taxonomy_menu, except callback is different
      $items[] = array('path' => 'taxonomy/term',
        'title' => t('Taxonomy term'),
        'callback' => 'taxonomy_breadcrumb_term_page',
        'access' => user_access('access content'),
-       'type' => MENU_CALLBACK);
+       'type' => MENU_CALLBACK,
+     );
    }
    return $items;
  }
-Line 173 
 function taxonomy_breadcrumb_admin_setti
+Line 165 
 function taxonomy_breadcrumb_admin_setti
      '#title' => t('Home breadcrumb text'),
      '#default_value' => variable_get('taxonomy_breadcrumb_home', ''),
      '#description' => t('Text to display at top of breadcrumb trail.  Typically home or your site name.  Leave blank to have no home breadcrumb.'),
    );
    $form['settings']['taxonomy_breadcrumb_show_current_term'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show current term in breadcrumb trail?'),
      '#default_value' => variable_get('taxonomy_breadcrumb_show_current_term', TRUE),
      '#description' => t('When enabled, the lightest term associated with node is shown as the last breadcrumb in the breadcrumb trail.  When disabled, the only terms shown in the breadcrumb trail are parent terms (if any parents exist).  The recommended setting is enabled.'),
    );
    $form['advanced'] = array(
      '#type' => 'fieldset',
-Line 197 
 function taxonomy_breadcrumb_admin_setti
+Line 189 
 function taxonomy_breadcrumb_admin_setti
      '#options' => array(TRUE => t('Include'), FALSE => t('Exclude')),
      '#weight' => 10,
    );
-   // Get all of the node types enabled.
+   $tb_types = (array) variable_get('taxonomy_breadcrumb_node_types', TAXONOMY_BREADCRUMB_NODE_TYPES_DEFAULT);
-   $node_bases = array();
+   $default = array();
-   $node_types = node_get_types();
+   foreach ($tb_types as $index => $value) {
-   foreach ($node_types as $node_type) {
+     if ($value) {
-     $node_bases[] = $node_type->type;
+       $default[] = $index;
+     }
    }
    $form['advanced']['taxonomy_breadcrumb_node_types'] = array(
-     '#type' => 'textfield',
+     '#type'           => 'checkboxes',
-     '#title' => t('Node types to include or exclude'),
+     '#multiple'       => TRUE,
-     '#default_value' => variable_get('taxonomy_breadcrumb_node_types', TAXONOMY_BREADCRUMB_NODE_TYPES_DEFAULT),
+     '#title'          => t('Node types to include or exclude'),
-     '#description' => t('Enter a list of node types to include or exclude applying taxonomy based breadcrumbs to.  Separate multiple values with spaces. <p>Node types currently enabled:') . '<ul><li>' . implode($node_bases, '</li><li>') . '</li></ul></p>',
+     '#default_value'  => $default,
-     '#weight' => 20,
+     '#options'        => array_map('check_plain', node_get_types('names')),
-   );
+     '#description'    => t('A list of node types to include or exclude applying taxonomy based breadcrumbs to.'),
+     '#weight'         => 20,
+   );
    return system_settings_form($form);
  }
-Line 222 
 function taxonomy_breadcrumb_admin_setti
+Line 217 
 function taxonomy_breadcrumb_admin_setti
  function taxonomy_breadcrumb_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
    // If we are on a page view (not just a teaser), set the breadcrumb
    // $a4 contains TRUE if we are on a page view
-   if ($op == 'view' && $a4 && !drupal_is_front_page()) {
+   if ($op == 'view' && $a4 && !drupal_is_front_page() && arg(1) == $node->nid ) {
      // See if the node type of the current node is part of the node types listed on the advanced settings page.
-     $array_of_types = explode(' ', variable_get('taxonomy_breadcrumb_node_types', TAXONOMY_BREADCRUMB_NODE_TYPES_DEFAULT));
+     $array_of_types = array_filter((array)variable_get('taxonomy_breadcrumb_node_types', TAXONOMY_BREADCRUMB_NODE_TYPES_DEFAULT));
      $in_list = in_array($node->type, $array_of_types);
      // if the node type IS IN     the node types list and the list IS     inclusive OR
      // if the node type IS NOT IN the node types list and the list IS NOT inclusive (e.g. exclusive)
      // THEN modify the breadcrumb trail.
      if ($in_list == variable_get('taxonomy_breadcrumb_include_nodes', FALSE) ) {
-       // Extract lightest term from lightest vocabulary assosciated with node.
+       // Extract lightest term from lightest vocabulary associated with node.
        $term = taxonomy_breadcrumb_node_get_lightest_term($node->nid);
        $breadcrumb = taxonomy_breadcrumb_generate_breadcrumb($term->tid);
        drupal_set_breadcrumb($breadcrumb);
-Line 241 
 function taxonomy_breadcrumb_nodeapi(&$n
+Line 236 
 function taxonomy_breadcrumb_nodeapi(&$n
    }
  }
  /**
   * This function overrides the core taxonomy_term_page.  First, call the core
   * taxonomy_term_page.  Then, alter the breadcrumb trail.  This module's
-Line 259 
 function taxonomy_breadcrumb_term_page($
+Line 253 
 function taxonomy_breadcrumb_term_page($
    $breadcrumb = taxonomy_breadcrumb_generate_breadcrumb($terms['tids'][0], TRUE);
    drupal_set_breadcrumb($breadcrumb);
    return $output;
- }
+ }
  /**
   * Implementation of hook_help().
   */
  function taxonomy_breadcrumb_help($section) {
    switch ($section) {
      case 'admin/help#taxonomy_breadcrumb':
        $output .= t('<p>See %link.</p>', array('%link' => l('admin/settings/taxonomy-breadcrumb', 'admin/settings/taxonomy-breadcrumb')));
-Line 293 
 function taxonomy_breadcrumb_help($secti
+Line 286 
 function taxonomy_breadcrumb_help($secti
    return $output;
  }
  /**
   * Implementation of hook_form_alter().  This must be used over hook_taxonomy to
   * add the Breadcrumb Path fields to the vocabulary and term forms.  The
   * hook_taxonomy function does not provide a way to obtain the vid or tid
   * of the vocabulary or term.
   */
-Line 306 
 function taxonomy_breadcrumb_form_alter(
+Line 298 
 function taxonomy_breadcrumb_form_alter(
      $form['taxonomy_breadcrumb_path'] = array(
        '#type' => 'textfield',
        '#title' => t('Breadcrumb path (taxonomy_breadcrumb)'),
        '#default_value' => taxonomy_breadcrumb_get_vocabulary_path($form['vid']['#value']),
        '#maxlength' => 128,
        '#description' => t('Specify the path this vocabulary links to as a breadcrumb.  If blank, the breadcrumb will not appear.  Use a relative path and don\'t add a trailing slash.  For example: node/42 or my/path/alias.'),
        '#weight' => 0,
-Line 316 
 function taxonomy_breadcrumb_form_alter(
+Line 308 
 function taxonomy_breadcrumb_form_alter(
      $form['taxonomy_breadcrumb_path'] = array(
        '#type' => 'textfield',
        '#title' => t('Breadcrumb path (taxonomy_breadcrumb)'),
        '#default_value' => taxonomy_breadcrumb_get_term_path($form['tid']['#value']),
        '#maxlength' => 128,
        '#description' => t('Specify the path this term links to as a breadcrumb.  If blank, the breadcrumb links to the default taxonomy page.  Use a relative path and don\'t add a trailing slash.  For example: node/42 or my/path/alias.'),
        '#weight' => 0,
      );
    }
  }
  /**
   * Implementation of hook_taxonomy().  This implementation checks to see if a
-Line 337 
 function taxonomy_breadcrumb_taxonomy($o
+Line 327 
 function taxonomy_breadcrumb_taxonomy($o
    // called by module_invoke_all('taxonomy', 'update', 'term', $edit);  in taxonomy.module
    if ( $op == 'update' && ($type == 'vocabulary' || $type == 'term') ) {
      // Set variables to used in SQL query to reflect if vocabulary or term is
      // being updated.
      if ($type == 'vocabulary') {
        $table = '{taxonomy_breadcrumb_vocabulary}';
-Line 351 
 function taxonomy_breadcrumb_taxonomy($o
+Line 341 
 function taxonomy_breadcrumb_taxonomy($o
      }
      $key = $object[$key_type];
      $new_path = $object['taxonomy_breadcrumb_path'];
      // Delete record from taxonomy_breadcrumb_vocabulary or taxonomy_breadcrumb_term
      if (strlen($new_path) == 0 && $old_path !== NULL) {
        db_query("DELETE FROM $table WHERE $key_type = %d", $key);
      }
      // Update existing record in taxonomy_breadcrumb_vocabulary or taxonomy_breadcrumb_term
      elseif (strlen($new_path) != 0 && $old_path != NULL) {
        db_query("UPDATE $table SET path = '%s' WHERE $key_type = %d", $new_path, $key );
      }
      // Create new record in taxonomy_breadcrumb_vocabulary or taxonomy_breadcrumb_term
      elseif (strlen($new_path) != 0 && $old_path == NULL) {
        db_query("INSERT INTO $table ($key_type, path) VALUES (%d, '%s')", $key, $new_path);
      }
    }
  }

 Legend:



Removed from v.1.5.2.9
 


changed lines


 
Added in v.1.5.2.10
 Legend:



Removed from v.1.5.2.9
 


changed lines


 
Added in v.1.5.2.10
-Removed from v.1.5.2.9
+Added in v.1.5.2.10

	ViewVC Help
Powered by ViewVC 1.1.2