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

   1 <?php
   2
   3 namespace Drupal\workflows;
   4
   5 /**
   6  * A transition value object that describes the transition between two states.
   7  *
   8  * @internal
   9  *   The TransitionInterface should only be used by Workflows and Content
  10  *   Moderation.
  11  *
  12  * @todo Revisit the need for this in https://www.drupal.org/node/2902309.
  13  */
  14 interface TransitionInterface {
  15
  16   /**
  17    * The key of the transition plugin form.
  18    */
  19   const PLUGIN_FORM_KEY = 'transition';
  20
  21   /**
  22    * Gets the transition's ID.
  23    *
  24    * @return string
  25    *   The transition's ID.
  26    */
  27   public function id();
  28
  29   /**
  30    * Gets the transition's label.
  31    *
  32    * @return string
  33    *   The transition's label.
  34    */
  35   public function label();
  36
  37   /**
  38    * Gets the transition's from states.
  39    *
  40    * @return \Drupal\workflows\StateInterface[]
  41    *   The transition's from states.
  42    */
  43   public function from();
  44
  45   /**
  46    * Gets the transition's to state.
  47    *
  48    * @return \Drupal\workflows\StateInterface
  49    *   The transition's to state.
  50    */
  51   public function to();
  52
  53   /**
  54    * Gets the transition's weight.
  55    *
  56    * @return string
  57    *   The transition's weight.
  58    */
  59   public function weight();
  60
  61 }