abstract class ArgumentValidatorPluginBase

Base argument validator plugin to provide basic functionality.

Hierarchy

Expanded class hierarchy of ArgumentValidatorPluginBase

Related topics

3 files declare their use of ArgumentValidatorPluginBase
Node.php in drupal/core/modules/node/lib/Drupal/node/Plugin/views/argument_validator/Node.php
Definition of Drupal\node\Plugin\views\argument_validator\Node.
Term.php in drupal/core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/views/argument_validator/Term.php
Definition of Drupal\taxonomy\Plugin\views\argument_validator\Term.
User.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/argument_validator/User.php
Definition of Drupal\user\Plugin\views\argument_validator\User.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php, line 22
Definition of Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase.

Namespace

Drupal\views\Plugin\views\argument_validator
View source
abstract class ArgumentValidatorPluginBase extends PluginBase {

  /**
   * Initialize this plugin with the view and the argument
   * it is linked to.
   */
  public function init(ViewExecutable $view, &$argument, $options) {
    $this
      ->setOptionDefaults($this->options, $this
      ->defineOptions());
    $this->view =& $view;
    $this->argument =& $argument;
    $this
      ->unpackOptions($this->options, $options);
  }

  /**
   * Retrieve the options when this is a new access
   * control plugin
   */
  protected function defineOptions() {
    return array();
  }

  /**
   * Provide the default form for setting options.
   */
  public function buildOptionsForm(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for validating options
   */
  public function validateOptionsForm(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for submitting options
   */
  public function submitOptionsForm(&$form, &$form_state, &$options = array()) {
  }

  /**
   * Determine if the administrator has the privileges to use this plugin
   */
  public function access() {
    return TRUE;
  }

  /**
   * If we don't have access to the form but are showing it anyway, ensure that
   * the form is safe and cannot be changed from user input.
   *
   * This is only called by child objects if specified in the buildOptionsForm(),
   * so it will not always be used.
   */
  function check_access(&$form, $option_name) {
    if (!$this
      ->access()) {
      $form[$option_name]['#disabled'] = TRUE;
      $form[$option_name]['#value'] = $form[$this->option_name]['#default_value'];
      $form[$option_name]['#description'] .= ' <strong>' . t('Note: you do not have permission to modify this. If you change the default filter type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
    }
  }
  function validate_argument($arg) {
    return TRUE;
  }

  /**
   * Process the summary arguments for displaying.
   *
   * Some plugins alter the argument so it uses something else interal.
   * For example the user validation set's the argument to the uid,
   * for a faster query. But there are use cases where you want to use
   * the old value again, for example the summary.
   */
  function process_summary_arguments(&$args) {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentValidatorPluginBase::access public function Determine if the administrator has the privileges to use this plugin 1
ArgumentValidatorPluginBase::buildOptionsForm public function Provide the default form for setting options. Overrides PluginBase::buildOptionsForm 4
ArgumentValidatorPluginBase::check_access function If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
ArgumentValidatorPluginBase::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides PluginBase::defineOptions 4
ArgumentValidatorPluginBase::init public function Initialize this plugin with the view and the argument it is linked to. 1
ArgumentValidatorPluginBase::process_summary_arguments function Process the summary arguments for displaying. 2
ArgumentValidatorPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm 3
ArgumentValidatorPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm
ArgumentValidatorPluginBase::validate_argument function 6
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct