class ViewsRow

Defines a ViewsRow attribute for plugin discovery.

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]

Hierarchy

Expanded class hierarchy of ViewsRow

See also

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

Related topics

Views row plugins
Plugins that control how Views outputs an individual record.
13 files declare their use of ViewsRow
DataEntityRow.php in core/modules/rest/src/Plugin/views/row/DataEntityRow.php
DataFieldRow.php in core/modules/rest/src/Plugin/views/row/DataFieldRow.php
EntityReference.php in core/modules/views/src/Plugin/views/row/EntityReference.php
EntityRow.php in core/modules/views/src/Plugin/views/row/EntityRow.php
Fields.php in core/modules/views/src/Plugin/views/row/Fields.php

... See full list

File

View on git.drupalcode.org

core/modules/views/src/Attribute/ViewsRow.php, line 17

Namespace

Drupal\views\Attribute
View source 
class ViewsRow extends Plugin {
  
  /**
   * Constructs an ViewsRow attribute.
   *
   * @param string $id
   *   The plugin ID.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title
   *   (optional) The plugin title used in the views UI.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
   *   (optional) The short title used in the views UI.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
   *   (optional) A short help string; this is displayed in the views UI.
   * @param string[] $display_types
   *   (optional) 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.
   * @param string[] $base
   *   (optional) 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.
   * @param string|null $theme
   *   (optional) The theme function used to render the style output.
   * @param bool $no_ui
   *   (optional) Whether the plugin should be not selectable in the UI.
   *   If set to TRUE, you can still use it via the API in config files.
   *   Defaults to FALSE.
   * @param bool $register_theme
   *   (optional) Whether to register a theme function automatically. Defaults
   *   to TRUE.
   * @param class-string|null $deriver
   *   (optional) The deriver class.
   */
  public function __construct(public readonly string $id, public readonly ?TranslatableMarkup $title = NULL, public readonly ?TranslatableMarkup $short_title = NULL, public readonly ?TranslatableMarkup $help = NULL, public readonly array $display_types = [], public readonly array $base = [], public readonly ?string $theme = NULL, public readonly bool $no_ui = FALSE, public readonly bool $register_theme = TRUE, public readonly ?string $deriver = NULL) {
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AttributeBase::$class protected property The class used for this attribute class.
AttributeBase::$provider protected property The provider of the attribute class.
AttributeBase::get public function Gets the value of an attribute. Overrides AttributeInterface::get 6
AttributeBase::getClass public function Gets the class of the attribute class. Overrides AttributeInterface::getClass 1
AttributeBase::getId public function Gets the unique ID for this attribute class. Overrides AttributeInterface::getId
AttributeBase::getProvider public function Gets the name of the provider of the attribute class. Overrides AttributeInterface::getProvider
AttributeBase::setClass public function Sets the class of the attributed class. Overrides AttributeInterface::setClass 1
AttributeBase::setProvider public function Sets the name of the provider of the attribute class. Overrides AttributeInterface::setProvider
ViewsRow::__construct public function Constructs an ViewsRow attribute. Overrides Plugin::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.