ContentModerationState.php
Same filename in this branch
Same filename in other branches
- 9 core/modules/content_moderation/src/ContentModerationState.php
- 9 core/modules/content_moderation/src/Entity/ContentModerationState.php
- 10 core/modules/content_moderation/src/ContentModerationState.php
- 10 core/modules/content_moderation/src/Entity/ContentModerationState.php
- 11.x core/modules/content_moderation/src/ContentModerationState.php
- 11.x core/modules/content_moderation/src/Entity/ContentModerationState.php
Namespace
Drupal\content_moderationFile
-
core/
modules/ content_moderation/ src/ ContentModerationState.php
View source
<?php
namespace Drupal\content_moderation;
use Drupal\workflows\StateInterface;
/**
* A value object representing a workflow state for content moderation.
*/
class ContentModerationState implements StateInterface {
/**
* The vanilla state object from the Workflow module.
*
* @var \Drupal\workflows\StateInterface
*/
protected $state;
/**
* If entities should be published if in this state.
*
* @var bool
*/
protected $published;
/**
* If entities should be the default revision if in this state.
*
* @var bool
*/
protected $defaultRevision;
/**
* ContentModerationState constructor.
*
* Decorates state objects to add methods to determine if an entity should be
* published or made the default revision.
*
* @param \Drupal\workflows\StateInterface $state
* The vanilla state object from the Workflow module.
* @param bool $published
* (optional) TRUE if entities should be published if in this state, FALSE
* if not. Defaults to FALSE.
* @param bool $default_revision
* (optional) TRUE if entities should be the default revision if in this
* state, FALSE if not. Defaults to FALSE.
*/
public function __construct(StateInterface $state, $published = FALSE, $default_revision = FALSE) {
$this->state = $state;
$this->published = $published;
$this->defaultRevision = $default_revision;
}
/**
* Determines if entities should be published if in this state.
*
* @return bool
*/
public function isPublishedState() {
return $this->published;
}
/**
* Determines if entities should be the default revision if in this state.
*
* @return bool
*/
public function isDefaultRevisionState() {
return $this->defaultRevision;
}
/**
* {@inheritdoc}
*/
public function id() {
return $this->state
->id();
}
/**
* {@inheritdoc}
*/
public function label() {
return $this->state
->label();
}
/**
* {@inheritdoc}
*/
public function weight() {
return $this->state
->weight();
}
/**
* {@inheritdoc}
*/
public function canTransitionTo($to_state_id) {
return $this->state
->canTransitionTo($to_state_id);
}
/**
* {@inheritdoc}
*/
public function getTransitionTo($to_state_id) {
return $this->state
->getTransitionTo($to_state_id);
}
/**
* {@inheritdoc}
*/
public function getTransitions() {
return $this->state
->getTransitions();
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
ContentModerationState | A value object representing a workflow state for content moderation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.