class ViewsQuery

Same name and namespace in other branches
  1. 11.x core/modules/views/src/Attribute/ViewsQuery.php \Drupal\views\Attribute\ViewsQuery
  2. 11.x core/modules/views/src/Annotation/ViewsQuery.php \Drupal\views\Annotation\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;

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.