class ViewsWizard
Defines a Plugin annotation object for views wizard plugins.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase extends \Drupal\Component\Annotation\Plugin
- class \Drupal\views\Annotation\ViewsWizard extends \Drupal\views\Annotation\ViewsPluginAnnotationBase
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of ViewsWizard
See also
\Drupal\views\Plugin\views\wizard\WizardPluginBase
\Drupal\views\Plugin\views\wizard\WizardInterface
Related topics
File
-
core/
modules/ views/ src/ Annotation/ ViewsWizard.php, line 15
Namespace
Drupal\views\AnnotationView source
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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 6 |
| Plugin::getClass | public | function | Gets the class of the annotated class. | Overrides AnnotationInterface::getClass | 1 |
| 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 | 1 |
| 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. | 3 | |
| 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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.