class ViewsRow in Drupal 9

Defines a Plugin annotation object for views row plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\views\Annotation\ViewsPluginAnnotationBase
    • class \Drupal\views\Annotation\ViewsRow

See also

\Drupal\views\Plugin\views\row\RowPluginBase

Related topics

Annotations

Annotations for class discovery and metadata description.

Views row plugins

Plugins that control how Views outputs an individual record.

14 classes are annotated with ViewsRow

DataEntityRow in core/modules/rest/src/Plugin/views/row/DataEntityRow.php

Plugin which displays entities as raw data.

DataFieldRow in core/modules/rest/src/Plugin/views/row/DataFieldRow.php

Plugin which displays fields as raw data.

EntityReference in core/modules/views/src/Plugin/views/row/EntityReference.php

EntityReference row plugin.

EntityRow in core/modules/views/src/Plugin/views/row/EntityRow.php

Generic entity row plugin to provide a common base for all entity types.

Fields in core/modules/views/src/Plugin/views/row/Fields.php

The basic 'fields' row plugin.

... See full list

File

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

Namespace

Drupal\views\Annotation

class ViewsRow 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 row output.
   *
   * @var string
   */
  public $theme;

  /**
   * The base tables on which this row plugin can be used.
   *
   * @var array
   */
  public $base;

  /**
   * 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;

  /**
   * 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

Name	Modifiers	Type	Description	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	5
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	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
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.	2
ViewsPluginAnnotationBase::$register_theme	public	property	Whether or not to register a theme function automatically.
ViewsRow::$base	public	property	The base tables on which this row plugin can be used.
ViewsRow::$display_types	public	property	The types of the display this plugin can be used with.
ViewsRow::$help	public	property	A short help string; this is displayed in the views UI.
ViewsRow::$id	public	property	The plugin ID.
ViewsRow::$no_ui	public	property	Whether the plugin should be not selectable in the UI.
ViewsRow::$short_title	public	property	(optional) The short title used in the views UI.
ViewsRow::$theme	public	property	The theme function used to render the row output.
ViewsRow::$title	public	property	The plugin title used in the views UI.