1. 8.3.x core/modules/views/src/Annotation/ViewsQuery.php ViewsQuery
  2. 8.0.x core/modules/views/src/Annotation/ViewsQuery.php ViewsQuery
  3. 8.1.x core/modules/views/src/Annotation/ViewsQuery.php ViewsQuery
  4. 8.2.x core/modules/views/src/Annotation/ViewsQuery.php ViewsQuery
  5. 8.4.x core/modules/views/src/Annotation/ViewsQuery.php ViewsQuery

Defines a Plugin annotation object for views query plugins.

Hierarchy

Expanded class hierarchy of ViewsQuery

See also

\Drupal\views\Plugin\views\query\QueryPluginBase

Related topics

2 classes are annotated with ViewsQuery
QueryTest in core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php
Defines a query test plugin.
Sql in core/modules/views/src/Plugin/views/query/Sql.php
Views query plugin for an SQL query.

File

core/modules/views/src/Annotation/ViewsQuery.php, line 14

Namespace

Drupal\views\Annotation
View source
class ViewsQuery 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 = '';

  /**
   * 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

Contains filters are case sensitive
Namesort descending 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 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.
ViewsQuery::$help public property A short help string; this is displayed in the views UI.
ViewsQuery::$id public property The plugin ID.
ViewsQuery::$no_ui public property Whether the plugin should be not selectable in the UI.
ViewsQuery::$short_title public property (optional) The short title used in the views UI.
ViewsQuery::$title public property The plugin title used in the views UI.