Defines a Plugin annotation object for views display plugins.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase implements AnnotationInterface
- class \Drupal\views\Annotation\ViewsDisplay
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase implements AnnotationInterface
See also
\Drupal\views\Plugin\views\display\DisplayPluginBase
Related topics
- Annotations
- Annotations for class discovery and metadata description.
- Views display plugins
- Plugins to handle the overall display of views.
File
- core/modules/views/src/Annotation/ViewsDisplay.php, line 14
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. |
| ViewsDisplay::$admin | public | property | The administrative name of the display. |
| ViewsDisplay::$base | public | property | The base tables on which this display plugin can be used. |
| ViewsDisplay::$contextual_links_locations | public | property | A list of places where contextual links should be added. For example: |
| ViewsDisplay::$help | public | property | A short help string; this is displayed in the views UI. |
| ViewsDisplay::$id | public | property | The plugin ID. |
| ViewsDisplay::$no_ui | public | property | Whether the plugin should be not selectable in the UI. |
| ViewsDisplay::$returns_response | public | property | Whether the display returns a response object. |
| ViewsDisplay::$short_title | public | property | (optional) The short title used in the views UI. |
| ViewsDisplay::$theme | public | property | The theme function used to render the display's output. |
| ViewsDisplay::$title | public | property | The plugin title used in the views UI. |
| ViewsDisplay::$uses_hook_block | public | property | Does the display plugin provide blocks. |
| ViewsDisplay::$uses_menu_links | public | property | Whether or not to use hook_menu() to register a route. |
| ViewsDisplay::$uses_route | public | property | Does the display plugin registers routes to the route. |
| ViewsPluginAnnotationBase::$register_theme | public | property | Whether or not to register a theme function automatically. |
Please login to continue.