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

Namespace

Drupal\views\Annotation

File

core/modules/views/src/Annotation/ViewsPager.php
View source
  1. <?php
  2. namespace Drupal\views\Annotation;
  3. /**
  4. * Defines a Plugin annotation object for views pager plugins.
  5. *
  6. * @see \Drupal\views\Plugin\views\pager\PagerPluginBase
  7. *
  8. * @ingroup views_pager_plugins
  9. *
  10. * @Annotation
  11. */
  12. class ViewsPager extends ViewsPluginAnnotationBase {
  13. /**
  14. * The plugin ID.
  15. *
  16. * @var string
  17. */
  18. public $id;
  19. /**
  20. * The plugin title used in the views UI.
  21. *
  22. * @var \Drupal\Core\Annotation\Translation
  23. *
  24. * @ingroup plugin_translatable
  25. */
  26. public $title = '';
  27. /**
  28. * (optional) The short title used in the views UI.
  29. *
  30. * @var \Drupal\Core\Annotation\Translation
  31. *
  32. * @ingroup plugin_translatable
  33. */
  34. public $short_title = '';
  35. /**
  36. * A short help string; this is displayed in the views UI.
  37. *
  38. * @var \Drupal\Core\Annotation\Translation
  39. *
  40. * @ingroup plugin_translatable
  41. */
  42. public $help = '';
  43. /**
  44. * The theme function used to render the pager's output.
  45. *
  46. * @return string
  47. */
  48. public $theme;
  49. /**
  50. * The types of the display this plugin can be used with.
  51. *
  52. * For example the Feed display defines the type 'feed', so only rss style
  53. * and row plugins can be used in the views UI.
  54. *
  55. * @var array
  56. */
  57. public $display_types;
  58. /**
  59. * The base tables on which this pager plugin can be used.
  60. *
  61. * If no base table is specified the plugin can be used with all tables.
  62. *
  63. * @var array
  64. */
  65. public $base;
  66. /**
  67. * Whether the plugin should be not selectable in the UI.
  68. *
  69. * If it's set to TRUE, you can still use it via the API in config files.
  70. *
  71. * @var bool
  72. */
  73. public $no_ui;
  74. }

Classes

Namesort descending Description
ViewsPager Defines a Plugin annotation object for views pager plugins.