Mercurial > hg > cmmr2012-drupal-site
diff core/modules/workflows/src/TransitionInterface.php @ 0:c75dbcec494b
Initial commit from drush-created site
author | Chris Cannam |
---|---|
date | Thu, 05 Jul 2018 14:24:15 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/modules/workflows/src/TransitionInterface.php Thu Jul 05 14:24:15 2018 +0000 @@ -0,0 +1,71 @@ +<?php + +namespace Drupal\workflows; + +/** + * A transition value object that describes the transition between two states. + * + * @internal + * The TransitionInterface should only be used by Workflows and Content + * Moderation. + * + * @todo Revisit the need for this in https://www.drupal.org/node/2902309. + */ +interface TransitionInterface { + + /** + * The key of the transition plugin form. + */ + const PLUGIN_FORM_KEY = 'transition'; + + /** + * The transition direction from. + */ + const DIRECTION_FROM = 'from'; + + /** + * The transition direction to. + */ + const DIRECTION_TO = 'to'; + + /** + * Gets the transition's ID. + * + * @return string + * The transition's ID. + */ + public function id(); + + /** + * Gets the transition's label. + * + * @return string + * The transition's label. + */ + public function label(); + + /** + * Gets the transition's from states. + * + * @return \Drupal\workflows\StateInterface[] + * The transition's from states. + */ + public function from(); + + /** + * Gets the transition's to state. + * + * @return \Drupal\workflows\StateInterface + * The transition's to state. + */ + public function to(); + + /** + * Gets the transition's weight. + * + * @return string + * The transition's weight. + */ + public function weight(); + +}