NodeTokensHooks.php

<?php
namespace Drupal\node\Hook;
use Drupal\Core\Datetime\Entity\DateFormat ;
use Drupal\Core\StringTranslation\StringTranslationTrait ;
use Drupal\user\Entity\User ;
use Drupal\Core\Language\LanguageInterface ;
use Drupal\Core\Render\BubbleableMetadata ;
use Drupal\Core\Hook\Attribute\Hook ;

/**
 * Token hook implementations for node.
 */
class NodeTokensHooks  {
 use StringTranslationTrait;
 
 /**
 * Implements hook_token_info().
 */
 public function tokenInfo() : array {
 $type = [
 'name' => $this->t('Nodes'),
 'description' => $this->t('Tokens related to individual content items, or "nodes".'),
 'needs-data' => 'node',
 ];
 // Core tokens for nodes.
 $node['nid'] = [
 'name' => $this->t("Content ID"),
 'description' => $this->t('The unique ID of the content item, or "node".'),
 ];
 $node['uuid'] = [
 'name' => $this->t('UUID'),
 'description' => $this->t('The UUID of the content item, or "node".'),
 ];
 $node['vid'] = [
 'name' => $this->t("Revision ID"),
 'description' => $this->t("The unique ID of the node's latest revision."),
 ];
 $node['type'] = [
 'name' => $this->t("Content type"),
 ];
 $node['type-name'] = [
 'name' => $this->t("Content type name"),
 'description' => $this->t("The human-readable name of the node type."),
 ];
 $node['title'] = [
 'name' => $this->t("Title"),
 ];
 $node['body'] = [
 'name' => $this->t("Body"),
 'description' => $this->t("The main body text of the node."),
 ];
 $node['summary'] = [
 'name' => $this->t("Summary"),
 'description' => $this->t("The summary of the node's main body text."),
 ];
 $node['langcode'] = [
 'name' => $this->t('Language code'),
 'description' => $this->t('The language code of the language the node is written in.'),
 ];
 $node['published_status'] = [
 'name' => $this->t('Published'),
 'description' => $this->t('The publication status of the node ("Published" or "Unpublished").'),
 ];
 $node['url'] = [
 'name' => $this->t("URL"),
 'description' => $this->t("The URL of the node."),
 ];
 $node['edit-url'] = [
 'name' => $this->t("Edit URL"),
 'description' => $this->t("The URL of the node's edit page."),
 ];
 // Chained tokens for nodes.
 $node['created'] = [
 'name' => $this->t("Date created"),
 'type' => 'date',
 ];
 $node['changed'] = [
 'name' => $this->t("Date changed"),
 'description' => $this->t("The date the node was most recently updated."),
 'type' => 'date',
 ];
 $node['author'] = [
 'name' => $this->t("Author"),
 'type' => 'user',
 ];
 return [
 'types' => [
 'node' => $type,
 ],
 'tokens' => [
 'node' => $node,
 ],
 ];
 }
 
 /**
 * Implements hook_tokens().
 */
 public function tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) : array {
 $token_service = \Drupal ::token ();
 $url_options = [
 'absolute' => TRUE,
 ];
 if (isset($options['langcode'])) {
 $url_options['language'] = \Drupal ::languageManager ()->getLanguage ($options['langcode']);
 $langcode = $options['langcode'];
 }
 else {
 $langcode = LanguageInterface::LANGCODE_DEFAULT;
 }
 $replacements = [];
 if ($type == 'node' && !empty($data['node'])) {
 /** @var \Drupal\node\NodeInterface $node */
 $node = $data['node'];
 foreach ($tokens as $name => $original) {
 switch ($name) {
 // Simple key values on the node.
 case 'nid':
 $replacements[$original] = $node->id ();
 break;
 case 'uuid':
 $replacements[$original] = $node->uuid ();
 break;
 case 'vid':
 $replacements[$original] = $node->getRevisionId ();
 break;
 case 'type':
 $replacements[$original] = $node->getType ();
 break;
 case 'type-name':
 $type_name = $node->getBundleEntity ()
 ->label ();
 $replacements[$original] = $type_name;
 break;
 case 'title':
 $replacements[$original] = $node->getTitle ();
 break;
 case 'body':
 case 'summary':
 $translation = \Drupal ::service ('entity.repository')->getTranslationFromContext ($node, $langcode, [
 'operation' => 'node_tokens',
 ]);
 if ($translation->hasField ('body') && ($items = $translation->get ('body')) && !$items->isEmpty ()) {
 $item = $items[0];
 // If the summary was requested and is not empty, use it.
 if ($name == 'summary' && !empty($item->summary)) {
 $output = $item->summary_processed;
 }
 else {
 $output = $item->processed ;
 // A summary was requested.
 if ($name == 'summary') {
 // Generate an optionally trimmed summary of the body field.
 // Get the 'trim_length' size used for the 'teaser' mode, if
 // present, or use the default trim_length size.
 $display_options = \Drupal ::service ('entity_display.repository')->getViewDisplay ('node', $node->getType (), 'teaser')
 ->getComponent ('body');
 if (isset($display_options['settings']['trim_length'])) {
 $length = $display_options['settings']['trim_length'];
 }
 else {
 $settings = \Drupal ::service ('plugin.manager.field.formatter')->getDefaultSettings ('text_summary_or_trimmed');
 $length = $settings['trim_length'];
 }
 $output = text_summary ($output, $item->format , $length);
 }
 }
 // "processed" returns a \Drupal\Component\Render\MarkupInterface
 // via check_markup().
 $replacements[$original] = $output;
 }
 break;
 case 'langcode':
 $replacements[$original] = $node->language ()
 ->getId ();
 break;
 case 'published_status':
 $replacements[$original] = $node->isPublished () ? $this->t('Published') : $this->t('Unpublished');
 break;
 case 'url':
 $replacements[$original] = $node->toUrl ('canonical', $url_options)
 ->toString ();
 break;
 case 'edit-url':
 $replacements[$original] = $node->toUrl ('edit-form', $url_options)
 ->toString ();
 break;
 // Default values for the chained tokens handled below.
 case 'author':
 $account = $node->getOwner () ?: User ::load (0);
 $bubbleable_metadata->addCacheableDependency ($account);
 $replacements[$original] = $account->label ();
 break;
 case 'created':
 $date_format = DateFormat ::load ('medium');
 $bubbleable_metadata->addCacheableDependency ($date_format);
 $replacements[$original] = \Drupal ::service ('date.formatter')->format ($node->getCreatedTime (), 'medium', '', NULL, $langcode);
 break;
 case 'changed':
 $date_format = DateFormat ::load ('medium');
 $bubbleable_metadata->addCacheableDependency ($date_format);
 $replacements[$original] = \Drupal ::service ('date.formatter')->format ($node->getChangedTime (), 'medium', '', NULL, $langcode);
 break;
 }
 }
 if ($author_tokens = $token_service->findWithPrefix ($tokens, 'author')) {
 $replacements += $token_service->generate ('user', $author_tokens, [
 'user' => $node->getOwner (),
 ], $options, $bubbleable_metadata);
 }
 if ($created_tokens = $token_service->findWithPrefix ($tokens, 'created')) {
 $replacements += $token_service->generate ('date', $created_tokens, [
 'date' => $node->getCreatedTime (),
 ], $options, $bubbleable_metadata);
 }
 if ($changed_tokens = $token_service->findWithPrefix ($tokens, 'changed')) {
 $replacements += $token_service->generate ('date', $changed_tokens, [
 'date' => $node->getChangedTime (),
 ], $options, $bubbleable_metadata);
 }
 }
 return $replacements;
 }
}