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 workflow system is currently experimental and should only be leveraged
  10  *   by experimental modules and development releases of contributed modules.
  11  */
  12 interface TransitionInterface {
  13
  14   /**
  15    * Gets the transition's ID.
  16    *
  17    * @return string
  18    *   The transition's ID.
  19    */
  20   public function id();
  21
  22   /**
  23    * Gets the transition's label.
  24    *
  25    * @return string
  26    *   The transition's label.
  27    */
  28   public function label();
  29
  30   /**
  31    * Gets the transition's from states.
  32    *
  33    * @return \Drupal\workflows\StateInterface[]
  34    *   The transition's from states.
  35    */
  36   public function from();
  37
  38   /**
  39    * Gets the transition's to state.
  40    *
  41    * @return \Drupal\workflows\StateInterface
  42    *   The transition's to state.
  43    */
  44   public function to();
  45
  46   /**
  47    * Gets the transition's weight.
  48    *
  49    * @return string
  50    *   The transition's weight.
  51    */
  52   public function weight();
  53
  54 }