danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Builds placeholder replacement tokens for taxonomy terms and vocabularies.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_token_info().
danielebarchiesi@0:  */
danielebarchiesi@0: function taxonomy_token_info() {
danielebarchiesi@0:   $types['term'] = array(
danielebarchiesi@0:     'name' => t("Taxonomy terms"),
danielebarchiesi@0:     'description' => t("Tokens related to taxonomy terms."),
danielebarchiesi@0:     'needs-data' => 'term',
danielebarchiesi@0:   );
danielebarchiesi@0:   $types['vocabulary'] = array(
danielebarchiesi@0:     'name' => t("Vocabularies"),
danielebarchiesi@0:     'description' => t("Tokens related to taxonomy vocabularies."),
danielebarchiesi@0:     'needs-data' => 'vocabulary',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Taxonomy term related variables.
danielebarchiesi@0:   $term['tid'] = array(
danielebarchiesi@0:     'name' => t("Term ID"),
danielebarchiesi@0:     'description' => t("The unique ID of the taxonomy term."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $term['name'] = array(
danielebarchiesi@0:     'name' => t("Name"),
danielebarchiesi@0:     'description' => t("The name of the taxonomy term."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $term['description'] = array(
danielebarchiesi@0:     'name' => t("Description"),
danielebarchiesi@0:     'description' => t("The optional description of the taxonomy term."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $term['node-count'] = array(
danielebarchiesi@0:     'name' => t("Node count"),
danielebarchiesi@0:     'description' => t("The number of nodes tagged with the taxonomy term."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $term['url'] = array(
danielebarchiesi@0:     'name' => t("URL"),
danielebarchiesi@0:     'description' => t("The URL of the taxonomy term."),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Taxonomy vocabulary related variables.
danielebarchiesi@0:   $vocabulary['vid'] = array(
danielebarchiesi@0:     'name' => t("Vocabulary ID"),
danielebarchiesi@0:     'description' => t("The unique ID of the taxonomy vocabulary."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $vocabulary['name'] = array(
danielebarchiesi@0:     'name' => t("Name"),
danielebarchiesi@0:     'description' => t("The name of the taxonomy vocabulary."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $vocabulary['description'] = array(
danielebarchiesi@0:     'name' => t("Description"),
danielebarchiesi@0:     'description' => t("The optional description of the taxonomy vocabulary."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $vocabulary['node-count'] = array(
danielebarchiesi@0:     'name' => t("Node count"),
danielebarchiesi@0:     'description' => t("The number of nodes tagged with terms belonging to the taxonomy vocabulary."),
danielebarchiesi@0:   );
danielebarchiesi@0:   $vocabulary['term-count'] = array(
danielebarchiesi@0:     'name' => t("Term count"),
danielebarchiesi@0:     'description' => t("The number of terms belonging to the taxonomy vocabulary."),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Chained tokens for taxonomies
danielebarchiesi@0:   $term['vocabulary'] = array(
danielebarchiesi@0:     'name' => t("Vocabulary"),
danielebarchiesi@0:     'description' => t("The vocabulary the taxonomy term belongs to."),
danielebarchiesi@0:     'type' => 'vocabulary',
danielebarchiesi@0:   );
danielebarchiesi@0:   $term['parent'] = array(
danielebarchiesi@0:     'name' => t("Parent term"),
danielebarchiesi@0:     'description' => t("The parent term of the taxonomy term, if one exists."),
danielebarchiesi@0:     'type' => 'term',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'types' => $types,
danielebarchiesi@0:     'tokens' => array(
danielebarchiesi@0:       'term' => $term,
danielebarchiesi@0:       'vocabulary' => $vocabulary,
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_tokens().
danielebarchiesi@0:  */
danielebarchiesi@0: function taxonomy_tokens($type, $tokens, array $data = array(), array $options = array()) {
danielebarchiesi@0:   $replacements = array();
danielebarchiesi@0:   $sanitize = !empty($options['sanitize']);
danielebarchiesi@0: 
danielebarchiesi@0:   if ($type == 'term' && !empty($data['term'])) {
danielebarchiesi@0:     $term = $data['term'];
danielebarchiesi@0: 
danielebarchiesi@0:     foreach ($tokens as $name => $original) {
danielebarchiesi@0:       switch ($name) {
danielebarchiesi@0:         case 'tid':
danielebarchiesi@0:           $replacements[$original] = $term->tid;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'name':
danielebarchiesi@0:           $replacements[$original] = $sanitize ? check_plain($term->name) : $term->name;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'description':
danielebarchiesi@0:           $replacements[$original] = $sanitize ? check_markup($term->description, $term->format, '', TRUE) : $term->description;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'url':
danielebarchiesi@0:           $uri = entity_uri('taxonomy_term', $term);
danielebarchiesi@0:           $replacements[$original] = url($uri['path'], array_merge($uri['options'], array('absolute' => TRUE)));
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'node-count':
danielebarchiesi@0:           $query = db_select('taxonomy_index');
danielebarchiesi@0:           $query->condition('tid', $term->tid);
danielebarchiesi@0:           $query->addTag('term_node_count');
danielebarchiesi@0:           $count = $query->countQuery()->execute()->fetchField();
danielebarchiesi@0:           $replacements[$original] = $count;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'vocabulary':
danielebarchiesi@0:           $vocabulary = taxonomy_vocabulary_load($term->vid);
danielebarchiesi@0:           $replacements[$original] = check_plain($vocabulary->name);
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'parent':
danielebarchiesi@0:           if ($parents = taxonomy_get_parents($term->tid)) {
danielebarchiesi@0:             $parent = array_pop($parents);
danielebarchiesi@0:             $replacements[$original] = check_plain($parent->name);
danielebarchiesi@0:           }
danielebarchiesi@0:           break;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($vocabulary_tokens = token_find_with_prefix($tokens, 'vocabulary')) {
danielebarchiesi@0:       $vocabulary = taxonomy_vocabulary_load($term->vid);
danielebarchiesi@0:       $replacements += token_generate('vocabulary', $vocabulary_tokens, array('vocabulary' => $vocabulary), $options);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (($vocabulary_tokens = token_find_with_prefix($tokens, 'parent')) && $parents = taxonomy_get_parents($term->tid)) {
danielebarchiesi@0:       $parent = array_pop($parents);
danielebarchiesi@0:       $replacements += token_generate('term', $vocabulary_tokens, array('term' => $parent), $options);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   elseif ($type == 'vocabulary' && !empty($data['vocabulary'])) {
danielebarchiesi@0:     $vocabulary = $data['vocabulary'];
danielebarchiesi@0: 
danielebarchiesi@0:     foreach ($tokens as $name => $original) {
danielebarchiesi@0:       switch ($name) {
danielebarchiesi@0:         case 'vid':
danielebarchiesi@0:           $replacements[$original] = $vocabulary->vid;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'name':
danielebarchiesi@0:           $replacements[$original] = $sanitize ? check_plain($vocabulary->name) : $vocabulary->name;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'description':
danielebarchiesi@0:           $replacements[$original] = $sanitize ? filter_xss($vocabulary->description) : $vocabulary->description;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'term-count':
danielebarchiesi@0:           $query = db_select('taxonomy_term_data');
danielebarchiesi@0:           $query->condition('vid', $vocabulary->vid);
danielebarchiesi@0:           $query->addTag('vocabulary_term_count');
danielebarchiesi@0:           $count = $query->countQuery()->execute()->fetchField();
danielebarchiesi@0:           $replacements[$original] = $count;
danielebarchiesi@0:           break;
danielebarchiesi@0: 
danielebarchiesi@0:         case 'node-count':
danielebarchiesi@0:           $query = db_select('taxonomy_index', 'ti');
danielebarchiesi@0:           $query->addExpression('COUNT(DISTINCT ti.nid)');
danielebarchiesi@0:           $query->leftJoin('taxonomy_term_data', 'td', 'ti.tid = td.tid');
danielebarchiesi@0:           $query->condition('td.vid', $vocabulary->vid);
danielebarchiesi@0:           $query->addTag('vocabulary_node_count');
danielebarchiesi@0:           $count = $query->execute()->fetchField();
danielebarchiesi@0:           $replacements[$original] = $count;
danielebarchiesi@0:           break;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $replacements;
danielebarchiesi@0: }