aleph1.co.uk Git - yaffs-website/blob - web/core/modules/help/src/Annotation/HelpSection.php

   1 <?php
   2
   3 namespace Drupal\help\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines a Plugin annotation object for help page section plugins.
   9  *
  10  * Plugin Namespace: Plugin\HelpSection
  11  *
  12  * For a working example, see \Drupal\help\Plugin\HelpSection\HookHelpSection.
  13  *
  14  * @see \Drupal\help\HelpSectionPluginInterface
  15  * @see \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
  16  * @see \Drupal\help\HelpSectionManager
  17  * @see hook_help_section_info_alter()
  18  * @see plugin_api
  19  *
  20  * @Annotation
  21  */
  22 class HelpSection extends Plugin {
  23
  24   /**
  25    * The plugin ID.
  26    *
  27    * @var string
  28    */
  29   public $id;
  30
  31   /**
  32    * The text to use as the title of the help page section.
  33    *
  34    * @var \Drupal\Core\Annotation\Translation
  35    *
  36    * @ingroup plugin_translatable
  37    */
  38   public $title;
  39
  40   /**
  41    * The description of the help page section.
  42    *
  43    * @var \Drupal\Core\Annotation\Translation
  44    *
  45    * @ingroup plugin_translatable
  46    */
  47   public $description;
  48
  49   /**
  50    * The (optional) permission needed to view the help section.
  51    *
  52    * Only set if this section needs its own permission, beyond the generic
  53    * 'access administration pages' permission needed to see the /admin/help
  54    * page itself.
  55    *
  56    * @var string
  57    */
  58   public $permission = '';
  59
  60 }