Mercurial > hg > isophonics-drupal-site
annotate core/modules/views/src/Annotation/ViewsExposedForm.php @ 19:fa3358dc1485 tip
Add ndrum files
| author | Chris Cannam |
|---|---|
| date | Wed, 28 Aug 2019 13:14:47 +0100 |
| parents | 4c8ae668cc8c |
| children |
| rev | line source |
|---|---|
| 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 exposed form plugins. |
| Chris@0 | 7 * |
| Chris@0 | 8 * @see \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface |
| Chris@0 | 9 * @see \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginBase |
| Chris@0 | 10 * |
| Chris@0 | 11 * @ingroup views_exposed_form_plugins |
| Chris@0 | 12 * |
| Chris@0 | 13 * @Annotation |
| Chris@0 | 14 */ |
| Chris@0 | 15 class ViewsExposedForm extends ViewsPluginAnnotationBase { |
| Chris@0 | 16 |
| Chris@0 | 17 /** |
| Chris@0 | 18 * The plugin ID. |
| Chris@0 | 19 * |
| Chris@0 | 20 * @var string |
| Chris@0 | 21 */ |
| Chris@0 | 22 public $id; |
| Chris@0 | 23 |
| Chris@0 | 24 /** |
| Chris@0 | 25 * The plugin title used in the views UI. |
| Chris@0 | 26 * |
| Chris@0 | 27 * @var \Drupal\Core\Annotation\Translation |
| Chris@0 | 28 * |
| Chris@0 | 29 * @ingroup plugin_translatable |
| Chris@0 | 30 */ |
| Chris@0 | 31 public $title = ''; |
| Chris@0 | 32 |
| Chris@0 | 33 /** |
| Chris@0 | 34 * (optional) The short title used in the views UI. |
| Chris@0 | 35 * |
| Chris@0 | 36 * @var \Drupal\Core\Annotation\Translation |
| Chris@0 | 37 * |
| Chris@0 | 38 * @ingroup plugin_translatable |
| Chris@0 | 39 */ |
| Chris@0 | 40 public $short_title = ''; |
| Chris@0 | 41 |
| Chris@0 | 42 /** |
| Chris@0 | 43 * A short help string; this is displayed in the views UI. |
| Chris@0 | 44 * |
| Chris@0 | 45 * @var \Drupal\Core\Annotation\Translation |
| Chris@0 | 46 * |
| Chris@0 | 47 * @ingroup plugin_translatable |
| Chris@0 | 48 */ |
| Chris@0 | 49 public $help = ''; |
| Chris@0 | 50 |
| Chris@0 | 51 /** |
| Chris@0 | 52 * The types of the display this plugin can be used with. |
| Chris@0 | 53 * |
| Chris@0 | 54 * For example the Feed display defines the type 'feed', so only rss style |
| Chris@0 | 55 * and row plugins can be used in the views UI. |
| Chris@0 | 56 * |
| Chris@0 | 57 * @var array |
| Chris@0 | 58 */ |
| Chris@0 | 59 public $display_types; |
| Chris@0 | 60 |
| Chris@0 | 61 /** |
| Chris@0 | 62 * The base tables on which this exposed form plugin can be used. |
| Chris@0 | 63 * |
| Chris@0 | 64 * If no base table is specified the plugin can be used with all tables. |
| Chris@0 | 65 * |
| Chris@0 | 66 * @var array |
| Chris@0 | 67 */ |
| Chris@0 | 68 public $base; |
| Chris@0 | 69 |
| Chris@0 | 70 /** |
| Chris@0 | 71 * Whether the plugin should be not selectable in the UI. |
| Chris@0 | 72 * |
| Chris@0 | 73 * If it's set to TRUE, you can still use it via the API in config files. |
| Chris@0 | 74 * |
| Chris@0 | 75 * @var bool |
| Chris@0 | 76 */ |
| Chris@0 | 77 public $no_ui; |
| Chris@0 | 78 |
| Chris@0 | 79 } |