Defines a Plugin annotation object for views access plugins.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase implements AnnotationInterface
- class \Drupal\views\Annotation\ViewsAccess
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase implements AnnotationInterface
See also
\Drupal\views\Plugin\views\access\AccessPluginBase
Related topics
- Annotations
- Annotations for class discovery and metadata description.
- Views access plugins
- Plugins to handle access checking for views.
File
- core/modules/views/src/Annotation/ViewsAccess.php, line 15
Namespace
Drupal\views\Annotation
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| Plugin::$definition | protected | property | The plugin definition read from the class annotation. |
| Plugin::get | public | function | Gets the value of an annotation. Overrides AnnotationInterface::get |
| 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 |
| 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. |
| ViewsAccess::$base | public | property | The base tables on which this access plugin can be used. |
| ViewsAccess::$display_types | public | property | The types of the display this plugin can be used with. |
| ViewsAccess::$help | public | property | A short help string; this is displayed in the views UI. |
| ViewsAccess::$id | public | property | The plugin ID. |
| ViewsAccess::$no_ui | public | property | Whether the plugin should be not selectable in the UI. |
| ViewsAccess::$short_title | public | property | (optional) The short title used in the views UI. |
| ViewsAccess::$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. |
Please login to continue.