nodehierarchy_token.inc in Node Hierarchy 6.3

token.module integration functions for nodehierarchy.module

File

includes/nodehierarchy_token.inc

<?php

/**
 * @file
 * token.module integration functions for nodehierarchy.module
 */

/**
 * Implementation of hook_token_values().
 */
function nodehierarchy_token_values($type, $object = NULL, $options = array()) {
  $tokens = array();
  if ($type == 'node') {
    $node = $object;
    $parents = nodehierarchy_get_node_parent_nids($node->nid);
    if ($parent = node_load(@$parents[0])) {
      $tokens['hierarchyparenttitle'] = check_plain(@$parent->title);
      $tokens['hierarchyparenttitle-raw'] = @$parent->title;
      $tokens['hierarchyparentnid'] = $parent->nid;
    }
    else {
      $tokens['hierarchyparenttitle'] = '';
      $tokens['hierarchyparenttitle-raw'] = '';
      $tokens['hierarchyparentnid'] = '';
    }
    $tokens['hierarchytitlepath'] = nodehierarchy_token_get_hierarchytitlepath($node->nid);
    $tokens['fullhierarchytitlepath'] = nodehierarchy_token_get_fullhierarchytitlepath($node);
    $tokens['hierarchytitlepath-raw'] = nodehierarchy_token_get_hierarchytitlepath($node->nid, TRUE);
    $tokens['fullhierarchytitlepath-raw'] = nodehierarchy_token_get_fullhierarchytitlepath($node, TRUE);
    $tokens['hierarchypath'] = nodehierarchy_token_get_hierarchypath($node->nid);
    $tokens['fullhierarchypath'] = nodehierarchy_token_get_fullhierarchypath($node);

    // As of Pathauto 1.5+ or 2.0-alpha3+ in combination with Token 6.15,
    // Path and URL tokens are left alone by Pathauto except for tokens with 'path'
    // in the name and who's corresponding value is an array of segments.
    // This usage can be checked for by the existence $options['pathauto']
    // See also 'Using path style tokens' at http://drupal.org/node/936068
    if (!empty($options['pathauto'])) {
      $tokens['hierarchytitlepath'] = explode("/", $tokens['hierarchytitlepath']);
      $tokens['fullhierarchytitlepath'] = explode("/", $tokens['fullhierarchytitlepath']);
      $tokens['hierarchytitlepath-raw'] = explode("/", $tokens['hierarchytitlepath-raw']);
      $tokens['fullhierarchytitlepath-raw'] = explode("/", $tokens['fullhierarchytitlepath-raw']);
      $tokens['hierarchypath'] = explode("/", $tokens['hierarchypath']);
      $tokens['fullhierarchypath'] = explode("/", $tokens['fullhierarchypath']);
    }
  }
  return $tokens;
}

/**
 * Implementation of hook_token_list().
 */
function nodehierarchy_token_list($type = 'all') {
  if ($type == 'node' || $type == 'all') {
    $tokens['node']['fullhierarchypath'] = t('The URL of the parent of the given node with the node title itself. Equivalent of [hierarchypath]/[title]. This is the recommended token for hierarchical URLs.');
    $tokens['node']['hierarchypath'] = t('The URL of the parent of the given node. Like [fullhierarchypath] but without the node title.');
    $tokens['node']['hierarchyparenttitle'] = t("The node's parent's title.");
    $tokens['node']['hierarchyparenttitle-raw'] = t("The node's parent's title. WARNING - raw user input.");
    $tokens['node']['hierarchyparentnid'] = t("The node's parent's nid.");
    $tokens['node']['hierarchytitlepath'] = t("The node's ancestors' titles in order. Separated by /.");
    $tokens['node']['hierarchytitlepath-raw'] = t("The node's ancestors' titles in order. Separated by /. WARNING - raw user input.");
    $tokens['node']['fullhierarchytitlepath'] = t("The node's ancestors' titles in order, plus the title of the node itself. Separated by /. Equivalent of [hierarchytitlepath]/[title].");
    $tokens['node']['fullhierarchytitlepath-raw'] = t("The node's ancestors' titles in order, plus the title of the node itself. Separated by /. Equivalent of [hierarchytitlepath]/[title]. WARNING - raw user input.");
    return $tokens;
  }
}
function nodehierarchy_token_get_fullhierarchytitlepath($node, $raw = TRUE) {
  $title = $raw ? $node->title : check_plain($node->title);

  // return the hierarchy path with the converted title
  return trim(nodehierarchy_token_get_hierarchytitlepath($node->nid, $raw) . "/" . $title, "/");
}
function nodehierarchy_token_get_hierarchytitlepath($nid, $raw = TRUE) {

  // the hierarchy path is the parent node's full hierarchy path
  $parents = nodehierarchy_get_node_parent_nids($nid);
  if ($pnid = @$parents[0]) {
    return nodehierarchy_token_get_fullhierarchytitlepath(node_load($pnid));
  }
  return "";
}
function nodehierarchy_token_get_fullhierarchypath($node) {

  // pathauto used to strip spaces but, as of 1.4 we need to run through pathauto_cleanstring
  // per http://drupal.org/node/881270. Also works in pathauto < 1.4
  if (module_exists('pathauto')) {
    module_load_include('inc', 'pathauto', 'pathauto');
    if (function_exists('pathauto_cleanstring')) {
      return trim(nodehierarchy_token_get_hierarchypath($node->nid) . "/" . pathauto_cleanstring($node->title), "/");
    }
  }
  return trim(nodehierarchy_token_get_hierarchypath($node->nid) . "/" . $node->title, "/");
}
function nodehierarchy_token_get_hierarchypath($nid) {

  // the hierarchy path is the parent node's full hierarchy path
  $parents = nodehierarchy_get_node_parent_nids($nid);
  if ($pnid = @$parents[0]) {

    // if the parent already has an alias (generated or entered) use that
    $parent_path = drupal_get_path_alias("node/{$pnid}");
    if ($parent_path != "node/{$pnid}") {
      return $parent_path;
    }
    else {

      // recurse
      $parent_node = node_load($pnid);
      return nodehierarchy_token_get_fullhierarchypath($parent_node);
    }
  }
  return "";
}

Functions

Name	Description
nodehierarchy_token_get_fullhierarchypath
nodehierarchy_token_get_fullhierarchytitlepath
nodehierarchy_token_get_hierarchypath
nodehierarchy_token_get_hierarchytitlepath
nodehierarchy_token_list	Implementation of hook_token_list().
nodehierarchy_token_values	Implementation of hook_token_values().