summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Pott2015-09-27 14:57:51 +0200
committerAlex Pott2015-09-27 14:57:51 +0200
commitf2c047c63947cfb87c8eae4016c7bda40758dcfe (patch)
treebd8c30b8c8a556c0e009a4475dd43e0a848c4164
parent125cda4be9474e02741ce28f9b0a823a6721ac1d (diff)
Issue #1912658 by joshi.rohit100, thsutton, mikebell_, zealfire, pjonckiere, dawehner: Document views access plugins
-rw-r--r--core/modules/views/src/Plugin/views/access/AccessPluginBase.php18
1 files changed, 18 insertions, 0 deletions
diff --git a/core/modules/views/src/Plugin/views/access/AccessPluginBase.php b/core/modules/views/src/Plugin/views/access/AccessPluginBase.php
index 57481fa..5891364 100644
--- a/core/modules/views/src/Plugin/views/access/AccessPluginBase.php
+++ b/core/modules/views/src/Plugin/views/access/AccessPluginBase.php
@@ -29,6 +29,24 @@ use Symfony\Component\Routing\Route;
/**
* The base plugin to handle access control.
+ *
+ * Access plugins are responsible for controlling a user's access to the view.
+ * Views includes plugins for checking user roles and individual permissions.
+ *
+ * To define an access control plugin, extend this base class. Your access
+ * plugin should have an annotation that includes the plugin's metadata, for
+ * example:
+ * @Plugin(
+ * id = "denyall",
+ * title = @Translation("No Access"),
+ * help = @Translation("Will not be accessible.")
+ * )
+ * The definition should include the following keys:
+ * - id: The unique identifier of your access plugin.
+ * - title: The human-readable name for your access plugin.
+ * - help: A short help message for your plugin.
+ *
+ * @see \Drupal\views\Plugin\ViewsPluginManager
*/
abstract class AccessPluginBase extends PluginBase {