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