comparison core/modules/views/src/Annotation/ViewsExposedForm.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4c8ae668cc8c
1 <?php
2
3 namespace Drupal\views\Annotation;
4
5 /**
6 * Defines a Plugin annotation object for views exposed form plugins.
7 *
8 * @see \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface
9 * @see \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginBase
10 *
11 * @ingroup views_exposed_form_plugins
12 *
13 * @Annotation
14 */
15 class ViewsExposedForm extends ViewsPluginAnnotationBase {
16
17 /**
18 * The plugin ID.
19 *
20 * @var string
21 */
22 public $id;
23
24 /**
25 * The plugin title used in the views UI.
26 *
27 * @var \Drupal\Core\Annotation\Translation
28 *
29 * @ingroup plugin_translatable
30 */
31 public $title = '';
32
33 /**
34 * (optional) The short title used in the views UI.
35 *
36 * @var \Drupal\Core\Annotation\Translation
37 *
38 * @ingroup plugin_translatable
39 */
40 public $short_title = '';
41
42 /**
43 * A short help string; this is displayed in the views UI.
44 *
45 * @var \Drupal\Core\Annotation\Translation
46 *
47 * @ingroup plugin_translatable
48 */
49 public $help = '';
50
51 /**
52 * The types of the display this plugin can be used with.
53 *
54 * For example the Feed display defines the type 'feed', so only rss style
55 * and row plugins can be used in the views UI.
56 *
57 * @var array
58 */
59 public $display_types;
60
61 /**
62 * The base tables on which this exposed form plugin can be used.
63 *
64 * If no base table is specified the plugin can be used with all tables.
65 *
66 * @var array
67 */
68 public $base;
69
70 /**
71 * Whether the plugin should be not selectable in the UI.
72 *
73 * If it's set to TRUE, you can still use it via the API in config files.
74 *
75 * @var bool
76 */
77 public $no_ui;
78
79 }