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\WorkflowManager
  16  * @see plugin_api
  17  *
  18  * @Annotation
  19  *
  20  * @internal
  21  *   The workflow system is currently experimental and should only be leveraged
  22  *   by experimental modules and development releases of contributed modules.
  23  */
  24 class WorkflowType extends Plugin {
  25
  26   /**
  27    * The plugin ID.
  28    *
  29    * @var string
  30    */
  31   public $id;
  32
  33   /**
  34    * The label of the workflow.
  35    *
  36    * Describes how the plugin is used to apply a workflow to something.
  37    *
  38    * @var \Drupal\Core\Annotation\Translation
  39    *
  40    * @ingroup plugin_translatable
  41    */
  42   public $label = '';
  43
  44   /**
  45    * States required to exist.
  46    *
  47    * Normally supplied by WorkflowType::defaultConfiguration().
  48    *
  49    * @var array
  50    */
  51   public $required_states = [];
  52
  53 }