class ViewsArgumentValidator
Defines a Plugin annotation object for views argument validator plugins.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase extends \Drupal\Component\Annotation\Plugin
- class \Drupal\views\Annotation\ViewsArgumentValidator extends \Drupal\views\Annotation\ViewsPluginAnnotationBase
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of ViewsArgumentValidator
See also
\Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase
Related topics
File
-
core/
modules/ views/ src/ Annotation/ ViewsArgumentValidator.php, line 14
Namespace
Drupal\views\AnnotationView source
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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 6 |
| Plugin::getClass | public | function | Gets the class of the annotated class. | Overrides AnnotationInterface::getClass | 1 |
| 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 | 1 |
| 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. | 3 | |
| 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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.