class ViewsStyle
Same name in this branch
- 11.x core/modules/views/src/Attribute/ViewsStyle.php \Drupal\views\Attribute\ViewsStyle
Same name in other branches
- 9 core/modules/views/src/Annotation/ViewsStyle.php \Drupal\views\Annotation\ViewsStyle
- 8.9.x core/modules/views/src/Annotation/ViewsStyle.php \Drupal\views\Annotation\ViewsStyle
- 10 core/modules/views/src/Annotation/ViewsStyle.php \Drupal\views\Annotation\ViewsStyle
- 10 core/modules/views/src/Attribute/ViewsStyle.php \Drupal\views\Attribute\ViewsStyle
Defines a Plugin annotation object for views style 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\ViewsStyle extends \Drupal\views\Annotation\ViewsPluginAnnotationBase
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of ViewsStyle
See also
\Drupal\views\Plugin\views\style\StylePluginBase
Related topics
File
-
core/
modules/ views/ src/ Annotation/ ViewsStyle.php, line 14
Namespace
Drupal\views\AnnotationView source
class ViewsStyle 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 = '';
/**
* A short help string; this is displayed in the views UI.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $help = '';
/**
* The theme function used to render the style output.
*
* @var string
*/
public $theme;
/**
* The types of the display this plugin can be used with.
*
* For example the Feed display defines the type 'feed', so only rss style
* and row plugins can be used in the views UI.
*
* @var array
*/
public $display_types;
/**
* The base tables on which this style plugin can be used.
*
* If no base table is specified the plugin can be used with all tables.
*
* @var array
*/
public $base;
/**
* 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 | Overrides AnnotationInterface::get | 6 | |
Plugin::getClass | public | function | Overrides AnnotationInterface::getClass | 1 | |
Plugin::getId | public | function | Overrides AnnotationInterface::getId | ||
Plugin::getProvider | public | function | Overrides AnnotationInterface::getProvider | 1 | |
Plugin::parse | protected | function | Parses an annotation into its definition. | ||
Plugin::setClass | public | function | Overrides AnnotationInterface::setClass | 1 | |
Plugin::setProvider | public | function | Overrides AnnotationInterface::setProvider | ||
Plugin::__construct | public | function | Constructs a Plugin object. | 3 | |
ViewsPluginAnnotationBase::$register_theme | public | property | Whether or not to register a theme function automatically. | ||
ViewsStyle::$base | public | property | The base tables on which this style plugin can be used. | ||
ViewsStyle::$display_types | public | property | The types of the display this plugin can be used with. | ||
ViewsStyle::$help | public | property | A short help string; this is displayed in the views UI. | ||
ViewsStyle::$id | public | property | The plugin ID. | ||
ViewsStyle::$no_ui | public | property | Whether the plugin should be not selectable in the UI. | ||
ViewsStyle::$short_title | public | property | (optional) The short title used in the views UI. | ||
ViewsStyle::$theme | public | property | The theme function used to render the style output. | ||
ViewsStyle::$title | public | property | The plugin title used in the views UI. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.