ViewsQuery.php

Same filename in other branches
  1. 8.9.x core/modules/views/src/Annotation/ViewsQuery.php
  2. 10 core/modules/views/src/Annotation/ViewsQuery.php
  3. 11.x core/modules/views/src/Annotation/ViewsQuery.php
  4. 11.x core/modules/views/src/Attribute/ViewsQuery.php
  5. 10 core/modules/views/src/Attribute/ViewsQuery.php

Namespace

Drupal\views\Annotation

File

core/modules/views/src/Annotation/ViewsQuery.php

View source
<?php

namespace Drupal\views\Annotation;


/**
 * Defines a Plugin annotation object for views query plugins.
 *
 * @see \Drupal\views\Plugin\views\query\QueryPluginBase
 *
 * @ingroup views_query_plugins
 *
 * @Annotation
 */
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;

}

Classes

Title Deprecated Summary
ViewsQuery Defines a Plugin annotation object for views query plugins.

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