class ApiTokensFilter in API Tokens 8

Same name and namespace in other branches

8.2 src/Plugin/Filter/ApiTokensFilter.php \Drupal\api_tokens\Plugin\Filter\ApiTokensFilter

Provides the API tokens filter.

Plugin annotation


@Filter(
  id = "api_tokens",
  title = @Translation("API Tokens"),
  description = @Translation("Render API tokens."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
  settings = {
    "unregistered_tokens_behavior" = "cutout"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\filter\Plugin\FilterBase implements FilterInterface
    class \Drupal\api_tokens\Plugin\Filter\ApiTokensFilter implements ContainerFactoryPluginInterface

Expanded class hierarchy of ApiTokensFilter

File

src/Plugin/Filter/ApiTokensFilter.php, line 25

Namespace

Drupal\api_tokens\Plugin\Filter

View source

class ApiTokensFilter extends FilterBase implements ContainerFactoryPluginInterface {

  /**
   * The API token pattern.
   */
  const PATTERN = '@\\[api:([0-9a-z_-]+)(\\[.*?\\])?/]@';

  /**
   * The API token manager.
   *
   * @var \Drupal\api_tokens\ApiTokenManagerInterface
   */
  protected $apiTokenManager;

  /**
   * Constructs an ApiTokens 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\api_tokens\ApiTokenManagerInterface $api_token_manager
   *   The API token manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ApiTokenManagerInterface $api_token_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->apiTokenManager = $api_token_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.api_token'));
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['unregistered_tokens_behavior'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Unregistered API tokens process behavior'),
      '#default_value' => $this->settings['unregistered_tokens_behavior'],
      '#options' => [
        'cutout' => $this
          ->t('Cut out'),
        'ignore' => $this
          ->t('Ignore'),
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $result = new FilterProcessResult($text);
    if (preg_match_all(self::PATTERN, $text, $matches)) {
      list($tokens, $ids, $args) = $matches;
      $replacements = $tokens;
      foreach ($ids as $index => $id) {
        if ($this->apiTokenManager
          ->hasDefinition($id)) {
          $placeholder = $this->apiTokenManager
            ->createInstance($id, [
            'params' => $args[$index],
          ])
            ->placeholder();
          $result
            ->addAttachments([
            'placeholders' => [
              $tokens[$index] => $placeholder,
            ],
          ]);
        }
        elseif ('cutout' == $this->settings['unregistered_tokens_behavior']) {
          $replacements[$index] = '';
        }
      }
      $text = str_replace($tokens, $replacements, $text);
      $result
        ->setProcessedText($text);
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    return $this
      ->t('Replace API tokens.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApiTokensFilter::$apiTokenManager	protected	property	The API token manager.
ApiTokensFilter::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ApiTokensFilter::PATTERN		constant	The API token pattern.
ApiTokensFilter::process	public	function	Performs the filter processing. Overrides FilterInterface::process
ApiTokensFilter::settingsForm	public	function	Generates a filter's settings form. Overrides FilterBase::settingsForm
ApiTokensFilter::tips	public	function	Generates a filter's tip. Overrides FilterBase::tips
ApiTokensFilter::__construct	public	function	Constructs an ApiTokens object. Overrides FilterBase::__construct
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
FilterBase::$provider	public	property	The name of the provider that owns this filter.
FilterBase::$settings	public	property	An associative array containing the configured settings of this filter.
FilterBase::$status	public	property	A Boolean indicating whether this filter is enabled.
FilterBase::$weight	public	property	The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
FilterBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription	public	function	Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions	public	function	Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions	4
FilterBase::getLabel	public	function	Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType	public	function	Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare	public	function	Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
FilterInterface::TYPE_HTML_RESTRICTOR		constant	HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE		constant	Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE		constant	Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE		constant	Reversible transformation filters.
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.
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

class ApiTokensFilter in API Tokens 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation