class QueryParameter in Drupal 10

A query parameter argument default handler.

Plugin annotation

@ViewsArgumentDefault(
  id = "query_parameter",
  title = @Translation("Query parameter")
)

Hierarchy

• class \Drupal\views\Plugin\views\argument_default\QueryParameter extends \Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase implements CacheableDependencyInterface

1 file declares its use of QueryParameter

QueryParameterTest.php in core/modules/views/tests/src/Unit/Plugin/argument_default/QueryParameterTest.php

File

core/modules/views/src/Plugin/views/argument_default/QueryParameter.php, line 19

Namespace

Drupal\views\Plugin\views\argument_default

class QueryParameter extends ArgumentDefaultPluginBase implements CacheableDependencyInterface {

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

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['query_param'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Query parameter'),
      '#description' => $this
        ->t('The query parameter to use.'),
      '#default_value' => $this->options['query_param'],
    ];
    $form['fallback'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fallback value'),
      '#description' => $this
        ->t('The fallback value to use when the above query parameter is not present.'),
      '#default_value' => $this->options['fallback'],
    ];
    $form['multiple'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Multiple values'),
      '#description' => $this
        ->t('Conjunction to use when handling multiple values. E.g. "?value[0]=a&value[1]=b".'),
      '#default_value' => $this->options['multiple'],
      '#options' => [
        'and' => $this
          ->t('AND'),
        'or' => $this
          ->t('OR'),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getArgument() {
    $current_request = $this->view
      ->getRequest();
    if ($current_request->query
      ->has($this->options['query_param'])) {
      $param = $current_request->query
        ->all()[$this->options['query_param']];
      if (is_array($param)) {
        $conjunction = $this->options['multiple'] == 'and' ? ',' : '+';
        $param = implode($conjunction, $param);
      }
      return $param;
    }
    else {

      // Otherwise, use the fixed fallback value.
      return $this->options['fallback'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return Cache::PERMANENT;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [
      'url',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	14
QueryParameter::buildOptionsForm	public	function
QueryParameter::defineOptions	protected	function
QueryParameter::getArgument	public	function
QueryParameter::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
QueryParameter::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge