class WorkbenchAccessTokens in Workbench Access 8

Token handler for Workbench Access.

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

Hierarchy

• class \Drupal\workbench_access\WorkbenchAccessTokens uses StringTranslationTrait

1 string reference to 'WorkbenchAccessTokens'

workbench_access.services.yml in ./workbench_access.services.yml

workbench_access.services.yml

1 service uses WorkbenchAccessTokens

workbench_access.tokens in ./workbench_access.services.yml

Drupal\workbench_access\WorkbenchAccessTokens

File

src/WorkbenchAccessTokens.php, line 21

Namespace

Drupal\workbench_access

class WorkbenchAccessTokens {
  use StringTranslationTrait;

  /**
   * The core token service
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $tokenService;

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

  /**
   * The core module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The workbench access user section storage service.
   *
   * @var \Drupal\workbench_access\UserSectionStorageInterface
   */
  protected $userSectionStorage;

  /**
   * Constructs a WorkbenchAccessTokens object.
   *
   * '@token', '@entity_type.manager', '@workbench_access.user_section_storage', '@module_handler'
   *
   * @param \Drupal\Core\Utility\Token $token_service
   *   The core token service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The core module handler.
   * @param \Drupal\workbench_access\UserSectionStorageInterface $user_section_storage
   *   The workbench access user section storage service.
   */
  public function __construct(Token $token_service, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, UserSectionStorageInterface $user_section_storage) {
    $this->tokenService = $token_service;
    $this->entityTypeManager = $entity_type_manager;
    $this->moduleHandler = $module_handler;
    $this->userSectionStorage = $user_section_storage;
  }

  /**
   * Implements hook_token_info().
   */
  public function getTokenInfo() {
    $info['tokens'] = [
      'user' => [
        'workbench-access-sections' => [
          'name' => t('Workbench access sections'),
          'description' => $this
            ->t('Section assignments for the user account.'),
          // Optionally use token module's array type which gives users greater
          // control on output.
          'type' => $this->moduleHandler
            ->moduleExists('token') ? 'array' : '',
        ],
      ],
      'node' => [
        'workbench-access-sections' => [
          'name' => t('Workbench access sections'),
          'description' => $this
            ->t('Section assignments for content.'),
          // Optionally use token module's array type which gives users greater
          // control on output.
          'type' => $this->moduleHandler
            ->moduleExists('token') ? 'array' : '',
        ],
      ],
    ];
    return $info;
  }

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

    // User tokens.
    if ($type === 'user' && !empty($data['user'])) {

      /** @var \Drupal\user\UserInterface $user */
      $user = $data['user'];
      foreach ($tokens as $name => $original) {
        switch ($name) {
          case 'workbench-access-sections':
            if ($sections = $this
              ->getUserSectionNames($user, $bubbleable_metadata)) {
              if (function_exists('token_render_array')) {
                $replacements[$original] = token_render_array($sections, $options);
              }
              else {
                $replacements[$original] = implode(', ', $sections);
              }
            }
            break;
        }
      }

      // Chained token relationships.
      if ($section_tokens = $this->tokenService
        ->findWithPrefix($tokens, 'workbench-access-sections')) {
        if ($sections = $this
          ->getUserSectionNames($user, $bubbleable_metadata)) {
          $replacements += $this->tokenService
            ->generate('array', $section_tokens, [
            'array' => $sections,
          ], $options, $bubbleable_metadata);
        }
      }
    }

    // Node tokens.
    if ($type === 'node' && !empty($data['node'])) {

      /** @var \Drupal\node\NodeInterface $node */
      $node = $data['node'];
      foreach ($tokens as $name => $original) {
        switch ($name) {
          case 'workbench-access-sections':
            if ($sections = $this
              ->getNodeSectionNames($node, $bubbleable_metadata)) {
              if (function_exists('token_render_array')) {
                $replacements[$original] = token_render_array($sections, $options);
              }
              else {
                $replacements[$original] = implode(', ', $sections);
              }
            }
            break;
        }
      }

      // Chained token relationships.
      if ($section_tokens = $this->tokenService
        ->findWithPrefix($tokens, 'workbench-access-sections')) {
        if ($sections = $this
          ->getNodeSectionNames($node, $bubbleable_metadata)) {
          $replacements += $this->tokenService
            ->generate('array', $section_tokens, [
            'array' => $sections,
          ], $options, $bubbleable_metadata);
        }
      }
    }
    return $replacements;
  }

  /**
   * Generates an array of section names for a given account.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user account.
   * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
   *   The cache metadata.
   *
   * @return array
   *   An array of section names.
   */
  private function getUserSectionNames(UserInterface $user, BubbleableMetadata $bubbleable_metadata) {
    $schemes = $this->entityTypeManager
      ->getStorage('access_scheme')
      ->loadMultiple();
    return array_reduce($schemes, function (array $carry, AccessSchemeInterface $scheme) use ($user, $bubbleable_metadata) {
      if (!($sections = $this->userSectionStorage
        ->getUserSections($scheme, $user))) {
        return $carry;
      }
      $bubbleable_metadata
        ->addCacheableDependency($scheme);
      return array_merge($carry, array_reduce($scheme
        ->getAccessScheme()
        ->getTree(), function ($inner, $info) use ($sections) {
        $user_in_sections = array_intersect_key($info, array_combine($sections, $sections));
        return array_merge($inner, array_column($user_in_sections, 'label'));
      }, []));
    }, []);
  }

  /**
   * Generates an array of section names for a given node.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The user account.
   * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
   *   The cache metadata.
   *
   * @return array
   *   An array of section names.
   */
  private function getNodeSectionNames(NodeInterface $node, BubbleableMetadata $bubbleable_metadata) {
    $schemes = $this->entityTypeManager
      ->getStorage('access_scheme')
      ->loadMultiple();
    return array_reduce($schemes, function (array $carry, AccessSchemeInterface $scheme) use ($node, $bubbleable_metadata) {
      if (!($sections = $scheme
        ->getAccessScheme()
        ->getEntityValues($node))) {
        return $carry;
      }
      $bubbleable_metadata
        ->addCacheableDependency($scheme);
      return array_merge($carry, array_reduce($scheme
        ->getAccessScheme()
        ->getTree(), function ($inner, $info) use ($sections) {
        $node_in_sections = array_intersect_key($info, array_combine($sections, $sections));
        return array_merge($inner, array_column($node_in_sections, 'label'));
      }, []));
    }, []);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
WorkbenchAccessTokens::$entityTypeManager	protected	property	The entity type manager.
WorkbenchAccessTokens::$moduleHandler	protected	property	The core module handler.
WorkbenchAccessTokens::$tokenService	protected	property	The core token service
WorkbenchAccessTokens::$userSectionStorage	protected	property	The workbench access user section storage service.
WorkbenchAccessTokens::getNodeSectionNames	private	function	Generates an array of section names for a given node.
WorkbenchAccessTokens::getTokenInfo	public	function	Implements hook_token_info().
WorkbenchAccessTokens::getTokens	public	function	Implements hook_tokens().
WorkbenchAccessTokens::getUserSectionNames	private	function	Generates an array of section names for a given account.
WorkbenchAccessTokens::__construct	public	function	Constructs a WorkbenchAccessTokens object.