class DomainToken in Domain Access 8

Token handler for Domain.

TokenAPI still uses procedural code, but we have moved it to a class for easier refactoring.

Hierarchy

• class \Drupal\domain\DomainToken uses StringTranslationTrait

1 string reference to 'DomainToken'

domain.services.yml in domain/domain.services.yml

domain/domain.services.yml

1 service uses DomainToken

domain.token in domain/domain.services.yml

Drupal\domain\DomainToken

File

domain/src/DomainToken.php, line 15

Namespace

Drupal\domain

class DomainToken {
  use StringTranslationTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The Domain storage handler.
   *
   * @var \Drupal\domain\DomainStorageInterface
   */
  protected $domainStorage;

  /**
   * The Domain negotiator.
   *
   * @var \Drupal\domain\DomainNegotiatorInterface
   */
  protected $negotiator;

  /**
   * Constructs a DomainToken object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\domain\DomainNegotiatorInterface $negotiator
   *   The domain negotiator.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, DomainNegotiatorInterface $negotiator) {
    $this->entityTypeManager = $entity_type_manager;
    $this->domainStorage = $this->entityTypeManager
      ->getStorage('domain');
    $this->negotiator = $negotiator;
  }

  /**
   * Implements hook_token_info().
   */
  public function getTokenInfo() {

    // Domain token types.
    $info['types']['domain'] = [
      'name' => $this
        ->t('Domains'),
      'description' => $this
        ->t('Tokens related to domains.'),
      'needs-data' => 'domain',
    ];

    // These two types require the Token contrib module.
    $info['types']['current-domain'] = [
      'name' => $this
        ->t('Current domain'),
      'description' => $this
        ->t('Tokens related to the current domain.'),
      'type' => 'domain',
    ];
    $info['types']['default-domain'] = [
      'name' => $this
        ->t('Default domain'),
      'description' => $this
        ->t('Tokens related to the default domain.'),
      'type' => 'domain',
    ];

    // Domain tokens.
    $info['tokens']['domain']['id'] = [
      'name' => $this
        ->t('Domain id'),
      'description' => $this
        ->t("The domain's numeric ID."),
    ];
    $info['tokens']['domain']['machine-name'] = [
      'name' => $this
        ->t('Domain machine name'),
      'description' => $this
        ->t('The domain machine identifier.'),
    ];
    $info['tokens']['domain']['path'] = [
      'name' => $this
        ->t('Domain path'),
      'description' => $this
        ->t('The base URL for the domain.'),
    ];
    $info['tokens']['domain']['name'] = [
      'name' => $this
        ->t('Domain name'),
      'description' => $this
        ->t('The domain name.'),
    ];
    $info['tokens']['domain']['url'] = [
      'name' => $this
        ->t('Domain URL'),
      'description' => $this
        ->t("The domain's URL for the current page request."),
    ];
    $info['tokens']['domain']['hostname'] = [
      'name' => $this
        ->t('Domain hostname'),
      'description' => $this
        ->t('The domain hostname.'),
    ];
    $info['tokens']['domain']['scheme'] = [
      'name' => $this
        ->t('Domain scheme'),
      'description' => $this
        ->t('The domain scheme.'),
    ];
    $info['tokens']['domain']['status'] = [
      'name' => $this
        ->t('Domain status'),
      'description' => $this
        ->t('The domain status.'),
    ];
    $info['tokens']['domain']['weight'] = [
      'name' => $this
        ->t('Domain weight'),
      'description' => $this
        ->t('The domain weight.'),
    ];
    $info['tokens']['domain']['is_default'] = [
      'name' => $this
        ->t('Domain default'),
      'description' => $this
        ->t('The domain is the default domain.'),
    ];
    return $info;
  }

  /**
   * Implements hook_tokens().
   */
  public function getTokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
    $replacements = [];
    $domain = NULL;

    // Based on the type, get the proper domain context.
    switch ($type) {
      case 'domain':
        if (!empty($data['domain'])) {
          $domain = $data['domain'];
        }
        else {
          $domain = $this->negotiator
            ->getActiveDomain();
        }
        break;
      case 'current-domain':
        $domain = $this->negotiator
          ->getActiveDomain();
        break;
      case 'default-domain':
        $domain = $this->domainStorage
          ->loadDefaultDomain();
        break;
    }

    // Set the token information.
    if (!empty($domain)) {
      $callbacks = $this
        ->getCallbacks();
      foreach ($tokens as $name => $original) {
        if (isset($callbacks[$name])) {
          $replacements[$original] = $domain
            ->{$callbacks[$name]}();
          $bubbleable_metadata
            ->addCacheableDependency($domain);
        }
      }
    }
    return $replacements;
  }

  /**
   * Maps tokens to their entity callbacks.
   *
   * We assume that the token will call an instance of DomainInterface.
   *
   * @return array
   *   An array of callbacks keyed by the token string.
   */
  public function getCallbacks() {
    return [
      'id' => 'getDomainId',
      'machine-name' => 'id',
      'path' => 'getPath',
      'name' => 'label',
      'hostname' => 'getHostname',
      'scheme' => 'getScheme',
      'status' => 'status',
      'weight' => 'getWeight',
      'is_default' => 'isDefault',
      'url' => 'getUrl',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DomainToken::$domainStorage	protected	property	The Domain storage handler.
DomainToken::$entityTypeManager	protected	property	The entity type manager.
DomainToken::$negotiator	protected	property	The Domain negotiator.
DomainToken::getCallbacks	public	function	Maps tokens to their entity callbacks.
DomainToken::getTokenInfo	public	function	Implements hook_token_info().
DomainToken::getTokens	public	function	Implements hook_tokens().
DomainToken::__construct	public	function	Constructs a DomainToken object.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.