annotate core/modules/help/src/Annotation/HelpSection.php @ 19:fa3358dc1485 tip

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