class ViewsWizard in Drupal 9

Defines a Plugin annotation object for views wizard plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\views\Annotation\ViewsPluginAnnotationBase
    • 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.

11 classes are annotated with ViewsWizard

BlockContent in core/modules/block_content/src/Plugin/views/wizard/BlockContent.php

Used for creating 'block_content' views with the wizard.

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.

Media in core/modules/media/src/Plugin/views/wizard/Media.php

Provides Views creation wizard for Media.

MediaRevision in core/modules/media/src/Plugin/views/wizard/MediaRevision.php

Provides Views creation wizard for Media revisions.

... See full list

File

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

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	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.
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.