abstract class ViewsPluginAnnotationBase in Zircon Profile 8

Defines an abstract base class for all views plugin annotations.

Hierarchy

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

File

core/modules/views/src/Annotation/ViewsPluginAnnotationBase.php, line 16

Contains \Drupal\views\Annotation\ViewsPluginAnnotationBase.

Namespace

Drupal\views\Annotation

abstract class ViewsPluginAnnotationBase extends Plugin implements AnnotationInterface {

  /**
   * A class to make the plugin derivative aware.
   *
   * @var string
   *
   * @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator
   */
  public $derivative;

  /**
   * Whether or not to register a theme function automatically.
   *
   * @var bool (optional)
   */
  public $register_theme = TRUE;

}

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	2
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.	1
ViewsPluginAnnotationBase::$derivative	public	property	A class to make the plugin derivative aware.
ViewsPluginAnnotationBase::$register_theme	public	property	Whether or not to register a theme function automatically.