aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Condition/Annotation/Condition.php

   1 <?php
   2
   3 namespace Drupal\Core\Condition\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines a condition plugin annotation object.
   9  *
  10  * Condition plugins provide generalized conditions for use in other
  11  * operations, such as conditional block placement.
  12  *
  13  * Plugin Namespace: Plugin\Condition
  14  *
  15  * For a working example, see \Drupal\user\Plugin\Condition\UserRole.
  16  *
  17  * @see \Drupal\Core\Condition\ConditionManager
  18  * @see \Drupal\Core\Condition\ConditionInterface
  19  * @see \Drupal\Core\Condition\ConditionPluginBase
  20  * @see block_api
  21  *
  22  * @ingroup plugin_api
  23  *
  24  * @Annotation
  25  */
  26 class Condition extends Plugin {
  27
  28   /**
  29    * The condition plugin ID.
  30    *
  31    * @var string
  32    */
  33   public $id;
  34
  35   /**
  36    * The human-readable name of the condition.
  37    *
  38    * @ingroup plugin_translatable
  39    *
  40    * @var \Drupal\Core\Annotation\Translation
  41    */
  42   public $label;
  43
  44   /**
  45    * The name of the module providing the type.
  46    *
  47    * @var string
  48    */
  49   public $module;
  50
  51   /**
  52    * An array of context definitions describing the context used by the plugin.
  53    *
  54    * The array is keyed by context names.
  55    *
  56    * @var \Drupal\Core\Annotation\ContextDefinition[]
  57    */
  58   public $context = [];
  59
  60   /**
  61    * The category under which the condition should listed in the UI.
  62    *
  63    * @var \Drupal\Core\Annotation\Translation
  64    *
  65    * @ingroup plugin_translatable
  66    */
  67   public $category;
  68
  69 }