www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/workflows/src/Annotation/WorkflowType.php

   1 <?php
   2
   3 namespace Drupal\workflows\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines an Workflow type annotation object.
   9  *
  10  * Plugin Namespace: Plugin\WorkflowType
  11  *
  12  * For a working example, see \Drupal\content_moderation\Plugin\Workflow\ContentModerate
  13  *
  14  * @see \Drupal\workflows\WorkflowTypeInterface
  15  * @see \Drupal\workflows\WorkflowTypeManager
  16  * @see workflow_type_info_alter()
  17  * @see plugin_api
  18  *
  19  * @Annotation
  20  */
  21 class WorkflowType extends Plugin {
  22
  23   /**
  24    * The plugin ID.
  25    *
  26    * @var string
  27    */
  28   public $id;
  29
  30   /**
  31    * The label of the workflow.
  32    *
  33    * @var \Drupal\Core\Annotation\Translation
  34    *
  35    * @ingroup plugin_translatable
  36    */
  37   public $label = '';
  38
  39   /**
  40    * States required to exist.
  41    *
  42    * Normally supplied by WorkflowType::defaultConfiguration().
  43    *
  44    * @var array
  45    */
  46   public $required_states = [];
  47
  48   /**
  49    * A list of optional form classes implementing PluginFormInterface.
  50    *
  51    * Forms which will be used for the workflow UI are:
  52    * - 'configure' (\Drupal\workflows\WorkflowTypeInterface::PLUGIN_FORM_KEY)
  53    * - 'state' (\Drupal\workflows\StateInterface::PLUGIN_FORM_KEY)
  54    * - 'transition' (\Drupal\workflows\TransitionInterface::PLUGIN_FORM_KEY)
  55    *
  56    * @see \Drupal\Core\Plugin\PluginWithFormsInterface
  57    * @see \Drupal\Core\Plugin\PluginFormInterface
  58    * @see \Drupal\workflows\Plugin\WorkflowTypeConfigureFormBase
  59    * @see \Drupal\workflows\Plugin\WorkflowTypeStateFormBase
  60    * @see \Drupal\workflows\Plugin\WorkflowTypeTransitionFormBase
  61    * @see \Drupal\workflows\WorkflowTypeInterface::PLUGIN_FORM_KEY
  62    * @see \Drupal\workflows\StateInterface::PLUGIN_FORM_KEY
  63    * @see \Drupal\workflows\TransitionInterface::PLUGIN_FORM_KEY
  64    *
  65    * @var array
  66    */
  67   public $forms = [];
  68
  69 }