class ViewsStyle

Same name in other branches
  1. 8.9.x core/modules/views/src/Annotation/ViewsStyle.php \Drupal\views\Annotation\ViewsStyle
  2. 10 core/modules/views/src/Annotation/ViewsStyle.php \Drupal\views\Annotation\ViewsStyle
  3. 11.x core/modules/views/src/Annotation/ViewsStyle.php \Drupal\views\Annotation\ViewsStyle
  4. 11.x core/modules/views/src/Attribute/ViewsStyle.php \Drupal\views\Attribute\ViewsStyle
  5. 10 core/modules/views/src/Attribute/ViewsStyle.php \Drupal\views\Attribute\ViewsStyle

Defines a Plugin annotation object for views style plugins.

Hierarchy

Expanded class hierarchy of ViewsStyle

See also

\Drupal\views\Plugin\views\style\StylePluginBase

Related topics

Views style plugins
Plugins that control how the collection of results is rendered in a view.
Annotations
Annotations for class discovery and metadata description.
13 classes are annotated with ViewsStyle
DefaultStyle in core/modules/views/src/Plugin/views/style/DefaultStyle.php
Unformatted style plugin to render rows.
DefaultSummary in core/modules/views/src/Plugin/views/style/DefaultSummary.php
The default style plugin for summaries.
EntityReference in core/modules/views/src/Plugin/views/style/EntityReference.php
EntityReference style plugin.
Grid in core/modules/views/src/Plugin/views/style/Grid.php
Style plugin to render each item in a grid cell.
HtmlList in core/modules/views/src/Plugin/views/style/HtmlList.php
Style plugin to render each item in an ordered or unordered list.

... See full list

File

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

Namespace

Drupal\views\Annotation
View 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 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
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.