class ViewsExposedForm
Same name in this branch
- 11.x core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
- 11.x core/modules/views/src/Attribute/ViewsExposedForm.php \Drupal\views\Attribute\ViewsExposedForm
Same name in other branches
- 9 core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
- 9 core/modules/views/src/Annotation/ViewsExposedForm.php \Drupal\views\Annotation\ViewsExposedForm
- 8.9.x core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
- 8.9.x core/modules/views/src/Annotation/ViewsExposedForm.php \Drupal\views\Annotation\ViewsExposedForm
- 10 core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
- 10 core/modules/views/src/Annotation/ViewsExposedForm.php \Drupal\views\Annotation\ViewsExposedForm
- 10 core/modules/views/src/Attribute/ViewsExposedForm.php \Drupal\views\Attribute\ViewsExposedForm
Defines a Plugin annotation object for views exposed form 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\ViewsExposedForm extends \Drupal\views\Annotation\ViewsPluginAnnotationBase
- class \Drupal\views\Annotation\ViewsPluginAnnotationBase extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of ViewsExposedForm
See also
\Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface
\Drupal\views\Plugin\views\exposed_form\ExposedFormPluginBase
Related topics
File
-
core/
modules/ views/ src/ Annotation/ ViewsExposedForm.php, line 15
Namespace
Drupal\views\AnnotationView source
class ViewsExposedForm 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 = '';
/**
* A short help string; this is displayed in the views UI.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $help = '';
/**
* The types of the display this plugin can be used with.
*
* For example the Feed display defines the type 'feed', so only rss style
* and row plugins can be used in the views UI.
*
* @var array
*/
public $display_types;
/**
* The base tables on which this exposed form plugin can be used.
*
* If no base table is specified the plugin can be used with all tables.
*
* @var array
*/
public $base;
/**
* Whether the plugin should be not selectable in the UI.
*
* If it's set to TRUE, you can still use it via the API in config files.
*
* @var bool
*/
public $no_ui;
}
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 | |
ViewsExposedForm::$base | public | property | The base tables on which this exposed form plugin can be used. | ||
ViewsExposedForm::$display_types | public | property | The types of the display this plugin can be used with. | ||
ViewsExposedForm::$help | public | property | A short help string; this is displayed in the views UI. | ||
ViewsExposedForm::$id | public | property | The plugin ID. | ||
ViewsExposedForm::$no_ui | public | property | Whether the plugin should be not selectable in the UI. | ||
ViewsExposedForm::$short_title | public | property | (optional) The short title used in the views UI. | ||
ViewsExposedForm::$title | public | property | The plugin title used in the views UI. | ||
ViewsPluginAnnotationBase::$register_theme | public | property | Whether or not to register a theme function automatically. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.