From d4b6b5004277f95d24714fa69d90900bdc622d86 Mon Sep 17 00:00:00 2001 From: babruix Date: Mon, 18 Mar 2013 19:12:47 +0100 Subject: [PATCH] Issue #1912650 by thsutton: Documented pager views pager plugin. --- .../views/Plugin/views/pager/PagerPluginBase.php | 27 ++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/core/modules/views/lib/Drupal/views/Plugin/views/pager/PagerPluginBase.php b/core/modules/views/lib/Drupal/views/Plugin/views/pager/PagerPluginBase.php index 1c877ff..20eba3f 100644 --- a/core/modules/views/lib/Drupal/views/Plugin/views/pager/PagerPluginBase.php +++ b/core/modules/views/lib/Drupal/views/Plugin/views/pager/PagerPluginBase.php @@ -21,6 +21,33 @@ /** * The base plugin to handle pager. + * + * Pager plugins take care of everything regarding pagers, including getting + * and setting the total number of items to render the pager, + * setting the global pager arrays. + * + * To define a pager type, extend this base class. The ViewsPluginManager (used to + * create views plugins objects) adds annotated discovery for pager plugins. Your + * pager plugin must have an annotation that includes the plugin's metadata, + * for example: + * @code + * @ Plugin( + * id = "demo_pager", + * title = @ Translation("Display a demonstration pager"), + * help = @ Translation("Demonstrate pagination of views items."), + * theme = "views_demo_pager" + * ) + * @endcode + * Remove spaces after @ in your plugin - these are needed only to pass tests. + * The definition uses the following keys: + * - id: The unique identifier of your pager plugin. + * - title: The "full" title for your pager type; used in the views UI. + * - short_title: (optional) The "short" title for your pager type; + * used in the views UI when specified. + * - help: (optional) A short help string; this is displayed in the views UI. + * - theme: The theme function used to render the pager's output. + * + * @see \Drupal\views\Plugin\ViewsPluginManager */ abstract class PagerPluginBase extends PluginBase { -- 1.7.12.4 (Apple Git-37)