You are here

trait YieldToArgumentTrait in Lightning Core 8.5

Same name and namespace in other branches
  1. 8 src/YieldToArgumentTrait.php \Drupal\lightning_core\YieldToArgumentTrait
  2. 8.2 src/YieldToArgumentTrait.php \Drupal\lightning_core\YieldToArgumentTrait
  3. 8.3 src/YieldToArgumentTrait.php \Drupal\lightning_core\YieldToArgumentTrait
  4. 8.4 src/YieldToArgumentTrait.php \Drupal\lightning_core\YieldToArgumentTrait

Allows exposed an Views filter to disappear if an argument is present.

Hierarchy

1 file declares its use of YieldToArgumentTrait
Bundle.php in src/Plugin/views/filter/Bundle.php

File

src/YieldToArgumentTrait.php, line 10

Namespace

Drupal\lightning_core
View source
trait YieldToArgumentTrait {

  /**
   * {@inheritdoc}
   */
  public function buildExposedForm(&$form, FormStateInterface $form_state) {
    parent::buildExposedForm($form, $form_state);
    if (empty($this->options['exposed'])) {
      return;
    }
    if (empty($this->options['expose']['argument'])) {
      return;
    }
    $argument = $this->options['expose']['argument'];
    $argument = $this->view->argument[$argument];

    /** @var \Drupal\views\Plugin\views\argument\ArgumentPluginBase $argument */
    $value = $argument
      ->getValue();
    $key = $this->options['expose']['identifier'];
    $form[$key]['#access'] = is_null($value) || $argument
      ->isException($value);
  }

  /**
   * {@inheritdoc}
   */
  public function buildExposeForm(&$form, FormStateInterface $form_state) {
    parent::buildExposeForm($form, $form_state);
    $form['expose']['argument'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Yield to argument'),
      '#options' => [],
      '#empty_option' => $this
        ->t('- None -'),
      '#default_value' => $this->options['expose']['argument'],
      '#description' => $this
        ->t('If this argument has a non-null value (given or default), this filter will not be exposed to the user.'),
    ];

    /**
     * @var string $id
     * @var \Drupal\views\Plugin\views\argument\ArgumentPluginBase $argument
     */
    foreach ($this->displayHandler
      ->getHandlers('argument') as $id => $argument) {
      $form['expose']['argument']['#options'][$id] = $argument
        ->adminLabel();
      $form['expose']['argument']['#access'] = TRUE;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['expose']['contains']['argument']['default'] = NULL;
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultExposeOptions() {
    parent::defaultExposeOptions();
    $this->options['expose']['argument'] = NULL;
  }

}

Members