diff core/modules/views/src/Annotation/ViewsExposedForm.php @ 0:c75dbcec494b

Initial commit from drush-created site
author Chris Cannam
date Thu, 05 Jul 2018 14:24:15 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/modules/views/src/Annotation/ViewsExposedForm.php	Thu Jul 05 14:24:15 2018 +0000
@@ -0,0 +1,79 @@
+<?php
+
+namespace Drupal\views\Annotation;
+
+/**
+ * Defines a Plugin annotation object for views exposed form plugins.
+ *
+ * @see \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface
+ * @see \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginBase
+ *
+ * @ingroup views_exposed_form_plugins
+ *
+ * @Annotation
+ */
+class ViewsExposedForm 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 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 exposed form 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;
+
+}