forward.tokens.inc in Forward 4.x

Provide tokens related to the forward module.

File

forward.tokens.inc

<?php

/**
 * @file
 * Provide tokens related to the forward module.
 */
use Drupal\Core\Render\BubbleableMetadata;
use Drupal\Core\Render\Markup;
use Drupal\Component\Utility\Xss;

/**
 * Implements hook_token_info().
 */
function forward_token_info() {
  $data['types'] = [
    'forward' => [
      'name' => t('Forward'),
      'description' => t('Tokens related to forward module.'),
    ],
  ];
  $data['tokens'] = [
    'forward' => [
      'recipients' => [
        'name' => t("Email recipient(s)"),
        'description' => t("Recipient email address or email addresses for forwarded content."),
      ],
      'sender-name' => [
        'name' => t("Sender's name"),
        'description' => t("Name of sender as entered in Forwarding form."),
      ],
      'sender-email' => [
        'name' => t("Sender's email address"),
        'description' => t("Email address of sender as entered in Forwarding form."),
      ],
      'entity-type' => [
        'name' => t("Entity type"),
        'description' => t('The type of entity being forwarded. For nodes, uses the bundle name, e.g. "article" or "page", instead of the type.'),
      ],
      'entity-title' => [
        'name' => t("Entity title"),
        'description' => t('The title of the entity being forwarded.'),
      ],
      'entity-url' => [
        'name' => t('Entity URL'),
        'description' => t('The absolute URL for the entity being forwarded.'),
      ],
      'entity-link' => [
        'name' => t('Entity link'),
        'description' => t('A formatted link (using title and URL) of the entity being forwarded.'),
      ],
    ],
  ];
  return $data;
}

/**
 * Implements hook_tokens().
 */
function forward_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
  $replacements = [];
  if ($type == 'forward' && !empty($data['forward'])) {
    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'entity-type':
          if (isset($data['forward']['entity'])) {
            $entity = $data['forward']['entity'];
            $entity_type = (string) $entity
              ->getEntityType()
              ->getLabel();
            if ($entity
              ->getEntityType()
              ->hasKey('bundle')) {

              // For entity types with bundles, use the bundle label instead of the entity type label.
              $bundles = \Drupal::service('entity_type.bundle.info')
                ->getBundleInfo($entity
                ->getEntityTypeId());
              $entity_type = $bundles[$entity
                ->bundle()]['label'];
            }

            // Use the translated label, then lowercase it.
            $entity_type = strtolower(t($entity_type, [], $options));
          }
          $replacements[$original] = isset($data['forward']['entity']) ? Markup::create(Xss::filter($entity_type)) : t('page');
          break;
        case 'entity-title':
          if (isset($data['forward']['entity'])) {
            $entity = $data['forward']['entity'];
            $entity_title = $entity
              ->access('view') ? $entity
              ->label() : t('a page');
          }
          $replacements[$original] = isset($data['forward']['entity']) ? Markup::create(Xss::filter($entity_title)) : t('a page');
          break;
        case 'entity-url':
          if (isset($data['forward']['entity'])) {
            $entity = $data['forward']['entity'];
            $entity_url = $entity
              ->access('view') ? $entity
              ->url('canonical', [
              'absolute' => TRUE,
            ]) : t('a URL');
          }
          $replacements[$original] = isset($data['forward']['entity']) ? Markup::create(Xss::filter($entity_url)) : t('a URL');
          break;
        case 'entity-link':
          if (isset($data['forward']['entity'])) {
            $entity = $data['forward']['entity'];
            $entity_link = $entity
              ->access('view') ? $entity
              ->toLink($entity
              ->label())
              ->toString() : t('a link');
          }
          $replacements[$original] = isset($data['forward']['entity']) ? Markup::create(Xss::filter($entity_link)) : t('a link');
          break;
        case 'recipients':
          $replacements[$original] = isset($data['forward']['recipients']) ? Markup::create(Xss::filter(implode(', ', $data['forward']['recipients']))) : t('(Recipient list)');
          break;
        case 'sender-name':
          $replacements[$original] = isset($data['forward']['sender_name']) ? Markup::create(Xss::filter($data['forward']['sender_name'])) : t('(Your name)');
          break;
        case 'sender-email':
          $replacements[$original] = isset($data['forward']['sender_email']) ? Markup::create(Xss::filter($data['forward']['sender_email'])) : t('(Your email address)');
          break;
      }
    }
  }
  return $replacements;
}

Functions

Name	Description
forward_tokens	Implements hook_tokens().
forward_token_info	Implements hook_token_info().