public function TreeBuilder::buildTree in Token 8

Build a tree array of tokens used for themeing or information.

Parameters

string $token_type: The token type.

array $options: (optional) An associative array of additional options, with the following elements:

• 'flat' (defaults to FALSE): Set to true to generate a flat list of token information. Otherwise, child tokens will be inside the 'children' parameter of a token.
• 'restricted' (defaults to FALSE): Set to true to how restricted tokens.
• 'depth' (defaults to 4): Maximum number of token levels to recurse.

Return value

array The token information constructed in a tree or flat list form depending on $options['flat'].

Overrides TreeBuilderInterface::buildTree

1 call to TreeBuilder::buildTree()

TreeBuilder::buildRenderable in src/TreeBuilder.php

Build a render array with token tree built as per specified options.

File

src/TreeBuilder.php, line 122

Class

TreeBuilder

Namespace

Drupal\token

Code

public function buildTree($token_type, array $options = []) {
  $options += [
    'restricted' => FALSE,
    'depth' => 4,
    'data' => [],
    'values' => FALSE,
    'flat' => FALSE,
  ];

  // Do not allow past the maximum token information depth.
  $options['depth'] = min($options['depth'], static::MAX_DEPTH);

  // If $token_type is an entity, make sure we are using the actual token type.
  if ($entity_token_type = $this->entityMapper
    ->getTokenTypeForEntityType($token_type)) {
    $token_type = $entity_token_type;
  }
  $langcode = $this->languageManager
    ->getCurrentLanguage()
    ->getId();
  $tree_cid = "token_tree:{$token_type}:{$langcode}:{$options['depth']}";

  // If we do not have this base tree in the static cache, check the cache
  // otherwise generate and store it in the cache.
  if (!isset($this->builtTrees[$tree_cid])) {
    if ($cache = $this->cacheBackend
      ->get($tree_cid)) {
      $this->builtTrees[$tree_cid] = $cache->data;
    }
    else {
      $options['parents'] = [];
      $this->builtTrees[$tree_cid] = $this
        ->getTokenData($token_type, $options);
      $this->cacheBackend
        ->set($tree_cid, $this->builtTrees[$tree_cid], Cache::PERMANENT, [
        Token::TOKEN_INFO_CACHE_TAG,
      ]);
    }
  }
  $tree = $this->builtTrees[$tree_cid];

  // If the user has requested a flat tree, convert it.
  if (!empty($options['flat'])) {
    $tree = $this
      ->flattenTree($tree);
  }

  // Fill in token values.
  if (!empty($options['values'])) {
    $token_values = [];
    foreach ($tree as $token => $token_info) {
      if (!empty($token_info['dynamic']) || !empty($token_info['restricted'])) {
        continue;
      }
      elseif (!isset($token_info['value'])) {
        $token_values[$token_info['token']] = $token;
      }
    }
    if (!empty($token_values)) {
      $token_values = $this->tokenService
        ->generate($token_type, $token_values, $options['data'], [], new BubbleableMetadata());
      foreach ($token_values as $token => $replacement) {
        $tree[$token]['value'] = $replacement;
      }
    }
  }
  return $tree;
}