Skip to content
Snippets Groups Projects
Verified Commit a15819d0 authored by Dave Long's avatar Dave Long
Browse files

Issue #3427572 by alexpott: Standard Views attribute documentation for consistency and correctness

parent 7e2b0d45
No related branches found
No related tags found
No related merge requests found
...@@ -36,6 +36,7 @@ class ViewsAccess extends Plugin { ...@@ -36,6 +36,7 @@ class ViewsAccess extends Plugin {
* @param bool $no_ui * @param bool $no_ui
* (optional) Whether the plugin should be not selectable in the UI. * (optional) Whether the plugin should be not selectable in the UI.
* If set to TRUE, you can still use it via the API in config files. * If set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param class-string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
......
...@@ -26,10 +26,12 @@ class ViewsArgumentValidator extends Plugin { ...@@ -26,10 +26,12 @@ class ViewsArgumentValidator extends Plugin {
* The plugin title used in the views UI. * The plugin title used in the views UI.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
* (optional) The short title used in the views UI. * (optional) The short title used in the views UI.
* @param string $entity_type * @param string|null $entity_type
* (optional) Entity type. * (optional) Entity type.
* @param bool $no_ui * @param bool $no_ui
* Whether the plugin is selectable in the UI. * (optional) Whether the plugin should be not selectable in the UI.
* If set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param class-string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
......
...@@ -31,11 +31,12 @@ class ViewsCache extends Plugin { ...@@ -31,11 +31,12 @@ class ViewsCache extends Plugin {
* For example the Feed display defines the type 'feed', so only rss style * For example the Feed display defines the type 'feed', so only rss style
* and row plugins can be used in the views UI. * and row plugins can be used in the views UI.
* @param string[] $base * @param string[] $base
* The base tables on which this cache plugin can be used. * (optional) The base tables on which this cache plugin can be used.
* If no base table is specified the plugin can be used with all tables. * If no base table is specified the plugin can be used with all tables.
* @param bool $no_ui * @param bool $no_ui
* Whether the plugin should be not selectable in the UI. * (optional) Whether the plugin should be not selectable in the UI.
* If set to TRUE, you can still use it via the API in config files. * If set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param class-string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
......
...@@ -25,9 +25,11 @@ class ViewsDisplayExtender extends Plugin { ...@@ -25,9 +25,11 @@ class ViewsDisplayExtender extends Plugin {
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
* (optional) The short title used in the views UI. * (optional) The short title used in the views UI.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
* A short help string; this is displayed in the views UI. * (optional) A short help string; this is displayed in the views UI.
* @param bool $no_ui * @param bool $no_ui
* Whether the plugin is selectable in the UI. * (optional) Whether the plugin should be not selectable in the UI.
* If set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param class-string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
......
...@@ -22,21 +22,22 @@ class ViewsQuery extends Plugin { ...@@ -22,21 +22,22 @@ class ViewsQuery extends Plugin {
* *
* @param string $id * @param string $id
* The plugin ID. * The plugin ID.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title * @param \Drupal\Core\StringTranslation\TranslatableMarkup $title
* The plugin title used in the views UI. * The plugin title used in the views UI.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
* (optional) The short title used in the views UI. * (optional) The short title used in the views UI.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
* A short help string; this is displayed in the views UI. * (optional) A short help string; this is displayed in the views UI.
* @param bool $no_ui * @param bool $no_ui
* Whether or not the plugin is selectable in the UI. If it's set to TRUE, * (optional) Whether the plugin should be not selectable in the UI.
* you can still use it via the API in config files. * If set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param class-string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
public function __construct( public function __construct(
public readonly string $id, public readonly string $id,
public readonly ?TranslatableMarkup $title = NULL, public readonly ?TranslatableMarkup $title,
public readonly ?TranslatableMarkup $short_title = NULL, public readonly ?TranslatableMarkup $short_title = NULL,
public readonly ?TranslatableMarkup $help = NULL, public readonly ?TranslatableMarkup $help = NULL,
public readonly bool $no_ui = FALSE, public readonly bool $no_ui = FALSE,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment