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

Defines a Plugin annotation object for views pager plugins.

Hierarchy

Expanded class hierarchy of ViewsPager

See also

\Drupal\views\Plugin\views\pager\PagerPluginBase

Related topics

4 classes are annotated with ViewsPager
Full in core/modules/views/src/Plugin/views/pager/Full.php
The plugin to handle full pager.
Mini in core/modules/views/src/Plugin/views/pager/Mini.php
The plugin to handle mini pager.
None in core/modules/views/src/Plugin/views/pager/None.php
Plugin for views without pagers.
Some in core/modules/views/src/Plugin/views/pager/Some.php
Plugin for views without pagers.

File

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

Namespace

Drupal\views\Annotation
View source
class ViewsPager 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 theme function used to render the pager's output.
   *
   * @return string
   */
  public $theme;

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

Contains filters are case sensitive
Namesort descending Modifiers Type Description
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
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
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.
ViewsPager::$base public property The base tables on which this pager plugin can be used.
ViewsPager::$display_types public property The types of the display this plugin can be used with.
ViewsPager::$help public property A short help string; this is displayed in the views UI.
ViewsPager::$id public property The plugin ID.
ViewsPager::$no_ui public property Whether the plugin should be not selectable in the UI.
ViewsPager::$short_title public property (optional) The short title used in the views UI.
ViewsPager::$theme public property The theme function used to render the pager's output.
ViewsPager::$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.