abstract class TokenizeAreaPluginBase in Drupal 10

Tokenized base class for area handlers.

This class provides a method tokenizeValue() to tokenize a given value with the tokens of the first view result and additionally applies global token replacement to the passed value. The form elements to enable the replacement functionality is automatically added to the buildOptionsForm().

Hierarchy

• class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
  • class \Drupal\views\Plugin\views\area\TokenizeAreaPluginBase

Related topics

Views area handler plugins

Plugins governing areas of views, such as header, footer, and empty text.

File

core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php, line 18

Namespace

Drupal\views\Plugin\views\area

abstract class TokenizeAreaPluginBase extends AreaPluginBase {

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['tokenize'] = [
      'default' => FALSE,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Add tokenization form elements.
    $this
      ->tokenForm($form, $form_state);
  }

  /**
   * Adds tokenization form elements.
   */
  public function tokenForm(&$form, FormStateInterface $form_state) {
    $form['tokenize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use replacement tokens from the first row'),
      '#default_value' => $this->options['tokenize'],
    ];

    // Get a list of the available fields and arguments for token replacement.
    $options = [];
    $optgroup_arguments = (string) t('Arguments');
    $optgroup_fields = (string) t('Fields');
    foreach ($this->view->display_handler
      ->getHandlers('field') as $field => $handler) {
      $options[$optgroup_fields]["{{ {$field} }}"] = $handler
        ->adminLabel();
    }
    foreach ($this->view->display_handler
      ->getHandlers('argument') as $arg => $handler) {
      $options[$optgroup_arguments]["{{ arguments.{$arg} }}"] = $this
        ->t('@argument title', [
        '@argument' => $handler
          ->adminLabel(),
      ]);
      $options[$optgroup_arguments]["{{ raw_arguments.{$arg} }}"] = $this
        ->t('@argument input', [
        '@argument' => $handler
          ->adminLabel(),
      ]);
    }
    if (!empty($options)) {
      $form['tokens'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Replacement patterns'),
        '#open' => TRUE,
        '#id' => 'edit-options-token-help',
        '#states' => [
          'visible' => [
            ':input[name="options[tokenize]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['tokens']['help'] = [
        '#markup' => '<p>' . $this
          ->t('The following tokens are available. You may use Twig syntax in this field.') . '</p>',
      ];
      foreach (array_keys($options) as $type) {
        if (!empty($options[$type])) {
          $items = [];
          foreach ($options[$type] as $key => $value) {
            $items[] = $key . ' == ' . $value;
          }
          $form['tokens'][$type]['tokens'] = [
            '#theme' => 'item_list',
            '#items' => $items,
          ];
        }
      }
      $form['tokens']['html_help'] = [
        '#markup' => '<p>' . $this
          ->t('You may include the following allowed HTML tags with these "Replacement patterns": <code>@tags</code>', [
          '@tags' => '<' . implode('> <', Xss::getAdminTagList()) . '>',
        ]) . '</p>',
      ];
    }
    $this
      ->globalTokenForm($form, $form_state);
  }

  /**
   * Replaces value with special views tokens and global tokens.
   *
   * @param string $value
   *   The value to eventually tokenize.
   *
   * @return string
   *   Tokenized value if tokenize option is enabled. In any case global tokens
   *   will be replaced.
   */
  public function tokenizeValue($value) {
    if ($this->options['tokenize']) {
      $value = $this->view
        ->getStyle()
        ->tokenizeValue($value, 0);
    }

    // As we add the globalTokenForm() we also should replace the token here.
    return $this
      ->globalTokenReplace($value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AreaPluginBase::$areaType	public	property	The type of this area handler, i.e. 'header', 'footer', or 'empty'.
AreaPluginBase::adminSummary	public	function
AreaPluginBase::init	public	function	Overrides Drupal\views\Plugin\views\HandlerBase::init().	1
AreaPluginBase::isEmpty	public	function	Does that area have nothing to show.	1
AreaPluginBase::preRender	public	function	Performs any operations needed before full rendering.	1
AreaPluginBase::render	abstract public	function	Render the area.	12
AreaPluginBase::usesGroupBy	public	function
TokenizeAreaPluginBase::buildOptionsForm	public	function	Overrides AreaPluginBase::buildOptionsForm	3
TokenizeAreaPluginBase::defineOptions	protected	function	Overrides AreaPluginBase::defineOptions	3
TokenizeAreaPluginBase::tokenForm	public	function	Adds tokenization form elements.
TokenizeAreaPluginBase::tokenizeValue	public	function	Replaces value with special views tokens and global tokens.