abstract class ApiTokenBase in API Tokens 8

Same name and namespace in other branches

8.2 src/ApiTokenBase.php \Drupal\api_tokens\ApiTokenBase

Provides a base class for the API token plugins.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\api_tokens\ApiTokenBase implements ApiTokenPluginInterface uses RefinableCacheableDependencyTrait

Expanded class hierarchy of ApiTokenBase

4 files declare their use of ApiTokenBase

BlockApiToken.php in api_tokens_example/src/Plugin/ApiToken/BlockApiToken.php
DateApiToken.php in api_tokens_example/src/Plugin/ApiToken/DateApiToken.php
NodeApiToken.php in api_tokens_example/src/Plugin/ApiToken/NodeApiToken.php
UserLinkApiToken.php in api_tokens_example/src/Plugin/ApiToken/UserLinkApiToken.php

File

src/ApiTokenBase.php, line 17

Namespace

Drupal\api_tokens

View source

abstract class ApiTokenBase extends PluginBase implements ApiTokenPluginInterface {
  use RefinableCacheableDependencyTrait;

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

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The API tokens logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The API token string.
   *
   * @var string
   */
  protected $token;

  /**
   * The API token parameters string.
   *
   * @var string
   */
  protected $paramString;

  /**
   * The API token parameters.
   *
   * @var array
   */
  protected $params;

  /**
   * The API token parameters hash.
   *
   * @var string
   */
  protected $hash;

  /**
   * The API token build method reflection object.
   *
   * @var \ReflectionMethod|null
   */
  protected $reflector;

  /**
   * The API token render context.
   *
   * @var string[]
   */
  protected static $context = [];

  /**
   * Constructs an ApiTokenBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Psr\Log\LoggerInterface $logger
   *   The API tokens logger.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, RendererInterface $renderer, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
    $this->renderer = $renderer;
    $this->logger = $logger;
    $this->paramString = isset($configuration['params']) ? $configuration['params'] : '';
    $this->token = "[api:{$plugin_id}{$this->paramString}/]";
    $this->params = $this->paramString ? Json::decode($this->paramString) : [];
    $this->hash = $this->params ? hash('crc32b', serialize($this->params)) : '';
    $this->reflector = method_exists($this, 'build') ? new \ReflectionMethod($this, 'build') : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'), $container
      ->get('renderer'), $container
      ->get('logger.factory')
      ->get('api_tokens'));
  }

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->pluginId;
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function description() {
    return $this->pluginDefinition['description'];
  }

  /**
   * {@inheritdoc}
   */
  public function provider() {
    return $this->pluginDefinition['provider'];
  }

  /**
   * {@inheritdoc}
   */
  public function token() {
    return $this->token;
  }

  /**
   * {@inheritdoc}
   */
  public function paramString() {
    return $this->paramString;
  }

  /**
   * {@inheritdoc}
   */
  public function params() {
    return $this->params;
  }

  /**
   * {@inheritdoc}
   */
  public function hash() {
    return $this->hash;
  }

  /**
   * {@inheritdoc}
   */
  public function reflector() {
    return $this->reflector;
  }

