Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\content_moderation;
Chris@0: 
Chris@0: use Drupal\workflows\StateInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * A value object representing a workflow state for content moderation.
Chris@0:  */
Chris@0: class ContentModerationState implements StateInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The vanilla state object from the Workflow module.
Chris@0:    *
Chris@0:    * @var \Drupal\workflows\StateInterface
Chris@0:    */
Chris@0:   protected $state;
Chris@0: 
Chris@0:   /**
Chris@0:    * If entities should be published if in this state.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $published;
Chris@0: 
Chris@0:   /**
Chris@0:    * If entities should be the default revision if in this state.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $defaultRevision;
Chris@0: 
Chris@0:   /**
Chris@0:    * ContentModerationState constructor.
Chris@0:    *
Chris@0:    * Decorates state objects to add methods to determine if an entity should be
Chris@0:    * published or made the default revision.
Chris@0:    *
Chris@0:    * @param \Drupal\workflows\StateInterface $state
Chris@0:    *   The vanilla state object from the Workflow module.
Chris@0:    * @param bool $published
Chris@0:    *   (optional) TRUE if entities should be published if in this state, FALSE
Chris@0:    *   if not. Defaults to FALSE.
Chris@0:    * @param bool $default_revision
Chris@0:    *   (optional) TRUE if entities should be the default revision if in this
Chris@0:    *   state, FALSE if not. Defaults to FALSE.
Chris@0:    */
Chris@0:   public function __construct(StateInterface $state, $published = FALSE, $default_revision = FALSE) {
Chris@0:     $this->state = $state;
Chris@0:     $this->published = $published;
Chris@0:     $this->defaultRevision = $default_revision;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines if entities should be published if in this state.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    */
Chris@0:   public function isPublishedState() {
Chris@0:     return $this->published;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines if entities should be the default revision if in this state.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    */
Chris@0:   public function isDefaultRevisionState() {
Chris@0:     return $this->defaultRevision;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function id() {
Chris@0:     return $this->state->id();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function label() {
Chris@0:     return $this->state->label();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function weight() {
Chris@0:     return $this->state->weight();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function canTransitionTo($to_state_id) {
Chris@0:     return $this->state->canTransitionTo($to_state_id);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTransitionTo($to_state_id) {
Chris@0:     return $this->state->getTransitionTo($to_state_id);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTransitions() {
Chris@0:     return $this->state->getTransitions();
Chris@0:   }
Chris@0: 
Chris@0: }