function taxonomy_edge_get_tree_generic in Taxonomy Edge 7

Same name and namespace in other branches

1. 8 taxonomy_edge.core.inc \taxonomy_edge_get_tree_generic()
2. 6 taxonomy_edge.core.inc \taxonomy_edge_get_tree_generic()
3. 7.2 taxonomy_edge.core.inc \taxonomy_edge_get_tree_generic()

Reimplementation of taxonomy_get_tree().

Limit db fetch to only specified parent.

See also

taxonomy_get_tree()

3 calls to taxonomy_edge_get_tree_generic()

TaxonomyEdgeTreeTestCase::formatTree in tests/tree.test

taxonomy_edge_get_tree in ./taxonomy_edge.module

Reimplementation of taxonomy_get_tree().

taxonomy_edge_get_tree_optimized in ./taxonomy_edge.core.inc

Reimplementation of taxonomy_get_tree().

File

./taxonomy_edge.core.inc, line 13

This file contains the core override functions

Code

function taxonomy_edge_get_tree_generic($vid, $parent = 0, $max_depth = NULL, $load_entities = FALSE) {
  $exclude_root = variable_get('taxonomy_edge_exclude_root', TRUE);
  $static_cache = variable_get('taxonomy_edge_static_caching', TAXONOMY_EDGE_STATIC_CACHING);

  // @todo Optimize this. Currently we cannot use the static cache when using
  //       parent, because it's expected that the entire vocabulary is present
  //       in the static cache.
  $static_cache = $static_cache && !$parent;
  if ($static_cache) {
    $children =& drupal_static('taxonomy_get_tree', array());
    $parents =& drupal_static('taxonomy_get_tree:parents', array());
    $terms =& drupal_static('taxonomy_get_tree:terms', array());
  }
  else {
    $children = $parents = $terms = array();
  }

  // We cache trees, so it's not CPU-intensive to call get_tree() on a term
  // and its children, too.
  if (!isset($children[$vid])) {
    $children[$vid] = array();
    $parents[$vid] = array();
    $terms[$vid] = array();
    $query = db_select('taxonomy_term_data', 't');
    $query
      ->join('taxonomy_term_hierarchy', 'h', 'h.tid = t.tid');
    $query
      ->addTag('translatable')
      ->addTag('term_access')
      ->fields('t')
      ->fields('h', array(
      'parent',
    ))
      ->condition('t.vid', $vid)
      ->orderBy('t.weight')
      ->orderBy('t.name');
    if ($exclude_root && $parent) {
      $subquery = db_select('taxonomy_term_edge', 'e')
        ->fields('e', array(
        'tid',
      ))
        ->condition('e.vid', $vid)
        ->condition('e.parent', $parent)
        ->condition('e.distance', 0, '>');
      $query
        ->condition('t.tid', $subquery, 'IN');
    }
    $result = $query
      ->execute();
    foreach ($result as $term) {
      $children[$vid][$term->parent][] = $term->tid;
      $parents[$vid][$term->tid][] = $term->parent;
      $terms[$vid][$term->tid] = $term;
    }
  }

  // Load full entities, if necessary. The entity controller statically
  // caches the results.
  if ($load_entities) {
    $term_entities = taxonomy_term_load_multiple(array_keys($terms[$vid]));
  }
  $max_depth = !isset($max_depth) ? count($children[$vid]) : $max_depth;
  $tree = array();

  // Keeps track of the parents we have to process, the last entry is used
  // for the next processing step.
  $process_parents = array();
  $process_parents[] = $parent;

  // Loops over the parent terms and adds its children to the tree array.
  // Uses a loop instead of a recursion, because it's more efficient.
  while (count($process_parents)) {
    $parent = array_pop($process_parents);

    // The number of parents determines the current depth.
    $depth = count($process_parents);
    if ($max_depth > $depth && !empty($children[$vid][$parent])) {
      $has_children = FALSE;
      $child = current($children[$vid][$parent]);
      do {
        if (empty($child)) {
          break;
        }
        $term = $load_entities ? $term_entities[$child] : $terms[$vid][$child];
        if (isset($parents[$vid][$term->tid])) {

          // Clone the term so that the depth attribute remains correct
          // in the event of multiple parents.
          $term = clone $term;
        }
        $term->depth = $depth;
        unset($term->parent);
        $term->parents = $parents[$vid][$term->tid];
        $tree[] = $term;
        if (!empty($children[$vid][$term->tid])) {
          $has_children = TRUE;

          // We have to continue with this parent later.
          $process_parents[] = $parent;

          // Use the current term as parent for the next iteration.
          $process_parents[] = $term->tid;

          // Reset pointers for child lists because we step in there more often
          // with multi parents.
          reset($children[$vid][$term->tid]);

          // Move pointer so that we get the correct term the next time.
          next($children[$vid][$parent]);
          break;
        }
      } while ($child = next($children[$vid][$parent]));
      if (!$has_children) {

        // We processed all terms in this hierarchy-level, reset pointer
        // so that this function works the next time it gets called.
        reset($children[$vid][$parent]);
      }
    }
  }
  return $tree;
}