class ViewsWizard in Zircon Profile 8.0

Defines a Plugin annotation object for views wizard plugins.

Hierarchy

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

See also

\Drupal\views\Plugin\views\wizard\WizardPluginBase

\Drupal\views\Plugin\views\wizard\WizardInterface

Related topics

Annotations

Annotations for class discovery and metadata description.

Views wizard plugins

Plugins for Views wizards.

8 classes are annotated with ViewsWizard

Comment in core/modules/comment/src/Plugin/views/wizard/Comment.php

Tests creating comment views with the wizard.

File in core/modules/file/src/Plugin/views/wizard/File.php

Tests creating managed files views with the wizard.

Node in core/modules/node/src/Plugin/views/wizard/Node.php

Tests creating node views with the wizard.

NodeRevision in core/modules/node/src/Plugin/views/wizard/NodeRevision.php

Tests creating node revision views with the wizard.

Standard in core/modules/views/src/Plugin/views/wizard/Standard.php

Standard Views wizard plugin.

... See full list

File

core/modules/views/src/Annotation/ViewsWizard.php, line 20

Contains \Drupal\views\Annotation\ViewsWizard.

Namespace

Drupal\views\Annotation

class ViewsWizard 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 = '';

  /**
   * The base tables on which this wizard is used.
   *
   * @var array
   */
  public $base_table;

}

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.
ViewsWizard::$base_table	public	property	The base tables on which this wizard is used.
ViewsWizard::$id	public	property	The plugin ID.
ViewsWizard::$short_title	public	property	(optional) The short title used in the views UI.
ViewsWizard::$title	public	property	The plugin title used in the views UI.