class ViewsBuilder in Views Templates 8

Defines a ViewsBuilder annotation object.

@todo For some reason this not getting picked up by the manager.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\views_templates\Annotation\ViewsBuilder

2 classes are annotated with ViewsBuilder

NodeViewBuilder in tests/modules/views_templates_builder_test/src/Plugin/ViewsTemplateBuilder/NodeViewBuilder.php

Test comment.

ViewDuplicatorTest in tests/modules/views_templates_builder_test/src/Plugin/ViewsTemplateBuilder/ViewDuplicatorTest.php

The ViewsBuilder.

File

src/Annotation/ViewsBuilder.php, line 14

Namespace

Drupal\views_templates\Annotation

class ViewsBuilder extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * Description for list page.
   *
   * @var string
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * The administrative label of the View Builder.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $admin_label = '';

  /**
   * Class used to retrieve derivative definitions of the Views Builder.
   *
   * @var string
   */
  public $derivative = '';

  /**
   * Base table of View.
   *
   * @var string
   */
  public $base_table;

  /**
   * The module that provides the template.
   *
   * @var string
   */
  public $module;

  /**
   * Keys and values to replaced in the Views Template.
   *
   * @var array
   */
  public $replace_values;

  /**
   * Id of Views template.
   *
   * @var string
   */
  public $view_template_id;

}

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
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
ViewsBuilder::$admin_label	public	property	The administrative label of the View Builder.
ViewsBuilder::$base_table	public	property	Base table of View.
ViewsBuilder::$derivative	public	property	Class used to retrieve derivative definitions of the Views Builder.
ViewsBuilder::$description	public	property	Description for list page.
ViewsBuilder::$id	public	property	The plugin ID.
ViewsBuilder::$module	public	property	The module that provides the template.
ViewsBuilder::$replace_values	public	property	Keys and values to replaced in the Views Template.
ViewsBuilder::$view_template_id	public	property	Id of Views template.