class ViewsArgumentValidator in Drupal 9

Defines a Plugin annotation object for views argument validator plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\views\Annotation\ViewsPluginAnnotationBase
    • class \Drupal\views\Annotation\ViewsArgumentValidator

See also

\Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase

Related topics

Annotations

Annotations for class discovery and metadata description.

Views argument validate plugins

Plugins for validating views contextual filters.

6 classes are annotated with ViewsArgumentValidator

ArgumentValidatorTest in core/modules/views/tests/modules/views_test_data/src/Plugin/views/argument_validator/ArgumentValidatorTest.php

Defines an argument validator test plugin.

Entity in core/modules/views/src/Plugin/views/argument_validator/Entity.php

Defines an argument validator plugin for each entity type.

None in core/modules/views/src/Plugin/views/argument_validator/None.php

Do not validate the argument.

NumericArgumentValidator in core/modules/views/src/Plugin/views/argument_validator/NumericArgumentValidator.php

Validate whether an argument is numeric or not.

TermName in core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php

Validates whether a term name is a valid term argument.

... See full list

File

core/modules/views/src/Annotation/ViewsArgumentValidator.php, line 14

Namespace

Drupal\views\Annotation

class ViewsArgumentValidator extends ViewsPluginAnnotationBase {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The plugin title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title = '';

  /**
   * (optional) The short title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $short_title = '';

  /**
   * Whether the plugin should be not selectable in the UI.
   *
   * If it's set to TRUE, you can still use it via the API in config files.
   *
   * @var bool
   */
  public $no_ui;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider	1
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
ViewsArgumentValidator::$id	public	property	The plugin ID.
ViewsArgumentValidator::$no_ui	public	property	Whether the plugin should be not selectable in the UI.
ViewsArgumentValidator::$short_title	public	property	(optional) The short title used in the views UI.
ViewsArgumentValidator::$title	public	property	The plugin title used in the views UI.
ViewsPluginAnnotationBase::$register_theme	public	property	Whether or not to register a theme function automatically.