  /**
   * {@inheritdoc}
   */
  public function validateToken() {
    if (!$this->reflector) {
      $this->logger
        ->warning($this
        ->t('ApiToken plugin "@label" has no "build" method.', [
        '@label' => $this
          ->label(),
      ]));
      return FALSE;
    }
    if (!is_array($this->params)) {
      $this->logger
        ->warning($this
        ->t('API token "@token" has invalid parameters format.', [
        '@token' => $this->token,
      ]));
      return FALSE;
    }
    if ($this->reflector
      ->getNumberOfRequiredParameters() > count($this->params)) {
      $this->logger
        ->warning($this
        ->t('API token "@token" has not enough parameters.', [
        '@token' => $this->token,
      ]));
      return FALSE;
    }
    $params = [];
    foreach ($this->reflector
      ->getParameters() as $index => $param) {
      $use_default = $param
        ->isOptional() && !isset($this->params[$index]);
      $params[$param
        ->getName()] = $use_default ? $param
        ->getDefaultValue() : $this->params[$index];
    }
    $provided_count = count($this->params);
    $defined_count = count($params);
    if ($provided_count > $defined_count) {
      for ($index = $defined_count; $index < $provided_count; ++$index) {
        $params[$index] = $this->params[$index];
      }
    }
    if (!$this
      ->validate($params)) {
      $this->logger
        ->warning($this
        ->t('API token "@token" has invalid parameters.', [
        '@token' => $this->token,
      ]));
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Validates the API token parameters.
   *
   * This validation must be context-independent. For example, if some parameter
   * is expected to be an entity ID, check only whether it is a valid entity ID,
   * but don't check the entity existence/access (these must be checked in the
   * build method).
   *
   * @param array $params
   *   An array of named API token parameters. If an API token has more
   *   parameters then it is defined in build method, extra parameters will be
   *   named by parameter index. For example, if we have the API token
   *   [api:example[123, ["option1", "option2"], "extra1", "extra2"]/],
   *   and plugin's build method argument definition is: ...($id, $options),
   *   the $params will be:
   *   @code
   *   [
   *     'id' => 123,
   *     'options' => ['option1', 'option2'],
   *     '2' => 'extra1',
   *     '3' => 'extra2',
   *   ];
   *   @endcode
   *
   * @return bool
   *
   * @see \Drupal\api_tokens\ApiTokenPluginInterface::validateToken();
   */
  public function validate(array $params) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function process() {
    static $recursion = FALSE;
    if ($recursion) {
      return [];
    }
    $key = "{$this->pluginId}:{$this->hash}";
    if (in_array($key, self::$context)) {
      $recursion = TRUE;
      $this->logger
        ->warning($this
        ->t('Recursion detected while rendering @token API token.', [
        '@token' => $this->token,
      ]));
      return [];
    }
    array_push(self::$context, $key);
    $build = call_user_func_array([
      $this,
      'build',
    ], $this->params);
    $this->moduleHandler
      ->alter('api_token_build', $build, $this);
    $this->renderer
      ->renderPlain($build);
    array_pop(self::$context);
    if ($recursion) {
      self::$context || ($recursion = FALSE);
      return [];
    }
    $this
      ->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));
    $build = [
      '#markup' => $build['#markup'],
      '#attached' => $build['#attached'],
      '#cache' => [
        'contexts' => $this
          ->getCacheContexts(),
        'tags' => $this
          ->getCacheTags(),
        'max-age' => $this
          ->getCacheMaxAge(),
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function fallback() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function placeholder() {
    $placeholder = [
      '#lazy_builder' => [
        self::class . '::lazyBuilder',
        [
          $this->pluginId,
          $this->paramString,
          $this
            ->validateToken(),
        ],
      ],
      '#cache' => [
        'keys' => !self::$context ? [
          'api_token',
          $this->pluginId,
          $this->hash,
        ] : NULL,
      ],
    ];
    return $placeholder;
  }

  /**
   * {@inheritdoc}
   */
  public static function lazyBuilder($id, $params, $valid) {
    $plugin = \Drupal::service('plugin.manager.api_token')
      ->createInstance($id, [
      'params' => $params,
    ]);
    return $valid ? $plugin
      ->process() : $plugin
      ->fallback();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApiTokenBase::$context	protected static	property	The API token render context.
ApiTokenBase::$hash	protected	property	The API token parameters hash.
ApiTokenBase::$logger	protected	property	The API tokens logger.
ApiTokenBase::$moduleHandler	protected	property	The module handler service.
ApiTokenBase::$params	protected	property	The API token parameters.
ApiTokenBase::$paramString	protected	property	The API token parameters string.
ApiTokenBase::$reflector	protected	property	The API token build method reflection object.
ApiTokenBase::$renderer	protected	property	The renderer.
ApiTokenBase::$token	protected	property	The API token string.
ApiTokenBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ApiTokenBase::description	public	function	Returns the administrative description of the API token. Overrides ApiTokenPluginInterface::description
ApiTokenBase::fallback	public	function	Returns a build to replace the API token with in case of validation fail. Overrides ApiTokenPluginInterface::fallback
ApiTokenBase::hash	public	function	Returns the API token parameters hash. Overrides ApiTokenPluginInterface::hash
ApiTokenBase::id	public	function	Returns the API token ID. Overrides ApiTokenPluginInterface::id
ApiTokenBase::label	public	function	Returns the administrative label of the API token. Overrides ApiTokenPluginInterface::label
ApiTokenBase::lazyBuilder	public static	function	The #lazy_builder callback. Overrides ApiTokenPluginInterface::lazyBuilder
ApiTokenBase::params	public	function	Returns the API token parameters. Overrides ApiTokenPluginInterface::params
ApiTokenBase::paramString	public	function	Returns the API token parameter string. Overrides ApiTokenPluginInterface::paramString
ApiTokenBase::placeholder	public	function	Returns a #lazy_builder placeholder for the API tokens filter. Overrides ApiTokenPluginInterface::placeholder
ApiTokenBase::process	public	function	Returns processed API token build. Overrides ApiTokenPluginInterface::process
ApiTokenBase::provider	public	function	Returns the name of the provider that owns this API token. Overrides ApiTokenPluginInterface::provider
ApiTokenBase::reflector	public	function	Returns the API token build method reflection object. Overrides ApiTokenPluginInterface::reflector
ApiTokenBase::token	public	function	Returns the API token string. Overrides ApiTokenPluginInterface::token
ApiTokenBase::validate	public	function	Validates the API token parameters.	3
ApiTokenBase::validateToken	public	function	Performs one-time context-independent validation of the API token. Overrides ApiTokenPluginInterface::validateToken
ApiTokenBase::__construct	public	function	Constructs an ApiTokenBase object. Overrides PluginBase::__construct
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::getCacheContexts	public	function		3
CacheableDependencyTrait::getCacheMaxAge	public	function		3
CacheableDependencyTrait::getCacheTags	public	function		3
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
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.

You are here

abstract class ApiTokenBase in API Tokens 8

Hierarchy

File

Namespace

Members

API Navigation