Update core 8.3.0
This commit is contained in:
Rob Davies
parent
da7a7918f8
commit
cd7a898e66
6144 changed files with 132297 additions and 87747 deletions
|
|
@ -0,0 +1,51 @@
|
|||
workflows.workflow.*:
|
||||
type: config_entity
|
||||
label: 'Workflow'
|
||||
mapping:
|
||||
id:
|
||||
type: string
|
||||
label: 'ID'
|
||||
label:
|
||||
type: label
|
||||
label: 'Label'
|
||||
type:
|
||||
type: string
|
||||
label: 'Workflow type'
|
||||
type_settings:
|
||||
type: workflow.type_settings.[%parent.type]
|
||||
label: 'Custom settings for workflow type'
|
||||
states:
|
||||
type: sequence
|
||||
label: 'States'
|
||||
sequence:
|
||||
type: mapping
|
||||
label: 'State'
|
||||
mapping:
|
||||
label:
|
||||
type: label
|
||||
label: 'Label'
|
||||
weight:
|
||||
type: integer
|
||||
label: 'Weight'
|
||||
transitions:
|
||||
type: sequence
|
||||
label: 'Transitions'
|
||||
sequence:
|
||||
type: mapping
|
||||
label: 'Transition from state to state'
|
||||
mapping:
|
||||
label:
|
||||
type: label
|
||||
label: 'Transition label'
|
||||
from:
|
||||
type: sequence
|
||||
label: 'From state IDs'
|
||||
sequence:
|
||||
type: string
|
||||
label: 'From state ID'
|
||||
to:
|
||||
type: string
|
||||
label: 'To state ID'
|
||||
weight:
|
||||
type: integer
|
||||
label: 'Weight'
|
||||
53
web/core/modules/workflows/src/Annotation/WorkflowType.php
Normal file
53
web/core/modules/workflows/src/Annotation/WorkflowType.php
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Annotation;
|
||||
|
||||
use Drupal\Component\Annotation\Plugin;
|
||||
|
||||
/**
|
||||
* Defines an Workflow type annotation object.
|
||||
*
|
||||
* Plugin Namespace: Plugin\WorkflowType
|
||||
*
|
||||
* For a working example, see \Drupal\content_moderation\Plugin\Workflow\ContentModerate
|
||||
*
|
||||
* @see \Drupal\workflows\WorkflowTypeInterface
|
||||
* @see \Drupal\workflows\WorkflowManager
|
||||
* @see plugin_api
|
||||
*
|
||||
* @Annotation
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
class WorkflowType extends Plugin {
|
||||
|
||||
/**
|
||||
* The plugin ID.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $id;
|
||||
|
||||
/**
|
||||
* The label of the workflow.
|
||||
*
|
||||
* Describes how the plugin is used to apply a workflow to something.
|
||||
*
|
||||
* @var \Drupal\Core\Annotation\Translation
|
||||
*
|
||||
* @ingroup plugin_translatable
|
||||
*/
|
||||
public $label = '';
|
||||
|
||||
/**
|
||||
* States required to exist.
|
||||
*
|
||||
* Normally supplied by WorkflowType::defaultConfiguration().
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $required_states = [];
|
||||
|
||||
}
|
||||
533
web/core/modules/workflows/src/Entity/Workflow.php
Normal file
533
web/core/modules/workflows/src/Entity/Workflow.php
Normal file
|
|
@ -0,0 +1,533 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Entity;
|
||||
|
||||
use Drupal\Core\Config\Entity\ConfigEntityBase;
|
||||
use Drupal\Core\Entity\EntityStorageInterface;
|
||||
use Drupal\Core\Entity\EntityWithPluginCollectionInterface;
|
||||
use Drupal\Core\Plugin\DefaultSingleLazyPluginCollection;
|
||||
use Drupal\workflows\Exception\RequiredStateMissingException;
|
||||
use Drupal\workflows\State;
|
||||
use Drupal\workflows\Transition;
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
|
||||
/**
|
||||
* Defines the workflow entity.
|
||||
*
|
||||
* @ConfigEntityType(
|
||||
* id = "workflow",
|
||||
* label = @Translation("Workflow"),
|
||||
* label_collection = @Translation("Workflows"),
|
||||
* handlers = {
|
||||
* "access" = "Drupal\workflows\WorkflowAccessControlHandler",
|
||||
* "route_provider" = {
|
||||
* "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
|
||||
* },
|
||||
* },
|
||||
* config_prefix = "workflow",
|
||||
* entity_keys = {
|
||||
* "id" = "id",
|
||||
* "label" = "label",
|
||||
* "uuid" = "uuid",
|
||||
* },
|
||||
* config_export = {
|
||||
* "id",
|
||||
* "label",
|
||||
* "states",
|
||||
* "transitions",
|
||||
* "type",
|
||||
* "type_settings"
|
||||
* },
|
||||
* )
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
class Workflow extends ConfigEntityBase implements WorkflowInterface, EntityWithPluginCollectionInterface {
|
||||
|
||||
/**
|
||||
* The Workflow ID.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $id;
|
||||
|
||||
/**
|
||||
* The Moderation state label.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $label;
|
||||
|
||||
/**
|
||||
* The states of the workflow.
|
||||
*
|
||||
* The array key is the machine name for the state. The structure of each
|
||||
* array item is:
|
||||
* @code
|
||||
* label: {translatable label}
|
||||
* weight: {integer value}
|
||||
* @endcode
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $states = [];
|
||||
|
||||
/**
|
||||
* The permitted transitions of the workflow.
|
||||
*
|
||||
* The array key is the machine name for the transition. The machine name is
|
||||
* generated from the machine names of the states. The structure of each array
|
||||
* item is:
|
||||
* @code
|
||||
* from:
|
||||
* - {state machine name}
|
||||
* - {state machine name}
|
||||
* to: {state machine name}
|
||||
* label: {translatable label}
|
||||
* @endcode
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $transitions = [];
|
||||
|
||||
/**
|
||||
* The workflow type plugin ID.
|
||||
*
|
||||
* @see \Drupal\workflows\WorkflowTypeManager
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type;
|
||||
|
||||
/**
|
||||
* The configuration for the workflow type plugin.
|
||||
* @var array
|
||||
*/
|
||||
protected $type_settings = [];
|
||||
|
||||
/**
|
||||
* The workflow type plugin collection.
|
||||
*
|
||||
* @var \Drupal\Component\Plugin\LazyPluginCollection
|
||||
*/
|
||||
protected $pluginCollection;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function preSave(EntityStorageInterface $storage) {
|
||||
$workflow_type = $this->getTypePlugin();
|
||||
$missing_states = array_diff($workflow_type->getRequiredStates(), array_keys($this->getStates()));
|
||||
if (!empty($missing_states)) {
|
||||
throw new RequiredStateMissingException(sprintf("Workflow type '{$workflow_type->label()}' requires states with the ID '%s' in workflow '{$this->id()}'", implode("', '", $missing_states)));
|
||||
}
|
||||
parent::preSave($storage);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function addState($state_id, $label) {
|
||||
if (isset($this->states[$state_id])) {
|
||||
throw new \InvalidArgumentException("The state '$state_id' already exists in workflow '{$this->id()}'");
|
||||
}
|
||||
if (preg_match('/[^a-z0-9_]+/', $state_id)) {
|
||||
throw new \InvalidArgumentException("The state ID '$state_id' must contain only lowercase letters, numbers, and underscores");
|
||||
}
|
||||
$this->states[$state_id] = [
|
||||
'label' => $label,
|
||||
'weight' => $this->getNextWeight($this->states),
|
||||
];
|
||||
ksort($this->states);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function hasState($state_id) {
|
||||
return isset($this->states[$state_id]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getStates($state_ids = NULL) {
|
||||
if ($state_ids === NULL) {
|
||||
$state_ids = array_keys($this->states);
|
||||
}
|
||||
/** @var \Drupal\workflows\StateInterface[] $states */
|
||||
$states = array_combine($state_ids, array_map([$this, 'getState'], $state_ids));
|
||||
if (count($states) > 1) {
|
||||
// Sort states by weight and then label.
|
||||
$weights = $labels = [];
|
||||
foreach ($states as $id => $state) {
|
||||
$weights[$id] = $state->weight();
|
||||
$labels[$id] = $state->label();
|
||||
}
|
||||
array_multisort(
|
||||
$weights, SORT_NUMERIC, SORT_ASC,
|
||||
$labels, SORT_NATURAL, SORT_ASC
|
||||
);
|
||||
$states = array_replace($weights, $states);
|
||||
}
|
||||
return $states;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getState($state_id) {
|
||||
if (!isset($this->states[$state_id])) {
|
||||
throw new \InvalidArgumentException("The state '$state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
$state = new State(
|
||||
$this,
|
||||
$state_id,
|
||||
$this->states[$state_id]['label'],
|
||||
$this->states[$state_id]['weight']
|
||||
);
|
||||
return $this->getTypePlugin()->decorateState($state);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function setStateLabel($state_id, $label) {
|
||||
if (!isset($this->states[$state_id])) {
|
||||
throw new \InvalidArgumentException("The state '$state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
$this->states[$state_id]['label'] = $label;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function setStateWeight($state_id, $weight) {
|
||||
if (!isset($this->states[$state_id])) {
|
||||
throw new \InvalidArgumentException("The state '$state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
$this->states[$state_id]['weight'] = $weight;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function deleteState($state_id) {
|
||||
if (!isset($this->states[$state_id])) {
|
||||
throw new \InvalidArgumentException("The state '$state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
if (count($this->states) === 1) {
|
||||
throw new \InvalidArgumentException("The state '$state_id' can not be deleted from workflow '{$this->id()}' as it is the only state");
|
||||
}
|
||||
|
||||
foreach ($this->transitions as $transition_id => $transition) {
|
||||
$from_key = array_search($state_id, $transition['from'], TRUE);
|
||||
if ($from_key !== FALSE) {
|
||||
// Remove state from the from array.
|
||||
unset($transition['from'][$from_key]);
|
||||
}
|
||||
if (empty($transition['from']) || $transition['to'] === $state_id) {
|
||||
$this->deleteTransition($transition_id);
|
||||
}
|
||||
elseif ($from_key !== FALSE) {
|
||||
$this->setTransitionFromStates($transition_id, $transition['from']);
|
||||
}
|
||||
}
|
||||
unset($this->states[$state_id]);
|
||||
$this->getTypePlugin()->deleteState($state_id);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getInitialState() {
|
||||
$ordered_states = $this->getStates();
|
||||
return reset($ordered_states);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function addTransition($transition_id, $label, array $from_state_ids, $to_state_id) {
|
||||
if (isset($this->transitions[$transition_id])) {
|
||||
throw new \InvalidArgumentException("The transition '$transition_id' already exists in workflow '{$this->id()}'");
|
||||
}
|
||||
if (preg_match('/[^a-z0-9_]+/', $transition_id)) {
|
||||
throw new \InvalidArgumentException("The transition ID '$transition_id' must contain only lowercase letters, numbers, and underscores");
|
||||
}
|
||||
|
||||
if (!$this->hasState($to_state_id)) {
|
||||
throw new \InvalidArgumentException("The state '$to_state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
$this->transitions[$transition_id] = [
|
||||
'label' => $label,
|
||||
'from' => [],
|
||||
'to' => $to_state_id,
|
||||
// Always add to the end.
|
||||
'weight' => $this->getNextWeight($this->transitions),
|
||||
];
|
||||
|
||||
try {
|
||||
$this->setTransitionFromStates($transition_id, $from_state_ids);
|
||||
}
|
||||
catch (\InvalidArgumentException $e) {
|
||||
unset($this->transitions[$transition_id]);
|
||||
throw $e;
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getTransitions(array $transition_ids = NULL) {
|
||||
if ($transition_ids === NULL) {
|
||||
$transition_ids = array_keys($this->transitions);
|
||||
}
|
||||
/** @var \Drupal\workflows\TransitionInterface[] $transitions */
|
||||
$transitions = array_combine($transition_ids, array_map([$this, 'getTransition'], $transition_ids));
|
||||
if (count($transitions) > 1) {
|
||||
// Sort transitions by weights and then labels.
|
||||
$weights = $labels = [];
|
||||
foreach ($transitions as $id => $transition) {
|
||||
$weights[$id] = $transition->weight();
|
||||
$labels[$id] = $transition->label();
|
||||
}
|
||||
array_multisort(
|
||||
$weights, SORT_NUMERIC, SORT_ASC,
|
||||
$labels, SORT_NATURAL, SORT_ASC
|
||||
);
|
||||
$transitions = array_replace($weights, $transitions);
|
||||
}
|
||||
return $transitions;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getTransition($transition_id) {
|
||||
if (!isset($this->transitions[$transition_id])) {
|
||||
throw new \InvalidArgumentException("The transition '$transition_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
$transition = new Transition(
|
||||
$this,
|
||||
$transition_id,
|
||||
$this->transitions[$transition_id]['label'],
|
||||
$this->transitions[$transition_id]['from'],
|
||||
$this->transitions[$transition_id]['to'],
|
||||
$this->transitions[$transition_id]['weight']
|
||||
);
|
||||
return $this->getTypePlugin()->decorateTransition($transition);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function hasTransition($transition_id) {
|
||||
return isset($this->transitions[$transition_id]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getTransitionsForState($state_id, $direction = 'from') {
|
||||
$transition_ids = array_keys(array_filter($this->transitions, function ($transition) use ($state_id, $direction) {
|
||||
return in_array($state_id, (array) $transition[$direction], TRUE);
|
||||
}));
|
||||
return $this->getTransitions($transition_ids);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getTransitionFromStateToState($from_state_id, $to_state_id) {
|
||||
$transition_id = $this->getTransitionIdFromStateToState($from_state_id, $to_state_id);
|
||||
if (empty($transition_id)) {
|
||||
throw new \InvalidArgumentException("The transition from '$from_state_id' to '$to_state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
return $this->getTransition($transition_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function hasTransitionFromStateToState($from_state_id, $to_state_id) {
|
||||
return !empty($this->getTransitionIdFromStateToState($from_state_id, $to_state_id));
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the transition ID from state to state.
|
||||
*
|
||||
* @param string $from_state_id
|
||||
* The state ID to transition from.
|
||||
* @param string $to_state_id
|
||||
* The state ID to transition to.
|
||||
*
|
||||
* @return string|null
|
||||
* The transition ID, or NULL if no transition exists.
|
||||
*/
|
||||
protected function getTransitionIdFromStateToState($from_state_id, $to_state_id) {
|
||||
foreach ($this->transitions as $transition_id => $transition) {
|
||||
if (in_array($from_state_id, $transition['from'], TRUE) && $transition['to'] === $to_state_id) {
|
||||
return $transition_id;
|
||||
}
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function setTransitionLabel($transition_id, $label) {
|
||||
if (isset($this->transitions[$transition_id])) {
|
||||
$this->transitions[$transition_id]['label'] = $label;
|
||||
}
|
||||
else {
|
||||
throw new \InvalidArgumentException("The transition '$transition_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function setTransitionWeight($transition_id, $weight) {
|
||||
if (isset($this->transitions[$transition_id])) {
|
||||
$this->transitions[$transition_id]['weight'] = $weight;
|
||||
}
|
||||
else {
|
||||
throw new \InvalidArgumentException("The transition '$transition_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function setTransitionFromStates($transition_id, array $from_state_ids) {
|
||||
if (!isset($this->transitions[$transition_id])) {
|
||||
throw new \InvalidArgumentException("The transition '$transition_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
|
||||
// Ensure that the states exist.
|
||||
foreach ($from_state_ids as $from_state_id) {
|
||||
if (!$this->hasState($from_state_id)) {
|
||||
throw new \InvalidArgumentException("The state '$from_state_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
if ($this->hasTransitionFromStateToState($from_state_id, $this->transitions[$transition_id]['to'])) {
|
||||
$transition = $this->getTransitionFromStateToState($from_state_id, $this->transitions[$transition_id]['to']);
|
||||
if ($transition_id !== $transition->id()) {
|
||||
throw new \InvalidArgumentException("The '{$transition->id()}' transition already allows '$from_state_id' to '{$this->transitions[$transition_id]['to']}' transitions in workflow '{$this->id()}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Preserve the order of the state IDs in the from value and don't save any
|
||||
// keys.
|
||||
$from_state_ids = array_values($from_state_ids);
|
||||
sort($from_state_ids);
|
||||
$this->transitions[$transition_id]['from'] = $from_state_ids;
|
||||
ksort($this->transitions);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function deleteTransition($transition_id) {
|
||||
if (isset($this->transitions[$transition_id])) {
|
||||
unset($this->transitions[$transition_id]);
|
||||
$this->getTypePlugin()->deleteTransition($transition_id);
|
||||
}
|
||||
else {
|
||||
throw new \InvalidArgumentException("The transition '$transition_id' does not exist in workflow '{$this->id()}'");
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function getTypePlugin() {
|
||||
return $this->getPluginCollection()->get($this->type);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function getPluginCollections() {
|
||||
return ['type_settings' => $this->getPluginCollection()];
|
||||
}
|
||||
|
||||
/**
|
||||
* Encapsulates the creation of the workflow's plugin collection.
|
||||
*
|
||||
* @return \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
|
||||
* The workflow's plugin collection.
|
||||
*/
|
||||
protected function getPluginCollection() {
|
||||
if (!$this->pluginCollection && $this->type) {
|
||||
$this->pluginCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.workflows.type'), $this->type, $this->type_settings);
|
||||
}
|
||||
return $this->pluginCollection;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads all workflows of the provided type.
|
||||
*
|
||||
* @param string $type
|
||||
* The workflow type to load all workflows for.
|
||||
*
|
||||
* @return static[]
|
||||
* An array of workflow objects of the provided workflow type, indexed by
|
||||
* their IDs.
|
||||
*
|
||||
* @see \Drupal\workflows\Annotation\WorkflowType
|
||||
*/
|
||||
public static function loadMultipleByType($type) {
|
||||
return self::loadMultiple(\Drupal::entityQuery('workflow')->condition('type', $type)->execute());
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the weight for a new state or transition.
|
||||
*
|
||||
* @param array $items
|
||||
* An array of states or transitions information where each item has a
|
||||
* 'weight' key with a numeric value.
|
||||
*
|
||||
* @return int
|
||||
* The weight for a new item in the array so that it has the highest weight.
|
||||
*/
|
||||
protected function getNextWeight(array $items) {
|
||||
return array_reduce($items, function ($carry, $item) {
|
||||
return max($carry, $item['weight'] + 1);
|
||||
}, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function status() {
|
||||
// In order for a workflow to be usable it must have at least one state.
|
||||
return !empty($this->status) && !empty($this->states);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function onDependencyRemoval(array $dependencies) {
|
||||
$changed = $this->getTypePlugin()->onDependencyRemoval($dependencies);
|
||||
// Ensure the parent method is called in order to process dependencies that
|
||||
// affect third party settings.
|
||||
return parent::onDependencyRemoval($dependencies) || $changed;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Exception;
|
||||
|
||||
use Drupal\Core\Config\ConfigException;
|
||||
|
||||
/**
|
||||
* Indicates that a workflow does not contain a required state.
|
||||
*/
|
||||
class RequiredStateMissingException extends ConfigException {
|
||||
}
|
||||
118
web/core/modules/workflows/src/Form/WorkflowAddForm.php
Normal file
118
web/core/modules/workflows/src/Form/WorkflowAddForm.php
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\Component\Plugin\PluginManagerInterface;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\Core\Entity\EntityForm;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
|
||||
/**
|
||||
* Form for adding workflows.
|
||||
*/
|
||||
class WorkflowAddForm extends EntityForm {
|
||||
|
||||
/**
|
||||
* The workflow type plugin manager.
|
||||
*
|
||||
* @var \Drupal\Component\Plugin\PluginManagerInterface
|
||||
*/
|
||||
protected $workflowTypePluginManager;
|
||||
|
||||
/**
|
||||
* WorkflowAddForm constructor.
|
||||
*
|
||||
* @param \Drupal\Component\Plugin\PluginManagerInterface $workflow_type_plugin_manager
|
||||
* The workflow type plugin manager.
|
||||
*/
|
||||
public function __construct(PluginManagerInterface $workflow_type_plugin_manager) {
|
||||
$this->workflowTypePluginManager = $workflow_type_plugin_manager;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container) {
|
||||
return new static(
|
||||
$container->get('plugin.manager.workflows.type')
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function form(array $form, FormStateInterface $form_state) {
|
||||
$form = parent::form($form, $form_state);
|
||||
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$form['label'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Label'),
|
||||
'#maxlength' => 255,
|
||||
'#default_value' => $workflow->label(),
|
||||
'#description' => $this->t('Label for the Workflow.'),
|
||||
'#required' => TRUE,
|
||||
];
|
||||
|
||||
$form['id'] = [
|
||||
'#type' => 'machine_name',
|
||||
'#default_value' => $workflow->id(),
|
||||
'#machine_name' => [
|
||||
'exists' => [Workflow::class, 'load'],
|
||||
],
|
||||
];
|
||||
|
||||
$workflow_types = array_map(function ($plugin_definition) {
|
||||
return $plugin_definition['label'];
|
||||
}, $this->workflowTypePluginManager->getDefinitions());
|
||||
$form['workflow_type'] = [
|
||||
'#type' => 'select',
|
||||
'#title' => $this->t('Workflow type'),
|
||||
'#required' => TRUE,
|
||||
'#options' => $workflow_types,
|
||||
];
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function save(array $form, FormStateInterface $form_state) {
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
// Initialize the workflow using the selected type plugin.
|
||||
$workflow = $workflow->getTypePlugin()->initializeWorkflow($workflow);
|
||||
$return = $workflow->save();
|
||||
if (empty($workflow->getStates())) {
|
||||
drupal_set_message($this->t('Created the %label Workflow. In order for the workflow to be enabled there needs to be at least one state.', [
|
||||
'%label' => $workflow->label(),
|
||||
]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('add-state-form'));
|
||||
}
|
||||
else {
|
||||
drupal_set_message($this->t('Created the %label Workflow.', [
|
||||
'%label' => $workflow->label(),
|
||||
]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('edit-form'));
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
|
||||
// This form can only set the workflow's ID, label and the weights for each
|
||||
// state.
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$values = $form_state->getValues();
|
||||
$entity->set('label', $values['label']);
|
||||
$entity->set('id', $values['id']);
|
||||
$entity->set('type', $values['workflow_type']);
|
||||
}
|
||||
|
||||
}
|
||||
49
web/core/modules/workflows/src/Form/WorkflowDeleteForm.php
Normal file
49
web/core/modules/workflows/src/Form/WorkflowDeleteForm.php
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\Core\Entity\EntityConfirmFormBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Url;
|
||||
|
||||
/**
|
||||
* Builds the form to delete Workflow entities.
|
||||
*/
|
||||
class WorkflowDeleteForm extends EntityConfirmFormBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getQuestion() {
|
||||
return $this->t('Are you sure you want to delete %name?', ['%name' => $this->entity->label()]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCancelUrl() {
|
||||
return new Url('entity.workflow.collection');
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getConfirmText() {
|
||||
return $this->t('Delete');
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function submitForm(array &$form, FormStateInterface $form_state) {
|
||||
$this->entity->delete();
|
||||
|
||||
drupal_set_message($this->t(
|
||||
'Workflow %label deleted.',
|
||||
['%label' => $this->entity->label()]
|
||||
));
|
||||
|
||||
$form_state->setRedirectUrl($this->getCancelUrl());
|
||||
}
|
||||
|
||||
}
|
||||
215
web/core/modules/workflows/src/Form/WorkflowEditForm.php
Normal file
215
web/core/modules/workflows/src/Form/WorkflowEditForm.php
Normal file
|
|
@ -0,0 +1,215 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\workflows\State;
|
||||
use Drupal\Core\Entity\EntityForm;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Url;
|
||||
|
||||
/**
|
||||
* The form for editing workflows.
|
||||
*/
|
||||
class WorkflowEditForm extends EntityForm {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function form(array $form, FormStateInterface $form_state) {
|
||||
$form = parent::form($form, $form_state);
|
||||
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$form['label'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Label'),
|
||||
'#maxlength' => 255,
|
||||
'#default_value' => $workflow->label(),
|
||||
'#description' => $this->t('Label for the Workflow.'),
|
||||
'#required' => TRUE,
|
||||
];
|
||||
|
||||
$form['id'] = [
|
||||
'#type' => 'machine_name',
|
||||
'#default_value' => $workflow->id(),
|
||||
'#machine_name' => [
|
||||
'exists' => [Workflow::class, 'load'],
|
||||
],
|
||||
'#disabled' => TRUE,
|
||||
];
|
||||
|
||||
$header = [
|
||||
'state' => $this->t('State'),
|
||||
'weight' => $this->t('Weight'),
|
||||
'operations' => $this->t('Operations')
|
||||
];
|
||||
$form['states_container'] = [
|
||||
'#type' => 'details',
|
||||
'#title' => $this->t('States'),
|
||||
'#open' => TRUE,
|
||||
'#collapsible' => 'FALSE',
|
||||
];
|
||||
$form['states_container']['states'] = [
|
||||
'#type' => 'table',
|
||||
'#header' => $header,
|
||||
'#title' => $this->t('States'),
|
||||
'#empty' => $this->t('There are no states yet.'),
|
||||
'#tabledrag' => [
|
||||
[
|
||||
'action' => 'order',
|
||||
'relationship' => 'sibling',
|
||||
'group' => 'state-weight',
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
$states = $workflow->getStates();
|
||||
|
||||
// Warn the user if there are no states.
|
||||
if (empty($states)) {
|
||||
drupal_set_message(
|
||||
$this->t(
|
||||
'This workflow has no states and will be disabled until there is at least one, <a href=":add-state">add a new state.</a>',
|
||||
[':add-state' => $workflow->toUrl('add-state-form')->toString()]
|
||||
),
|
||||
'warning'
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($states as $state) {
|
||||
$links = [
|
||||
'edit' => [
|
||||
'title' => $this->t('Edit'),
|
||||
'url' => Url::fromRoute('entity.workflow.edit_state_form', ['workflow' => $workflow->id(), 'workflow_state' => $state->id()]),
|
||||
'attributes' => ['aria-label' => $this->t('Edit @state state', ['@state' => $state->label()])],
|
||||
]
|
||||
];
|
||||
if ($this->entity->access('delete-state:' . $state->id())) {
|
||||
$links['delete'] = [
|
||||
'title' => t('Delete'),
|
||||
'url' => Url::fromRoute('entity.workflow.delete_state_form', [
|
||||
'workflow' => $workflow->id(),
|
||||
'workflow_state' => $state->id()
|
||||
]),
|
||||
'attributes' => ['aria-label' => $this->t('Delete @state state', ['@state' => $state->label()])],
|
||||
];
|
||||
}
|
||||
$form['states_container']['states'][$state->id()] = [
|
||||
'#attributes' => ['class' => ['draggable']],
|
||||
'state' => ['#markup' => $state->label()],
|
||||
'#weight' => $state->weight(),
|
||||
'weight' => [
|
||||
'#type' => 'weight',
|
||||
'#title' => t('Weight for @title', ['@title' => $state->label()]),
|
||||
'#title_display' => 'invisible',
|
||||
'#default_value' => $state->weight(),
|
||||
'#attributes' => ['class' => ['state-weight']],
|
||||
],
|
||||
'operations' => [
|
||||
'#type' => 'operations',
|
||||
'#links' => $links,
|
||||
],
|
||||
];
|
||||
}
|
||||
$form['states_container']['state_add'] = [
|
||||
'#markup' => $workflow->toLink($this->t('Add a new state'), 'add-state-form')->toString(),
|
||||
];
|
||||
|
||||
$header = [
|
||||
'label' => $this->t('Label'),
|
||||
'weight' => $this->t('Weight'),
|
||||
'from' => $this->t('From'),
|
||||
'to' => $this->t('To'),
|
||||
'operations' => $this->t('Operations')
|
||||
];
|
||||
$form['transitions_container'] = [
|
||||
'#type' => 'details',
|
||||
'#title' => $this->t('Transitions'),
|
||||
'#open' => TRUE,
|
||||
];
|
||||
$form['transitions_container']['transitions'] = [
|
||||
'#type' => 'table',
|
||||
'#header' => $header,
|
||||
'#title' => $this->t('Transitions'),
|
||||
'#empty' => $this->t('There are no transitions yet.'),
|
||||
'#tabledrag' => [
|
||||
[
|
||||
'action' => 'order',
|
||||
'relationship' => 'sibling',
|
||||
'group' => 'transition-weight',
|
||||
],
|
||||
],
|
||||
];
|
||||
foreach ($workflow->getTransitions() as $transition) {
|
||||
$links['edit'] = [
|
||||
'title' => $this->t('Edit'),
|
||||
'url' => Url::fromRoute('entity.workflow.edit_transition_form', ['workflow' => $workflow->id(), 'workflow_transition' => $transition->id()]),
|
||||
'attributes' => ['aria-label' => $this->t('Edit \'@transition\' transition', ['@transition' => $transition->label()])],
|
||||
];
|
||||
$links['delete'] = [
|
||||
'title' => t('Delete'),
|
||||
'url' => Url::fromRoute('entity.workflow.delete_transition_form', ['workflow' => $workflow->id(), 'workflow_transition' => $transition->id()]),
|
||||
'attributes' => ['aria-label' => $this->t('Delete \'@transition\' transition', ['@transition' => $transition->label()])],
|
||||
];
|
||||
$form['transitions_container']['transitions'][$transition->id()] = [
|
||||
'#attributes' => ['class' => ['draggable']],
|
||||
'label' => ['#markup' => $transition->label()],
|
||||
'#weight' => $transition->weight(),
|
||||
'weight' => [
|
||||
'#type' => 'weight',
|
||||
'#title' => t('Weight for @title', ['@title' => $transition->label()]),
|
||||
'#title_display' => 'invisible',
|
||||
'#default_value' => $transition->weight(),
|
||||
'#attributes' => ['class' => ['transition-weight']],
|
||||
],
|
||||
'from' => [
|
||||
'#theme' => 'item_list',
|
||||
'#items' => array_map([State::class, 'labelCallback'], $transition->from()),
|
||||
'#context' => ['list_style' => 'comma-list'],
|
||||
],
|
||||
'to' => ['#markup' => $transition->to()->label()],
|
||||
'operations' => [
|
||||
'#type' => 'operations',
|
||||
'#links' => $links,
|
||||
],
|
||||
];
|
||||
}
|
||||
$form['transitions_container']['transition_add'] = [
|
||||
'#markup' => $workflow->toLink($this->t('Add a new transition'), 'add-transition-form')->toString(),
|
||||
];
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function save(array $form, FormStateInterface $form_state) {
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$workflow->save();
|
||||
drupal_set_message($this->t('Saved the %label Workflow.', ['%label' => $workflow->label()]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('collection'));
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
|
||||
// This form can only set the workflow's ID, label and the weights for each
|
||||
// state.
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$values = $form_state->getValues();
|
||||
$entity->set('label', $values['label']);
|
||||
$entity->set('id', $values['id']);
|
||||
foreach ($values['states'] as $state_id => $state_values) {
|
||||
$entity->setStateWeight($state_id, $state_values['weight']);
|
||||
}
|
||||
foreach ($values['transitions'] as $transition_id => $transition_values) {
|
||||
$entity->setTransitionWeight($transition_id, $transition_values['weight']);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
122
web/core/modules/workflows/src/Form/WorkflowStateAddForm.php
Normal file
122
web/core/modules/workflows/src/Form/WorkflowStateAddForm.php
Normal file
|
|
@ -0,0 +1,122 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\Core\Entity\EntityForm;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
|
||||
/**
|
||||
* Class WorkflowStateAddForm.
|
||||
*/
|
||||
class WorkflowStateAddForm extends EntityForm {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_state_add_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function form(array $form, FormStateInterface $form_state) {
|
||||
$form = parent::form($form, $form_state);
|
||||
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->getEntity();
|
||||
$form['label'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Label'),
|
||||
'#maxlength' => 255,
|
||||
'#default_value' => '',
|
||||
'#description' => $this->t('Label for the state.'),
|
||||
'#required' => TRUE,
|
||||
];
|
||||
|
||||
$form['id'] = [
|
||||
'#type' => 'machine_name',
|
||||
'#machine_name' => [
|
||||
'exists' => [$this, 'exists'],
|
||||
],
|
||||
];
|
||||
|
||||
// Add additional form fields from the workflow type plugin.
|
||||
$form['type_settings'] = [
|
||||
$workflow->get('type') => $workflow->getTypePlugin()->buildStateConfigurationForm($form_state, $workflow),
|
||||
'#tree' => TRUE,
|
||||
];
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the workflow state already exists.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The workflow state ID.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the workflow state exists, FALSE otherwise.
|
||||
*/
|
||||
public function exists($state_id) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $original_workflow */
|
||||
$original_workflow = \Drupal::entityTypeManager()->getStorage('workflow')->loadUnchanged($this->getEntity()->id());
|
||||
return $original_workflow->hasState($state_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies top-level form values to entity properties
|
||||
*
|
||||
* This form can only change values for a state, which is part of workflow.
|
||||
*
|
||||
* @param \Drupal\Core\Entity\EntityInterface $entity
|
||||
* The entity the current form should operate upon.
|
||||
* @param array $form
|
||||
* A nested array of form elements comprising the form.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
*/
|
||||
protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$values = $form_state->getValues();
|
||||
|
||||
// This is fired twice so we have to check that the entity does not already
|
||||
// have the state.
|
||||
if (!$entity->hasState($values['id'])) {
|
||||
$entity->addState($values['id'], $values['label']);
|
||||
if (isset($values['type_settings'])) {
|
||||
$configuration = $entity->getTypePlugin()->getConfiguration();
|
||||
$configuration['states'][$values['id']] = $values['type_settings'][$entity->getTypePlugin()->getPluginId()];
|
||||
$entity->set('type_settings', $configuration);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function save(array $form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$workflow->save();
|
||||
drupal_set_message($this->t('Created %label state.', [
|
||||
'%label' => $workflow->getState($form_state->getValue('id'))->label(),
|
||||
]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('edit-form'));
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function actions(array $form, FormStateInterface $form_state) {
|
||||
$actions['submit'] = [
|
||||
'#type' => 'submit',
|
||||
'#value' => $this->t('Save'),
|
||||
'#submit' => ['::submitForm', '::save'],
|
||||
];
|
||||
return $actions;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
use Drupal\Core\Form\ConfirmFormBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
||||
|
||||
/**
|
||||
* Builds the form to delete states from Workflow entities.
|
||||
*/
|
||||
class WorkflowStateDeleteForm extends ConfirmFormBase {
|
||||
|
||||
/**
|
||||
* The workflow entity the state being deleted belongs to.
|
||||
*
|
||||
* @var \Drupal\workflows\WorkflowInterface
|
||||
*/
|
||||
protected $workflow;
|
||||
|
||||
/**
|
||||
* The state being deleted.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $stateId;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_state_delete_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getQuestion() {
|
||||
return $this->t('Are you sure you want to delete %state from %workflow?', ['%state' => $this->workflow->getState($this->stateId)->label(), '%workflow' => $this->workflow->label()]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCancelUrl() {
|
||||
return $this->workflow->toUrl();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getConfirmText() {
|
||||
return $this->t('Delete');
|
||||
}
|
||||
|
||||
/**
|
||||
* Form constructor.
|
||||
*
|
||||
* @param array $form
|
||||
* An associative array containing the structure of the form.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow entity being edited.
|
||||
* @param string|null $workflow_state
|
||||
* The workflow state being deleted.
|
||||
*
|
||||
* @return array
|
||||
* The form structure.
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state, WorkflowInterface $workflow = NULL, $workflow_state = NULL) {
|
||||
if (!$workflow->hasState($workflow_state)) {
|
||||
throw new NotFoundHttpException();
|
||||
}
|
||||
$this->workflow = $workflow;
|
||||
$this->stateId = $workflow_state;
|
||||
return parent::buildForm($form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function submitForm(array &$form, FormStateInterface $form_state) {
|
||||
|
||||
$workflow_label = $this->workflow->getState($this->stateId)->label();
|
||||
$this->workflow
|
||||
->deleteState($this->stateId)
|
||||
->save();
|
||||
|
||||
drupal_set_message($this->t(
|
||||
'State %label deleted.',
|
||||
['%label' => $workflow_label]
|
||||
));
|
||||
|
||||
$form_state->setRedirectUrl($this->getCancelUrl());
|
||||
}
|
||||
|
||||
}
|
||||
174
web/core/modules/workflows/src/Form/WorkflowStateEditForm.php
Normal file
174
web/core/modules/workflows/src/Form/WorkflowStateEditForm.php
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\Core\Entity\EntityForm;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Url;
|
||||
|
||||
/**
|
||||
* Class WorkflowStateEditForm.
|
||||
*/
|
||||
class WorkflowStateEditForm extends EntityForm {
|
||||
|
||||
/**
|
||||
* The ID of the state that is being edited.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $stateId;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_state_edit_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state, $workflow_state = NULL) {
|
||||
$this->stateId = $workflow_state;
|
||||
return parent::buildForm($form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function form(array $form, FormStateInterface $form_state) {
|
||||
$form = parent::form($form, $form_state);
|
||||
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->getEntity();
|
||||
$state = $workflow->getState($this->stateId);
|
||||
$form['label'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Label'),
|
||||
'#maxlength' => 255,
|
||||
'#default_value' => $state->label(),
|
||||
'#description' => $this->t('Label for the state.'),
|
||||
'#required' => TRUE,
|
||||
];
|
||||
|
||||
$form['id'] = [
|
||||
'#type' => 'machine_name',
|
||||
'#default_value' => $this->stateId,
|
||||
'#machine_name' => [
|
||||
'exists' => [$this, 'exists'],
|
||||
],
|
||||
'#disabled' => TRUE,
|
||||
];
|
||||
|
||||
// Add additional form fields from the workflow type plugin.
|
||||
$form['type_settings'] = [
|
||||
$workflow->get('type') => $workflow->getTypePlugin()->buildStateConfigurationForm($form_state, $workflow, $state),
|
||||
'#tree' => TRUE,
|
||||
];
|
||||
|
||||
$header = [
|
||||
'label' => $this->t('Transition'),
|
||||
'state' => $this->t('To'),
|
||||
'operations' => $this->t('Operations'),
|
||||
];
|
||||
$form['transitions'] = [
|
||||
'#type' => 'table',
|
||||
'#header' => $header,
|
||||
'#empty' => $this->t('There are no transitions to or from this state yet.'),
|
||||
];
|
||||
foreach ($state->getTransitions() as $transition) {
|
||||
$links['edit'] = [
|
||||
'title' => $this->t('Edit'),
|
||||
'url' => Url::fromRoute('entity.workflow.edit_transition_form', [
|
||||
'workflow' => $workflow->id(),
|
||||
'workflow_transition' => $transition->id()
|
||||
]),
|
||||
];
|
||||
$links['delete'] = [
|
||||
'title' => t('Delete'),
|
||||
'url' => Url::fromRoute('entity.workflow.delete_transition_form', [
|
||||
'workflow' => $workflow->id(),
|
||||
'workflow_transition' => $transition->id()
|
||||
]),
|
||||
];
|
||||
$form['transitions'][$transition->id()] = [
|
||||
'label' => [
|
||||
'#markup' => $transition->label(),
|
||||
],
|
||||
'state' => [
|
||||
'#markup' => $transition->to()->label(),
|
||||
],
|
||||
'operations' => [
|
||||
'#type' => 'operations',
|
||||
'#links' => $links,
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies top-level form values to entity properties
|
||||
*
|
||||
* This form can only change values for a state, which is part of workflow.
|
||||
*
|
||||
* @param \Drupal\Core\Entity\EntityInterface $entity
|
||||
* The entity the current form should operate upon.
|
||||
* @param array $form
|
||||
* A nested array of form elements comprising the form.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
*/
|
||||
protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$values = $form_state->getValues();
|
||||
$entity->setStateLabel($values['id'], $values['label']);
|
||||
if (isset($values['type_settings'])) {
|
||||
$configuration = $entity->getTypePlugin()->getConfiguration();
|
||||
$configuration['states'][$values['id']] = $values['type_settings'][$entity->getTypePlugin()->getPluginId()];
|
||||
$entity->set('type_settings', $configuration);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function save(array $form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$workflow->save();
|
||||
drupal_set_message($this->t('Saved %label state.', [
|
||||
'%label' => $workflow->getState($this->stateId)->label(),
|
||||
]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('edit-form'));
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function actions(array $form, FormStateInterface $form_state) {
|
||||
$actions['submit'] = [
|
||||
'#type' => 'submit',
|
||||
'#value' => $this->t('Save'),
|
||||
'#submit' => ['::submitForm', '::save'],
|
||||
];
|
||||
|
||||
$actions['delete'] = [
|
||||
'#type' => 'link',
|
||||
'#title' => $this->t('Delete'),
|
||||
'#access' => $this->entity->access('delete-state:' . $this->stateId),
|
||||
'#attributes' => [
|
||||
'class' => ['button', 'button--danger'],
|
||||
],
|
||||
'#url' => Url::fromRoute('entity.workflow.delete_state_form', [
|
||||
'workflow' => $this->entity->id(),
|
||||
'workflow_state' => $this->stateId
|
||||
])
|
||||
];
|
||||
|
||||
return $actions;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\Core\Entity\EntityForm;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\workflows\State;
|
||||
|
||||
/**
|
||||
* Class WorkflowTransitionAddForm.
|
||||
*/
|
||||
class WorkflowTransitionAddForm extends EntityForm {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_transition_add_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function form(array $form, FormStateInterface $form_state) {
|
||||
$form = parent::form($form, $form_state);
|
||||
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->getEntity();
|
||||
$form['label'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Label'),
|
||||
'#maxlength' => 255,
|
||||
'#default_value' => '',
|
||||
'#description' => $this->t('Label for the transition.'),
|
||||
'#required' => TRUE,
|
||||
];
|
||||
|
||||
$form['id'] = [
|
||||
'#type' => 'machine_name',
|
||||
'#machine_name' => [
|
||||
'exists' => [$this, 'exists'],
|
||||
],
|
||||
];
|
||||
|
||||
// @todo https://www.drupal.org/node/2830584 Add some ajax to ensure that
|
||||
// only valid transitions are selectable.
|
||||
$states = array_map([State::class, 'labelCallback'], $workflow->getStates());
|
||||
$form['from'] = [
|
||||
'#type' => 'checkboxes',
|
||||
'#title' => $this->t('From'),
|
||||
'#required' => TRUE,
|
||||
'#default_value' => [],
|
||||
'#options' => $states,
|
||||
];
|
||||
$form['to'] = [
|
||||
'#type' => 'radios',
|
||||
'#title' => $this->t('To'),
|
||||
'#required' => TRUE,
|
||||
'#default_value' => [],
|
||||
'#options' => $states,
|
||||
];
|
||||
|
||||
// Add additional form fields from the workflow type plugin.
|
||||
$form['type_settings'] = [
|
||||
$workflow->get('type') => $workflow->getTypePlugin()->buildTransitionConfigurationForm($form_state, $workflow),
|
||||
'#tree' => TRUE,
|
||||
];
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the workflow transition already exists.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The workflow transition ID.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the workflow transition exists, FALSE otherwise.
|
||||
*/
|
||||
public function exists($transition_id) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $original_workflow */
|
||||
$original_workflow = \Drupal::entityTypeManager()->getStorage('workflow')->loadUnchanged($this->getEntity()->id());
|
||||
return $original_workflow->hasTransition($transition_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies top-level form values to entity properties
|
||||
*
|
||||
* This form can only change values for a state, which is part of workflow.
|
||||
*
|
||||
* @param \Drupal\Core\Entity\EntityInterface $entity
|
||||
* The entity the current form should operate upon.
|
||||
* @param array $form
|
||||
* A nested array of form elements comprising the form.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
*/
|
||||
protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
|
||||
if (!$form_state->isValidationComplete()) {
|
||||
// Only do something once form validation is complete.
|
||||
return;
|
||||
}
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$values = $form_state->getValues();
|
||||
$entity->addTransition($values['id'], $values['label'], array_filter($values['from']), $values['to']);
|
||||
if (isset($values['type_settings'])) {
|
||||
$configuration = $entity->getTypePlugin()->getConfiguration();
|
||||
$configuration['transitions'][$values['id']] = $values['type_settings'][$entity->getTypePlugin()->getPluginId()];
|
||||
$entity->set('type_settings', $configuration);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function validateForm(array &$form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->getEntity();
|
||||
$values = $form_state->getValues();
|
||||
foreach (array_filter($values['from']) as $from_state_id) {
|
||||
if ($workflow->hasTransitionFromStateToState($from_state_id, $values['to'])) {
|
||||
$form_state->setErrorByName('from][' . $from_state_id, $this->t('The transition from %from to %to already exists.', [
|
||||
'%from' => $workflow->getState($from_state_id)->label(),
|
||||
'%to' => $workflow->getState($values['to'])->label(),
|
||||
]));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function save(array $form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$workflow->save();
|
||||
drupal_set_message($this->t('Created %label transition.', [
|
||||
'%label' => $form_state->getValue('label'),
|
||||
]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('edit-form'));
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function actions(array $form, FormStateInterface $form_state) {
|
||||
$actions['submit'] = [
|
||||
'#type' => 'submit',
|
||||
'#value' => $this->t('Save'),
|
||||
'#submit' => ['::submitForm', '::save'],
|
||||
];
|
||||
return $actions;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
use Drupal\Core\Form\ConfirmFormBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
||||
|
||||
/**
|
||||
* Builds the form to delete transitions from Workflow entities.
|
||||
*/
|
||||
class WorkflowTransitionDeleteForm extends ConfirmFormBase {
|
||||
|
||||
/**
|
||||
* The workflow entity the transition being deleted belongs to.
|
||||
*
|
||||
* @var \Drupal\workflows\WorkflowInterface
|
||||
*/
|
||||
protected $workflow;
|
||||
|
||||
/**
|
||||
* The workflow transition being deleted.
|
||||
*
|
||||
* @var \Drupal\workflows\TransitionInterface
|
||||
*/
|
||||
protected $transition;
|
||||
|
||||
/**
|
||||
* The transition being deleted.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $transitionId;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_transition_delete_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getQuestion() {
|
||||
return $this->t('Are you sure you want to delete %transition from %workflow?', ['%transition' => $this->transition->label(), '%workflow' => $this->workflow->label()]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCancelUrl() {
|
||||
return $this->workflow->toUrl();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getConfirmText() {
|
||||
return $this->t('Delete');
|
||||
}
|
||||
|
||||
/**
|
||||
* Form constructor.
|
||||
*
|
||||
* @param array $form
|
||||
* An associative array containing the structure of the form.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow entity being edited.
|
||||
* @param string|null $workflow_transition
|
||||
* The workflow transition being deleted.
|
||||
*
|
||||
* @return array
|
||||
* The form structure.
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state, WorkflowInterface $workflow = NULL, $workflow_transition = NULL) {
|
||||
try {
|
||||
$this->transition = $workflow->getTransition($workflow_transition);
|
||||
}
|
||||
catch (\InvalidArgumentException $e) {
|
||||
throw new NotFoundHttpException();
|
||||
}
|
||||
$this->workflow = $workflow;
|
||||
return parent::buildForm($form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function submitForm(array &$form, FormStateInterface $form_state) {
|
||||
$this->workflow
|
||||
->deleteTransition($this->transition->id())
|
||||
->save();
|
||||
|
||||
drupal_set_message($this->t('%transition transition deleted.', ['%transition' => $this->transition->label()]));
|
||||
$form_state->setRedirectUrl($this->getCancelUrl());
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,178 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Form;
|
||||
|
||||
use Drupal\Core\Entity\EntityForm;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\workflows\State;
|
||||
|
||||
/**
|
||||
* Class WorkflowTransitionEditForm.
|
||||
*/
|
||||
class WorkflowTransitionEditForm extends EntityForm {
|
||||
|
||||
/**
|
||||
* The ID of the transition that is being edited.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $transitionId;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_transition_edit_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state, $workflow_transition = NULL) {
|
||||
$this->transitionId = $workflow_transition;
|
||||
return parent::buildForm($form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function form(array $form, FormStateInterface $form_state) {
|
||||
$form = parent::form($form, $form_state);
|
||||
|
||||
/* @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->getEntity();
|
||||
$transition = $workflow->getTransition($this->transitionId);
|
||||
$form['label'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Label'),
|
||||
'#maxlength' => 255,
|
||||
'#default_value' => $transition->label(),
|
||||
'#description' => $this->t('Label for the transition.'),
|
||||
'#required' => TRUE,
|
||||
];
|
||||
|
||||
$form['id'] = [
|
||||
'#type' => 'value',
|
||||
'#value' => $this->transitionId,
|
||||
];
|
||||
|
||||
// @todo https://www.drupal.org/node/2830584 Add some ajax to ensure that
|
||||
// only valid transitions are selectable.
|
||||
$states = array_map([State::class, 'labelCallback'], $workflow->getStates());
|
||||
$form['from'] = [
|
||||
'#type' => 'checkboxes',
|
||||
'#title' => $this->t('From'),
|
||||
'#required' => TRUE,
|
||||
'#default_value' => array_keys($transition->from()),
|
||||
'#options' => $states,
|
||||
];
|
||||
$form['to'] = [
|
||||
'#type' => 'radios',
|
||||
'#title' => $this->t('To'),
|
||||
'#required' => TRUE,
|
||||
'#default_value' => $transition->to()->id(),
|
||||
'#options' => $states,
|
||||
'#disabled' => TRUE,
|
||||
];
|
||||
|
||||
// Add additional form fields from the workflow type plugin.
|
||||
$form['type_settings'] = [
|
||||
$workflow->get('type') => $workflow->getTypePlugin()->buildTransitionConfigurationForm($form_state, $workflow, $transition),
|
||||
'#tree' => TRUE,
|
||||
];
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function validateForm(array &$form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->getEntity();
|
||||
$values = $form_state->getValues();
|
||||
foreach (array_filter($values['from']) as $from_state_id) {
|
||||
if ($workflow->hasTransitionFromStateToState($from_state_id, $values['to'])) {
|
||||
$transition = $workflow->getTransitionFromStateToState($from_state_id, $values['to']);
|
||||
if ($transition->id() !== $values['id']) {
|
||||
$form_state->setErrorByName('from][' . $from_state_id, $this->t('The transition from %from to %to already exists.', [
|
||||
'%from' => $workflow->getState($from_state_id)->label(),
|
||||
'%to' => $workflow->getState($values['to'])->label(),
|
||||
]));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies top-level form values to entity properties
|
||||
*
|
||||
* This form can only change values for a state, which is part of workflow.
|
||||
*
|
||||
* @param \Drupal\Core\Entity\EntityInterface $entity
|
||||
* The entity the current form should operate upon.
|
||||
* @param array $form
|
||||
* A nested array of form elements comprising the form.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
*/
|
||||
protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
|
||||
if (!$form_state->isValidationComplete()) {
|
||||
// Only do something once form validation is complete.
|
||||
return;
|
||||
}
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$values = $form_state->getValues();
|
||||
$form_state->set('created_transition', FALSE);
|
||||
$entity->setTransitionLabel($values['id'], $values['label']);
|
||||
$entity->setTransitionFromStates($values['id'], array_filter($values['from']));
|
||||
if (isset($values['type_settings'])) {
|
||||
$configuration = $entity->getTypePlugin()->getConfiguration();
|
||||
$configuration['transitions'][$values['id']] = $values['type_settings'][$entity->getTypePlugin()->getPluginId()];
|
||||
$entity->set('type_settings', $configuration);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function save(array $form, FormStateInterface $form_state) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $this->entity;
|
||||
$workflow->save();
|
||||
drupal_set_message($this->t('Saved %label transition.', [
|
||||
'%label' => $workflow->getTransition($this->transitionId)->label(),
|
||||
]));
|
||||
$form_state->setRedirectUrl($workflow->toUrl('edit-form'));
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function actions(array $form, FormStateInterface $form_state) {
|
||||
$actions['submit'] = [
|
||||
'#type' => 'submit',
|
||||
'#value' => $this->t('Save'),
|
||||
'#submit' => ['::submitForm', '::save'],
|
||||
];
|
||||
|
||||
$actions['delete'] = [
|
||||
'#type' => 'link',
|
||||
'#title' => $this->t('Delete'),
|
||||
// Deleting a transition is editing a workflow.
|
||||
'#access' => $this->entity->access('edit'),
|
||||
'#attributes' => [
|
||||
'class' => ['button', 'button--danger'],
|
||||
],
|
||||
'#url' => Url::fromRoute('entity.workflow.delete_transition_form', [
|
||||
'workflow' => $this->entity->id(),
|
||||
'workflow_transition' => $this->transitionId
|
||||
])
|
||||
];
|
||||
|
||||
return $actions;
|
||||
}
|
||||
|
||||
}
|
||||
148
web/core/modules/workflows/src/Plugin/WorkflowTypeBase.php
Normal file
148
web/core/modules/workflows/src/Plugin/WorkflowTypeBase.php
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows\Plugin;
|
||||
|
||||
use Drupal\Component\Plugin\PluginBase;
|
||||
use Drupal\Component\Utility\NestedArray;
|
||||
use Drupal\Core\Access\AccessResult;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Session\AccountInterface;
|
||||
use Drupal\workflows\StateInterface;
|
||||
use Drupal\workflows\TransitionInterface;
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
use Drupal\workflows\WorkflowTypeInterface;
|
||||
|
||||
/**
|
||||
* A base class for Workflow type plugins.
|
||||
*
|
||||
* @see \Drupal\workflows\Annotation\WorkflowType
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
abstract class WorkflowTypeBase extends PluginBase implements WorkflowTypeInterface {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
|
||||
parent::__construct($configuration, $plugin_id, $plugin_definition);
|
||||
$this->setConfiguration($configuration);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function initializeWorkflow(WorkflowInterface $workflow) {
|
||||
return $workflow;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function label() {
|
||||
$definition = $this->getPluginDefinition();
|
||||
// The label can be an object.
|
||||
// @see \Drupal\Core\StringTranslation\TranslatableMarkup
|
||||
return $definition['label'];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function checkWorkflowAccess(WorkflowInterface $entity, $operation, AccountInterface $account) {
|
||||
return AccessResult::neutral();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function decorateState(StateInterface $state) {
|
||||
return $state;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function deleteState($state_id) {
|
||||
unset($this->configuration['states'][$state_id]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function decorateTransition(TransitionInterface $transition) {
|
||||
return $transition;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function deleteTransition($transition_id) {
|
||||
unset($this->configuration['transitions'][$transition_id]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildStateConfigurationForm(FormStateInterface $form_state, WorkflowInterface $workflow, StateInterface $state = NULL) {
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildTransitionConfigurationForm(FormStateInterface $form_state, WorkflowInterface $workflow, TransitionInterface $transition = NULL) {
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function getConfiguration() {
|
||||
return $this->configuration;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function setConfiguration(array $configuration) {
|
||||
$this->configuration = NestedArray::mergeDeep(
|
||||
$this->defaultConfiguration(),
|
||||
$configuration
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getRequiredStates() {
|
||||
return $this->getPluginDefinition()['required_states'];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function defaultConfiguration() {
|
||||
return [
|
||||
'states' => [],
|
||||
'transitions' => [],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function calculateDependencies() {
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function onDependencyRemoval(array $dependencies) {
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
}
|
||||
118
web/core/modules/workflows/src/State.php
Normal file
118
web/core/modules/workflows/src/State.php
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
/**
|
||||
* A value object representing a workflow state.
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
class State implements StateInterface {
|
||||
|
||||
/**
|
||||
* The workflow the state is attached to.
|
||||
*
|
||||
* @var \Drupal\workflows\WorkflowInterface
|
||||
*/
|
||||
protected $workflow;
|
||||
|
||||
/**
|
||||
* The state's ID.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $id;
|
||||
|
||||
/**
|
||||
* The state's label.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $label;
|
||||
|
||||
/**
|
||||
* The state's weight.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $weight;
|
||||
|
||||
/**
|
||||
* State constructor.
|
||||
*
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow the state is attached to.
|
||||
* @param string $id
|
||||
* The state's ID.
|
||||
* @param string $label
|
||||
* The state's label.
|
||||
* @param int $weight
|
||||
* The state's weight.
|
||||
*/
|
||||
public function __construct(WorkflowInterface $workflow, $id, $label, $weight = 0) {
|
||||
$this->workflow = $workflow;
|
||||
$this->id = $id;
|
||||
$this->label = $label;
|
||||
$this->weight = $weight;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function id() {
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function label() {
|
||||
return $this->label;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function weight() {
|
||||
return $this->weight;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function canTransitionTo($to_state_id) {
|
||||
return $this->workflow->hasTransitionFromStateToState($this->id, $to_state_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getTransitionTo($to_state_id) {
|
||||
if (!$this->canTransitionTo($to_state_id)) {
|
||||
throw new \InvalidArgumentException("Can not transition to '$to_state_id' state");
|
||||
}
|
||||
return $this->workflow->getTransitionFromStateToState($this->id(), $to_state_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getTransitions() {
|
||||
return $this->workflow->getTransitionsForState($this->id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to convert a list of states to labels
|
||||
*
|
||||
* @param \Drupal\workflows\StateInterface $state
|
||||
*
|
||||
* @return string
|
||||
* The label of the state.
|
||||
*/
|
||||
public static function labelCallback(StateInterface $state) {
|
||||
return $state->label();
|
||||
}
|
||||
|
||||
}
|
||||
73
web/core/modules/workflows/src/StateInterface.php
Normal file
73
web/core/modules/workflows/src/StateInterface.php
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
/**
|
||||
* An interface for state value objects.
|
||||
*
|
||||
* @see \Drupal\workflows\WorkflowTypeInterface::decorateState()
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
interface StateInterface {
|
||||
|
||||
/**
|
||||
* Gets the state's ID.
|
||||
*
|
||||
* @return string
|
||||
* The state's ID.
|
||||
*/
|
||||
public function id();
|
||||
|
||||
/**
|
||||
* Gets the state's label.
|
||||
*
|
||||
* @return string
|
||||
* The state's label.
|
||||
*/
|
||||
public function label();
|
||||
|
||||
/**
|
||||
* Gets the state's weight.
|
||||
*
|
||||
* @return int
|
||||
* The state's weight.
|
||||
*/
|
||||
public function weight();
|
||||
|
||||
/**
|
||||
* Determines if the state can transition to the provided state ID.
|
||||
*
|
||||
* @param $to_state_id
|
||||
* The state to transition to.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the state can transition to the provided state ID. FALSE, if not.
|
||||
*/
|
||||
public function canTransitionTo($to_state_id);
|
||||
|
||||
/**
|
||||
* Gets the Transition object for the provided state ID.
|
||||
*
|
||||
* @param $to_state_id
|
||||
* The state to transition to.
|
||||
*
|
||||
* @return \Drupal\workflows\TransitionInterface
|
||||
* The Transition object for the provided state ID.
|
||||
*
|
||||
* @throws \InvalidArgumentException()
|
||||
* Exception thrown when the provided state ID can not be transitioned to.
|
||||
*/
|
||||
public function getTransitionTo($to_state_id);
|
||||
|
||||
/**
|
||||
* Gets all the possible transition objects for the state.
|
||||
*
|
||||
* @return \Drupal\workflows\TransitionInterface[]
|
||||
* All the possible transition objects for the state.
|
||||
*/
|
||||
public function getTransitions();
|
||||
|
||||
}
|
||||
116
web/core/modules/workflows/src/Transition.php
Normal file
116
web/core/modules/workflows/src/Transition.php
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
/**
|
||||
* A transition value object that describes the transition between states.
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
class Transition implements TransitionInterface {
|
||||
|
||||
/**
|
||||
* The workflow that this transition is attached to.
|
||||
*
|
||||
* @var \Drupal\workflows\WorkflowInterface
|
||||
*/
|
||||
protected $workflow;
|
||||
|
||||
/**
|
||||
* The transition's ID.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $id;
|
||||
|
||||
/**
|
||||
* The transition's label.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $label;
|
||||
|
||||
/**
|
||||
* The transition's from state IDs.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
protected $fromStateIds;
|
||||
|
||||
/**
|
||||
* The transition's to state ID.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $toStateId;
|
||||
|
||||
/**
|
||||
* The transition's weight.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $weight;
|
||||
|
||||
/**
|
||||
* Transition constructor.
|
||||
*
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow the state is attached to.
|
||||
* @param string $id
|
||||
* The transition's ID.
|
||||
* @param string $label
|
||||
* The transition's label.
|
||||
* @param array $from_state_ids
|
||||
* A list of from state IDs.
|
||||
* @param string $to_state_id
|
||||
* The to state ID.
|
||||
* @param int $weight
|
||||
* (optional) The transition's weight. Defaults to 0.
|
||||
*/
|
||||
public function __construct(WorkflowInterface $workflow, $id, $label, array $from_state_ids, $to_state_id, $weight = 0) {
|
||||
$this->workflow = $workflow;
|
||||
$this->id = $id;
|
||||
$this->label = $label;
|
||||
$this->fromStateIds = $from_state_ids;
|
||||
$this->toStateId = $to_state_id;
|
||||
$this->weight = $weight;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function id() {
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function label() {
|
||||
return $this->label;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function from() {
|
||||
return $this->workflow->getStates($this->fromStateIds);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function to() {
|
||||
return $this->workflow->getState($this->toStateId);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function weight() {
|
||||
return $this->weight;
|
||||
}
|
||||
|
||||
}
|
||||
54
web/core/modules/workflows/src/TransitionInterface.php
Normal file
54
web/core/modules/workflows/src/TransitionInterface.php
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
/**
|
||||
* A transition value object that describes the transition between two states.
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
interface TransitionInterface {
|
||||
|
||||
/**
|
||||
* 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();
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
use Drupal\Component\Plugin\PluginManagerInterface;
|
||||
use Drupal\Core\Entity\EntityAccessControlHandler;
|
||||
use Drupal\Core\Entity\EntityHandlerInterface;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Entity\EntityTypeInterface;
|
||||
use Drupal\Core\Session\AccountInterface;
|
||||
use Drupal\Core\Access\AccessResult;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
|
||||
/**
|
||||
* Access controller for the Moderation State entity.
|
||||
*
|
||||
* @see \Drupal\workflows\Entity\Workflow.
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
class WorkflowAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {
|
||||
|
||||
/**
|
||||
* The workflow type plugin manager.
|
||||
*
|
||||
* @var \Drupal\Component\Plugin\PluginManagerInterface
|
||||
*/
|
||||
protected $workflowTypeManager;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
|
||||
return new static(
|
||||
$entity_type,
|
||||
$container->get('plugin.manager.workflows.type')
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs the workflow access control handler instance.
|
||||
*
|
||||
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
|
||||
* The entity type definition.
|
||||
* @param \Drupal\Component\Plugin\PluginManagerInterface $workflow_type_manager
|
||||
* The workflow type plugin manager.
|
||||
*/
|
||||
public function __construct(EntityTypeInterface $entity_type, PluginManagerInterface $workflow_type_manager) {
|
||||
parent::__construct($entity_type);
|
||||
$this->workflowTypeManager = $workflow_type_manager;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
|
||||
/** @var \Drupal\workflows\Entity\Workflow $entity */
|
||||
$workflow_type = $entity->getTypePlugin();
|
||||
if (strpos($operation, 'delete-state') === 0) {
|
||||
list(, $state_id) = explode(':', $operation, 2);
|
||||
// Deleting a state is editing a workflow, but also we should forbid
|
||||
// access if there is only one state.
|
||||
$admin_access = AccessResult::allowedIf(count($entity->getStates()) > 1)
|
||||
->andIf(parent::checkAccess($entity, 'edit', $account))
|
||||
->andIf(AccessResult::allowedIf(!in_array($state_id, $workflow_type->getRequiredStates(), TRUE)))
|
||||
->addCacheableDependency($entity);
|
||||
}
|
||||
else {
|
||||
$admin_access = parent::checkAccess($entity, $operation, $account);
|
||||
}
|
||||
return $workflow_type->checkWorkflowAccess($entity, $operation, $account)->orIf($admin_access);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
|
||||
$workflow_types_count = count($this->workflowTypeManager->getDefinitions());
|
||||
$admin_access = parent::checkCreateAccess($account, $context, $entity_bundle);
|
||||
// Allow access if there is at least one workflow type. Since workflow types
|
||||
// are provided by modules this is cacheable until extensions change.
|
||||
return $admin_access->andIf(AccessResult::allowedIf($workflow_types_count > 0))->addCacheTags(['config:core.extension']);
|
||||
}
|
||||
|
||||
}
|
||||
53
web/core/modules/workflows/src/WorkflowDeleteAccessCheck.php
Normal file
53
web/core/modules/workflows/src/WorkflowDeleteAccessCheck.php
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
use Drupal\Core\Access\AccessResult;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Routing\Access\AccessInterface;
|
||||
use Drupal\Core\Routing\RouteMatchInterface;
|
||||
use Drupal\Core\Session\AccountInterface;
|
||||
use Symfony\Component\Routing\Route;
|
||||
|
||||
/**
|
||||
* Provides a access checker for deleting a workflow state.
|
||||
*/
|
||||
class WorkflowDeleteAccessCheck implements AccessInterface {
|
||||
|
||||
/**
|
||||
* Checks access to deleting a workflow state for a particular route.
|
||||
*
|
||||
* The value of '_workflow_state_delete_access' is ignored. The route must
|
||||
* have the parameters 'workflow' and 'workflow_state'. For example:
|
||||
* @code
|
||||
* pattern: '/foo/{workflow}/bar/{workflow_state}/delete'
|
||||
* requirements:
|
||||
* _workflow_state_delete_access: 'true'
|
||||
* @endcode
|
||||
* @see \Drupal\Core\ParamConverter\EntityConverter
|
||||
*
|
||||
* @param \Symfony\Component\Routing\Route $route
|
||||
* The route to check against.
|
||||
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
|
||||
* The parametrized route
|
||||
* @param \Drupal\Core\Session\AccountInterface $account
|
||||
* The currently logged in account.
|
||||
*
|
||||
* @return \Drupal\Core\Access\AccessResultInterface
|
||||
* The access result.
|
||||
*/
|
||||
public function access(Route $route, RouteMatchInterface $route_match, AccountInterface $account) {
|
||||
// If there is valid entity of the given entity type, check its access.
|
||||
$parameters = $route_match->getParameters();
|
||||
if ($parameters->has('workflow') && $parameters->has('workflow_state')) {
|
||||
$entity = $parameters->get('workflow');
|
||||
if ($entity instanceof EntityInterface) {
|
||||
return $entity->access('delete-state:' . $parameters->get('workflow_state'), $account, TRUE);
|
||||
}
|
||||
}
|
||||
// No opinion, so other access checks should decide if access should be
|
||||
// allowed or not.
|
||||
return AccessResult::neutral();
|
||||
}
|
||||
|
||||
}
|
||||
289
web/core/modules/workflows/src/WorkflowInterface.php
Normal file
289
web/core/modules/workflows/src/WorkflowInterface.php
Normal file
|
|
@ -0,0 +1,289 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
use Drupal\Core\Config\Entity\ConfigEntityInterface;
|
||||
|
||||
/**
|
||||
* Provides an interface for defining workflow entities.
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
interface WorkflowInterface extends ConfigEntityInterface {
|
||||
|
||||
/**
|
||||
* Adds a state to the workflow.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state's ID.
|
||||
* @param string $label
|
||||
* The state's label.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*/
|
||||
public function addState($state_id, $label);
|
||||
|
||||
/**
|
||||
* Determines if the workflow has a state with the provided ID.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state's ID.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the workflow has a state with the provided ID, FALSE if not.
|
||||
*/
|
||||
public function hasState($state_id);
|
||||
|
||||
/**
|
||||
* Gets state objects for the provided state IDs.
|
||||
*
|
||||
* @param string[] $state_ids
|
||||
* A list of state IDs to get. If NULL then all states will be returned.
|
||||
*
|
||||
* @return \Drupal\workflows\StateInterface[]
|
||||
* An array of workflow states.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if $state_ids contains a state ID that does not exist.
|
||||
*/
|
||||
public function getStates($state_ids = NULL);
|
||||
|
||||
/**
|
||||
* Gets a workflow state.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state's ID.
|
||||
*
|
||||
* @return \Drupal\workflows\StateInterface
|
||||
* The workflow state.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if $state_id does not exist.
|
||||
*/
|
||||
public function getState($state_id);
|
||||
|
||||
/**
|
||||
* Sets a state's label.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state ID to set the label for.
|
||||
* @param string $label
|
||||
* The state's label.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*/
|
||||
public function setStateLabel($state_id, $label);
|
||||
|
||||
/**
|
||||
* Sets a state's weight value.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state ID to set the weight for.
|
||||
* @param int $weight
|
||||
* The state's weight.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*/
|
||||
public function setStateWeight($state_id, $weight);
|
||||
|
||||
/**
|
||||
* Deletes a state from the workflow.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state ID to delete.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if $state_id does not exist.
|
||||
*/
|
||||
public function deleteState($state_id);
|
||||
|
||||
/**
|
||||
* Gets the initial state for the workflow.
|
||||
*
|
||||
* @return \Drupal\workflows\StateInterface
|
||||
* The initial state.
|
||||
*/
|
||||
public function getInitialState();
|
||||
|
||||
/**
|
||||
* Adds a transition to the workflow.
|
||||
*
|
||||
* @param string $id
|
||||
* The transition ID.
|
||||
* @param string $label
|
||||
* The transition's label.
|
||||
* @param array $from_state_ids
|
||||
* The state IDs to transition from.
|
||||
* @param string $to_state_id
|
||||
* The state ID to transition to.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if either state does not exist.
|
||||
*/
|
||||
public function addTransition($id, $label, array $from_state_ids, $to_state_id);
|
||||
|
||||
/**
|
||||
* Gets a transition object for the provided transition ID.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* A transition ID.
|
||||
*
|
||||
* @return \Drupal\workflows\TransitionInterface
|
||||
* The transition.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if $transition_id does not exist.
|
||||
*/
|
||||
public function getTransition($transition_id);
|
||||
|
||||
/**
|
||||
* Determines if a transition exists.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The transition ID.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the transition exists, FALSE if not.
|
||||
*/
|
||||
public function hasTransition($transition_id);
|
||||
|
||||
/**
|
||||
* Gets transition objects for the provided transition IDs.
|
||||
*
|
||||
* @param string[] $transition_ids
|
||||
* A list of transition IDs to get. If NULL then all transitions will be
|
||||
* returned.
|
||||
*
|
||||
* @return \Drupal\workflows\TransitionInterface[]
|
||||
* An array of transition objects.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if $transition_ids contains a transition ID that does not exist.
|
||||
*/
|
||||
public function getTransitions(array $transition_ids = NULL);
|
||||
|
||||
/**
|
||||
* Gets the transition IDs for a state for the provided direction.
|
||||
*
|
||||
* @param $state_id
|
||||
* The state to get transitions for.
|
||||
* @param string $direction
|
||||
* (optional) The direction of the transition. Defaults to 'from'. Possible
|
||||
* values are: 'from' and 'to'.
|
||||
*
|
||||
* @return array
|
||||
* The transition IDs for a state for the provided direction.
|
||||
*/
|
||||
public function getTransitionsForState($state_id, $direction = 'from');
|
||||
|
||||
/**
|
||||
* Gets a transition from state to state.
|
||||
*
|
||||
* @param string $from_state_id
|
||||
* The state ID to transition from.
|
||||
* @param string $to_state_id
|
||||
* The state ID to transition to.
|
||||
*
|
||||
* @return \Drupal\workflows\TransitionInterface
|
||||
* The transitions.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if the transition does not exist.
|
||||
*/
|
||||
public function getTransitionFromStateToState($from_state_id, $to_state_id);
|
||||
|
||||
/**
|
||||
* Determines if a transition from state to state exists.
|
||||
*
|
||||
* @param string $from_state_id
|
||||
* The state ID to transition from.
|
||||
* @param string $to_state_id
|
||||
* The state ID to transition to.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the transition exists, FALSE if not.
|
||||
*/
|
||||
public function hasTransitionFromStateToState($from_state_id, $to_state_id);
|
||||
|
||||
/**
|
||||
* Sets a transition's label.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The transition ID.
|
||||
* @param string $label
|
||||
* The transition's label.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if the transition does not exist.
|
||||
*/
|
||||
public function setTransitionLabel($transition_id, $label);
|
||||
|
||||
/**
|
||||
* Sets a transition's weight.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The transition ID.
|
||||
* @param int $weight
|
||||
* The transition's weight.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if the transition does not exist.
|
||||
*/
|
||||
public function setTransitionWeight($transition_id, $weight);
|
||||
|
||||
/**
|
||||
* Sets a transition's from states.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The transition ID.
|
||||
* @param array $from_state_ids
|
||||
* The state IDs to transition from.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if the transition does not exist or the states do not exist.
|
||||
*/
|
||||
public function setTransitionFromStates($transition_id, array $from_state_ids);
|
||||
|
||||
/**
|
||||
* Deletes a transition.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The transition ID.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The workflow entity.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* Thrown if the transition does not exist.
|
||||
*/
|
||||
public function deleteTransition($transition_id);
|
||||
|
||||
/**
|
||||
* Gets the workflow type plugin.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowTypeInterface
|
||||
* The workflow type plugin.
|
||||
*/
|
||||
public function getTypePlugin();
|
||||
|
||||
}
|
||||
101
web/core/modules/workflows/src/WorkflowListBuilder.php
Normal file
101
web/core/modules/workflows/src/WorkflowListBuilder.php
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
use Drupal\Component\Plugin\PluginManagerInterface;
|
||||
use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Entity\EntityStorageInterface;
|
||||
use Drupal\Core\Entity\EntityTypeInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
|
||||
/**
|
||||
* Provides a listing of Workflow entities.
|
||||
*/
|
||||
class WorkflowListBuilder extends ConfigEntityListBuilder {
|
||||
|
||||
/**
|
||||
* The workflow type plugin manager.
|
||||
*
|
||||
* @var \Drupal\Component\Plugin\PluginManagerInterface
|
||||
*/
|
||||
protected $workflowTypeManager;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
|
||||
return new static(
|
||||
$entity_type,
|
||||
$container->get('entity_type.manager')->getStorage($entity_type->id()),
|
||||
$container->get('plugin.manager.workflows.type')
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new WorkflowListBuilder object.
|
||||
*
|
||||
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
|
||||
* The entity type definition.
|
||||
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
|
||||
* The entity storage class.
|
||||
* @param \Drupal\Component\Plugin\PluginManagerInterface $workflow_type_manager
|
||||
* The workflow type plugin manager.
|
||||
*/
|
||||
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, PluginManagerInterface $workflow_type_manager) {
|
||||
parent::__construct($entity_type, $storage);
|
||||
$this->workflowTypeManager = $workflow_type_manager;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'workflow_admin_overview_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildHeader() {
|
||||
$header['label'] = $this->t('Workflow');
|
||||
$header['type'] = $this->t('Type');
|
||||
$header['states'] = $this->t('States');
|
||||
|
||||
return $header + parent::buildHeader();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildRow(EntityInterface $entity) {
|
||||
/** @var \Drupal\workflows\WorkflowInterface $entity */
|
||||
$row['label'] = $entity->label();
|
||||
|
||||
$row['type']['data'] = [
|
||||
'#markup' => $entity->getTypePlugin()->label()
|
||||
];
|
||||
|
||||
$items = array_map([State::class, 'labelCallback'], $entity->getStates());
|
||||
$row['states']['data'] = [
|
||||
'#theme' => 'item_list',
|
||||
'#context' => ['list_style' => 'comma-list'],
|
||||
'#items' => $items,
|
||||
];
|
||||
|
||||
return $row + parent::buildRow($entity);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function render() {
|
||||
$build = parent::render();
|
||||
$workflow_types_count = count($this->workflowTypeManager->getDefinitions());
|
||||
if ($workflow_types_count === 0) {
|
||||
$build['table']['#empty'] = $this->t('There are no workflow types available. In order to create workflows you need to install a module that provides a workflow type. For example, the Content Moderation module provides a workflow type that enables workflows for content entities.');
|
||||
}
|
||||
return $build;
|
||||
}
|
||||
|
||||
}
|
||||
162
web/core/modules/workflows/src/WorkflowTypeInterface.php
Normal file
162
web/core/modules/workflows/src/WorkflowTypeInterface.php
Normal file
|
|
@ -0,0 +1,162 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
use Drupal\Component\Plugin\ConfigurablePluginInterface;
|
||||
use Drupal\Component\Plugin\DerivativeInspectionInterface;
|
||||
use Drupal\Component\Plugin\PluginInspectionInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Session\AccountInterface;
|
||||
|
||||
/**
|
||||
* An interface for Workflow type plugins.
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
interface WorkflowTypeInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurablePluginInterface {
|
||||
|
||||
/**
|
||||
* Initializes a workflow.
|
||||
*
|
||||
* Used to create required states and default transitions.
|
||||
*
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow to initialize.
|
||||
*
|
||||
* @return \Drupal\workflows\WorkflowInterface
|
||||
* The initialized workflow.
|
||||
*
|
||||
* @see \Drupal\workflows\Form\WorkflowAddForm::save()
|
||||
*/
|
||||
public function initializeWorkflow(WorkflowInterface $workflow);
|
||||
|
||||
/**
|
||||
* Gets the label for the workflow type.
|
||||
*
|
||||
* @return string
|
||||
* The workflow type label.
|
||||
*/
|
||||
public function label();
|
||||
|
||||
/**
|
||||
* Performs access checks.
|
||||
*
|
||||
* @param \Drupal\workflows\WorkflowInterface $entity
|
||||
* The workflow entity for which to check access.
|
||||
* @param string $operation
|
||||
* The entity operation. Usually one of 'view', 'view label', 'update' or
|
||||
* 'delete'.
|
||||
* @param \Drupal\Core\Session\AccountInterface $account
|
||||
* The user for which to check access.
|
||||
*
|
||||
* @return \Drupal\Core\Access\AccessResultInterface
|
||||
* The access result.
|
||||
*/
|
||||
public function checkWorkflowAccess(WorkflowInterface $entity, $operation, AccountInterface $account);
|
||||
|
||||
/**
|
||||
* Decorates states so the WorkflowType can add additional information.
|
||||
*
|
||||
* @param \Drupal\workflows\StateInterface $state
|
||||
* The state object to decorate.
|
||||
*
|
||||
* @return \Drupal\workflows\StateInterface
|
||||
* The decorated state object.
|
||||
*/
|
||||
public function decorateState(StateInterface $state);
|
||||
|
||||
/**
|
||||
* React to the removal of a state from a workflow.
|
||||
*
|
||||
* @param string $state_id
|
||||
* The state ID of the state that is being removed.
|
||||
*/
|
||||
public function deleteState($state_id);
|
||||
|
||||
/**
|
||||
* Decorates transitions so the WorkflowType can add additional information.
|
||||
* @param \Drupal\workflows\TransitionInterface $transition
|
||||
* The transition object to decorate.
|
||||
*
|
||||
* @return \Drupal\workflows\TransitionInterface
|
||||
* The decorated transition object.
|
||||
*/
|
||||
public function decorateTransition(TransitionInterface $transition);
|
||||
|
||||
/**
|
||||
* React to the removal of a transition from a workflow.
|
||||
*
|
||||
* @param string $transition_id
|
||||
* The transition ID of the transition that is being removed.
|
||||
*/
|
||||
public function deleteTransition($transition_id);
|
||||
|
||||
/**
|
||||
* Builds a form to be added to the Workflow state edit form.
|
||||
*
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The form state.
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow the state is attached to.
|
||||
* @param \Drupal\workflows\StateInterface|null $state
|
||||
* The workflow state being edited. If NULL, a new state is being added.
|
||||
*
|
||||
* @return array
|
||||
* Form elements to add to a workflow state form for customisations to the
|
||||
* workflow.
|
||||
*
|
||||
* @see \Drupal\workflows\Form\WorkflowStateAddForm::form()
|
||||
* @see \Drupal\workflows\Form\WorkflowStateEditForm::form()
|
||||
*/
|
||||
public function buildStateConfigurationForm(FormStateInterface $form_state, WorkflowInterface $workflow, StateInterface $state = NULL);
|
||||
|
||||
/**
|
||||
* Builds a form to be added to the Workflow transition edit form.
|
||||
*
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The form state.
|
||||
* @param \Drupal\workflows\WorkflowInterface $workflow
|
||||
* The workflow the state is attached to.
|
||||
* @param \Drupal\workflows\TransitionInterface|null $transition
|
||||
* The workflow transition being edited. If NULL, a new transition is being
|
||||
* added.
|
||||
*
|
||||
* @return array
|
||||
* Form elements to add to a workflow transition form for customisations to
|
||||
* the workflow.
|
||||
*
|
||||
* @see \Drupal\workflows\Form\WorkflowTransitionAddForm::form()
|
||||
* @see \Drupal\workflows\Form\WorkflowTransitionEditForm::form()
|
||||
*/
|
||||
public function buildTransitionConfigurationForm(FormStateInterface $form_state, WorkflowInterface $workflow, TransitionInterface $transition = NULL);
|
||||
|
||||
/**
|
||||
* Gets the required states of workflow type.
|
||||
*
|
||||
* This are usually configured in the workflow type annotation.
|
||||
*
|
||||
* @return array[]
|
||||
* The required states.
|
||||
*
|
||||
* @see \Drupal\workflows\Annotation\WorkflowType
|
||||
*/
|
||||
public function getRequiredStates();
|
||||
|
||||
/**
|
||||
* Informs the plugin that a dependency of the workflow will be deleted.
|
||||
*
|
||||
* @param array $dependencies
|
||||
* An array of dependencies that will be deleted keyed by dependency type.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the workflow settings have been changed, FALSE if not.
|
||||
*
|
||||
* @see \Drupal\Core\Config\ConfigEntityInterface::onDependencyRemoval()
|
||||
*
|
||||
* @todo https://www.drupal.org/node/2579743 make part of a generic interface.
|
||||
*/
|
||||
public function onDependencyRemoval(array $dependencies);
|
||||
|
||||
}
|
||||
40
web/core/modules/workflows/src/WorkflowTypeManager.php
Normal file
40
web/core/modules/workflows/src/WorkflowTypeManager.php
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflows;
|
||||
|
||||
use Drupal\Core\Cache\CacheBackendInterface;
|
||||
use Drupal\Core\Extension\ModuleHandlerInterface;
|
||||
use Drupal\Core\Plugin\DefaultPluginManager;
|
||||
use Drupal\workflows\Annotation\WorkflowType;
|
||||
|
||||
/**
|
||||
* Provides a Workflow type plugin manager.
|
||||
*
|
||||
* @see \Drupal\workflows\Annotation\WorkflowType
|
||||
* @see \Drupal\workflows\WorkflowTypeInterface
|
||||
* @see plugin_api
|
||||
*
|
||||
* @internal
|
||||
* The workflow system is currently experimental and should only be leveraged
|
||||
* by experimental modules and development releases of contributed modules.
|
||||
*/
|
||||
class WorkflowTypeManager extends DefaultPluginManager {
|
||||
|
||||
/**
|
||||
* Constructs a new class instance.
|
||||
*
|
||||
* @param \Traversable $namespaces
|
||||
* An object that implements \Traversable which contains the root paths
|
||||
* keyed by the corresponding namespace to look for plugin implementations.
|
||||
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
|
||||
* Cache backend instance to use.
|
||||
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
|
||||
* The module handler to invoke the alter hook with.
|
||||
*/
|
||||
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
|
||||
parent::__construct('Plugin/WorkflowType', $namespaces, $module_handler, WorkflowTypeInterface::class, WorkflowType::class);
|
||||
$this->alterInfo('workflow_type_info');
|
||||
$this->setCacheBackend($cache_backend, 'workflow_type_info');
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
workflows.workflow.*.third_party.workflow_third_party_settings_test:
|
||||
type: ignore
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
name: 'Workflow Third Party Settings Test'
|
||||
type: module
|
||||
description: 'Allows third party settings on workflows to be tested.'
|
||||
package: Testing
|
||||
version: VERSION
|
||||
core: 8.x
|
||||
dependencies:
|
||||
- workflows
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
workflow.type_settings.workflow_type_test:
|
||||
type: mapping
|
||||
label: 'Workflow test type settings'
|
||||
mapping:
|
||||
states:
|
||||
type: sequence
|
||||
sequence:
|
||||
type: ignore
|
||||
|
||||
workflow.type_settings.workflow_type_required_state_test:
|
||||
type: mapping
|
||||
label: 'Workflow test type settings'
|
||||
mapping:
|
||||
states:
|
||||
type: sequence
|
||||
sequence:
|
||||
type: ignore
|
||||
|
||||
workflow.type_settings.workflow_type_complex_test:
|
||||
type: mapping
|
||||
label: 'Workflow complex test type settings'
|
||||
mapping:
|
||||
states:
|
||||
type: sequence
|
||||
label: 'Additional state configuration'
|
||||
sequence:
|
||||
type: mapping
|
||||
label: 'States'
|
||||
mapping:
|
||||
extra:
|
||||
type: string
|
||||
label: 'Extra information'
|
||||
transitions:
|
||||
type: sequence
|
||||
label: 'Additional transition configuration'
|
||||
sequence:
|
||||
type: mapping
|
||||
label: 'Transitions'
|
||||
mapping:
|
||||
extra:
|
||||
type: string
|
||||
label: 'Extra information'
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflow_type_test;
|
||||
|
||||
use Drupal\workflows\StateInterface;
|
||||
|
||||
/**
|
||||
* A value object representing a workflow state.
|
||||
*/
|
||||
class DecoratedState implements StateInterface {
|
||||
|
||||
/**
|
||||
* The vanilla state object from the Workflow module.
|
||||
*
|
||||
* @var \Drupal\workflows\StateInterface
|
||||
*/
|
||||
protected $state;
|
||||
|
||||
/**
|
||||
* Extra information added to state.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $extra;
|
||||
|
||||
/**
|
||||
* DecoratedState constructor.
|
||||
*
|
||||
* @param \Drupal\workflows\StateInterface $state
|
||||
* The vanilla state object from the Workflow module.
|
||||
* @param string $extra
|
||||
* (optional) Extra information stored on the state. Defaults to ''.
|
||||
*/
|
||||
public function __construct(StateInterface $state, $extra = '') {
|
||||
$this->state = $state;
|
||||
$this->extra = $extra;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the extra information stored on the state.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getExtra() {
|
||||
return $this->extra;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@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();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflow_type_test;
|
||||
|
||||
use Drupal\workflows\TransitionInterface;
|
||||
|
||||
/**
|
||||
* A value object representing a workflow transition.
|
||||
*/
|
||||
class DecoratedTransition implements TransitionInterface {
|
||||
|
||||
/**
|
||||
* The vanilla transition object from the Workflow module.
|
||||
*
|
||||
* @var \Drupal\workflows\TransitionInterface
|
||||
*/
|
||||
protected $transition;
|
||||
|
||||
/**
|
||||
* Extra information added to transition.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $extra;
|
||||
|
||||
/**
|
||||
* DecoratedTransition constructor.
|
||||
*
|
||||
* @param \Drupal\workflows\TransitionInterface $transition
|
||||
* The vanilla transition object from the Workflow module.
|
||||
* @param string $extra
|
||||
* (optional) Extra information stored on the transition. Defaults to ''.
|
||||
*/
|
||||
public function __construct(TransitionInterface $transition, $extra = '') {
|
||||
$this->transition = $transition;
|
||||
$this->extra = $extra;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the extra information stored on the transition.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getExtra() {
|
||||
return $this->extra;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function id() {
|
||||
return $this->transition->id();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function label() {
|
||||
return $this->transition->label();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function from() {
|
||||
return $this->transition->from();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function to() {
|
||||
return $this->transition->to();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function weight() {
|
||||
return $this->transition->weight();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflow_type_test\Plugin\WorkflowType;
|
||||
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\StringTranslation\StringTranslationTrait;
|
||||
use Drupal\workflows\Plugin\WorkflowTypeBase;
|
||||
use Drupal\workflows\StateInterface;
|
||||
use Drupal\workflows\TransitionInterface;
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
use Drupal\workflow_type_test\DecoratedState;
|
||||
use Drupal\workflow_type_test\DecoratedTransition;
|
||||
|
||||
/**
|
||||
* Test workflow type.
|
||||
*
|
||||
* @WorkflowType(
|
||||
* id = "workflow_type_complex_test",
|
||||
* label = @Translation("Workflow Type Complex Test"),
|
||||
* )
|
||||
*/
|
||||
class ComplexTestType extends WorkflowTypeBase {
|
||||
|
||||
use StringTranslationTrait;
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function decorateState(StateInterface $state) {
|
||||
if (isset($this->configuration['states'][$state->id()])) {
|
||||
$state = new DecoratedState($state, $this->configuration['states'][$state->id()]['extra']);
|
||||
}
|
||||
else {
|
||||
$state = new DecoratedState($state);
|
||||
}
|
||||
return $state;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function decorateTransition(TransitionInterface $transition) {
|
||||
if (isset($this->configuration['transitions'][$transition->id()])) {
|
||||
$transition = new DecoratedTransition($transition, $this->configuration['transitions'][$transition->id()]['extra']);
|
||||
}
|
||||
else {
|
||||
$transition = new DecoratedTransition($transition);
|
||||
}
|
||||
return $transition;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildStateConfigurationForm(FormStateInterface $form_state, WorkflowInterface $workflow, StateInterface $state = NULL) {
|
||||
/** @var \Drupal\workflow_type_test\DecoratedState $state */
|
||||
$form = [];
|
||||
$form['extra'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Extra'),
|
||||
'#description' => $this->t('Extra information added to state'),
|
||||
'#default_value' => isset($state) ? $state->getExtra() : FALSE,
|
||||
];
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildTransitionConfigurationForm(FormStateInterface $form_state, WorkflowInterface $workflow, TransitionInterface $transition = NULL) {
|
||||
/** @var \Drupal\workflow_type_test\DecoratedTransition $transition */
|
||||
$form = [];
|
||||
$form['extra'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Extra'),
|
||||
'#description' => $this->t('Extra information added to transition'),
|
||||
'#default_value' => isset($transition) ? $transition->getExtra() : FALSE,
|
||||
];
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function onDependencyRemoval(array $dependencies) {
|
||||
// Always return TRUE to allow the logic in
|
||||
// \Drupal\workflows\Entity\Workflow::onDependencyRemoval() to be tested.
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflow_type_test\Plugin\WorkflowType;
|
||||
|
||||
use Drupal\Core\StringTranslation\StringTranslationTrait;
|
||||
use Drupal\workflows\Plugin\WorkflowTypeBase;
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
|
||||
/**
|
||||
* Test workflow type.
|
||||
*
|
||||
* @WorkflowType(
|
||||
* id = "workflow_type_required_state_test",
|
||||
* label = @Translation("Required State Type Test"),
|
||||
* required_states = {
|
||||
* "fresh",
|
||||
* "rotten",
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class RequiredStateTestType extends WorkflowTypeBase {
|
||||
|
||||
use StringTranslationTrait;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function initializeWorkflow(WorkflowInterface $workflow) {
|
||||
$workflow
|
||||
->addState('fresh', $this->t('Fresh'))
|
||||
->setStateWeight('fresh', -5)
|
||||
->addState('rotten', $this->t('Rotten'))
|
||||
->addTransition('rot', $this->t('Rot'), ['fresh'], 'rotten');
|
||||
return $workflow;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function defaultConfiguration() {
|
||||
// No configuration is stored for the test type.
|
||||
return [];
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\workflow_type_test\Plugin\WorkflowType;
|
||||
|
||||
use Drupal\workflows\Plugin\WorkflowTypeBase;
|
||||
|
||||
/**
|
||||
* Test workflow type.
|
||||
*
|
||||
* @WorkflowType(
|
||||
* id = "workflow_type_test",
|
||||
* label = @Translation("Workflow Type Test"),
|
||||
* )
|
||||
*/
|
||||
class TestType extends WorkflowTypeBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function defaultConfiguration() {
|
||||
// No configuration is stored for the test type.
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getRequiredStates() {
|
||||
// Normally this is obtained from the annotation but we get from state to
|
||||
// allow dynamic testing.
|
||||
return \Drupal::state()->get('workflow_type_test.required_states', []);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
name: 'Workflow Type Test'
|
||||
type: module
|
||||
description: 'Provides a workflow type plugin for testing.'
|
||||
package: Testing
|
||||
version: VERSION
|
||||
core: 8.x
|
||||
dependencies:
|
||||
- workflows
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Functional;
|
||||
|
||||
use Drupal\Tests\BrowserTestBase;
|
||||
|
||||
/**
|
||||
* Tests workflow UI when there are no types.
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class WorkflowUiNoTypeTest extends BrowserTestBase {
|
||||
|
||||
/**
|
||||
* Modules to enable.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $modules = ['workflows', 'block'];
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
// We're testing local actions.
|
||||
$this->drupalPlaceBlock('local_actions_block');
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests the creation of a workflow through the UI.
|
||||
*/
|
||||
public function testWorkflowUiWithNoType() {
|
||||
$this->drupalLogin($this->createUser(['access administration pages', 'administer workflows']));
|
||||
$this->drupalGet('admin/config/workflow/workflows/add');
|
||||
// There are no workflow types so this should be a 403.
|
||||
$this->assertSession()->statusCodeEquals(403);
|
||||
|
||||
$this->drupalGet('admin/config/workflow/workflows');
|
||||
$this->assertSession()->pageTextContains('There are no workflow types available. In order to create workflows you need to install a module that provides a workflow type. For example, the Content Moderation module provides a workflow type that enables workflows for content entities.');
|
||||
$this->assertSession()->pageTextNotContains('Add workflow');
|
||||
|
||||
$this->container->get('module_installer')->install(['workflow_type_test']);
|
||||
// The render cache needs to be cleared because although the cache tags are
|
||||
// correctly set the render cache does not pick it up.
|
||||
\Drupal::cache('render')->deleteAll();
|
||||
|
||||
$this->drupalGet('admin/config/workflow/workflows');
|
||||
$this->assertSession()->pageTextNotContains('There are no workflow types available. In order to create workflows you need to install a module that provides a workflow type. For example, the Content Moderation module provides a workflow type that enables workflows for content entities.');
|
||||
$this->assertSession()->linkExists('Add workflow');
|
||||
$this->assertSession()->pageTextContains('There is no Workflow yet.');
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,302 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Functional;
|
||||
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\Tests\BrowserTestBase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
|
||||
/**
|
||||
* Tests workflow creation UI.
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class WorkflowUiTest extends BrowserTestBase {
|
||||
|
||||
/**
|
||||
* Modules to enable.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $modules = ['workflows', 'workflow_type_test', 'block'];
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
// We're testing local actions.
|
||||
$this->drupalPlaceBlock('local_actions_block');
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests route access/permissions.
|
||||
*/
|
||||
public function testAccess() {
|
||||
// Create a minimal workflow for testing.
|
||||
$workflow = Workflow::create(['id' => 'test', 'type' => 'workflow_type_test']);
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft', 'published'], 'published')
|
||||
->save();
|
||||
|
||||
$paths = [
|
||||
'admin/config/workflow/workflows',
|
||||
'admin/config/workflow/workflows/add',
|
||||
'admin/config/workflow/workflows/manage/test',
|
||||
'admin/config/workflow/workflows/manage/test/delete',
|
||||
'admin/config/workflow/workflows/manage/test/add_state',
|
||||
'admin/config/workflow/workflows/manage/test/state/published',
|
||||
'admin/config/workflow/workflows/manage/test/state/published/delete',
|
||||
'admin/config/workflow/workflows/manage/test/add_transition',
|
||||
'admin/config/workflow/workflows/manage/test/transition/publish',
|
||||
'admin/config/workflow/workflows/manage/test/transition/publish/delete',
|
||||
];
|
||||
|
||||
foreach ($paths as $path) {
|
||||
$this->drupalGet($path);
|
||||
// No access.
|
||||
$this->assertSession()->statusCodeEquals(403);
|
||||
}
|
||||
$this->drupalLogin($this->createUser(['administer workflows']));
|
||||
foreach ($paths as $path) {
|
||||
$this->drupalGet($path);
|
||||
// User has access.
|
||||
$this->assertSession()->statusCodeEquals(200);
|
||||
}
|
||||
|
||||
// Ensure that default states can not be deleted.
|
||||
\Drupal::state()->set('workflow_type_test.required_states', ['published']);
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/state/published/delete');
|
||||
$this->assertSession()->statusCodeEquals(403);
|
||||
\Drupal::state()->set('workflow_type_test.required_states', []);
|
||||
|
||||
// Delete one of the states and ensure the other test cannot be deleted.
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/state/published/delete');
|
||||
$this->submitForm([], 'Delete');
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/state/draft/delete');
|
||||
$this->assertSession()->statusCodeEquals(403);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests the creation of a workflow through the UI.
|
||||
*/
|
||||
public function testWorkflowCreation() {
|
||||
$workflow_storage = $this->container->get('entity_type.manager')->getStorage('workflow');
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$this->drupalLogin($this->createUser(['access administration pages', 'administer workflows']));
|
||||
$this->drupalGet('admin/config/workflow');
|
||||
$this->assertSession()->linkByHrefExists('admin/config/workflow/workflows');
|
||||
$this->clickLink('Workflows');
|
||||
$this->assertSession()->pageTextContains('Workflows');
|
||||
$this->assertSession()->pageTextContains('There is no Workflow yet.');
|
||||
$this->clickLink('Add workflow');
|
||||
$this->submitForm(['label' => 'Test', 'id' => 'test', 'workflow_type' => 'workflow_type_test'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Created the Test Workflow.');
|
||||
$this->assertSession()->addressEquals('admin/config/workflow/workflows/manage/test/add_state');
|
||||
$this->drupalGet('/admin/config/workflow/workflows/manage/test');
|
||||
$this->assertSession()->pageTextContains('This workflow has no states and will be disabled until there is at least one, add a new state.');
|
||||
$this->assertSession()->pageTextContains('There are no states yet.');
|
||||
$this->clickLink('Add a new state');
|
||||
$this->submitForm(['label' => 'Published', 'id' => 'published'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Created Published state.');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertFalse($workflow->getState('published')->canTransitionTo('published'), 'No default transition from published to published exists.');
|
||||
|
||||
$this->clickLink('Add a new state');
|
||||
// Don't create a draft to draft transition by default.
|
||||
$this->submitForm(['label' => 'Draft', 'id' => 'draft'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Created Draft state.');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertFalse($workflow->getState('draft')->canTransitionTo('draft'), 'Can not transition from draft to draft');
|
||||
|
||||
$this->clickLink('Add a new transition');
|
||||
$this->submitForm(['id' => 'publish', 'label' => 'Publish', 'from[draft]' => 'draft', 'to' => 'published'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Created Publish transition.');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertTrue($workflow->getState('draft')->canTransitionTo('published'), 'Can transition from draft to published');
|
||||
|
||||
$this->clickLink('Add a new transition');
|
||||
$this->submitForm(['id' => 'create_new_draft', 'label' => 'Create new draft', 'from[draft]' => 'draft', 'to' => 'draft'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Created Create new draft transition.');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertTrue($workflow->getState('draft')->canTransitionTo('draft'), 'Can transition from draft to draft');
|
||||
|
||||
// The fist state to edit on the page should be published.
|
||||
$this->clickLink('Edit');
|
||||
$this->assertSession()->fieldValueEquals('label', 'Published');
|
||||
// Change the label.
|
||||
$this->submitForm(['label' => 'Live'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Saved Live state.');
|
||||
|
||||
// Allow published to draft.
|
||||
$this->clickLink('Edit', 3);
|
||||
$this->submitForm(['from[published]' => 'published'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Saved Create new draft transition.');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertTrue($workflow->getState('published')->canTransitionTo('draft'), 'Can transition from published to draft');
|
||||
|
||||
// Try creating a duplicate transition.
|
||||
$this->clickLink('Add a new transition');
|
||||
$this->submitForm(['id' => 'create_new_draft', 'label' => 'Create new draft', 'from[published]' => 'published', 'to' => 'draft'], 'Save');
|
||||
$this->assertSession()->pageTextContains('The machine-readable name is already in use. It must be unique.');
|
||||
// Try creating a transition which duplicates the states of another.
|
||||
$this->submitForm(['id' => 'create_new_draft2', 'label' => 'Create new draft again', 'from[published]' => 'published', 'to' => 'draft'], 'Save');
|
||||
$this->assertSession()->pageTextContains('The transition from Live to Draft already exists.');
|
||||
|
||||
// Create a new transition.
|
||||
$this->submitForm(['id' => 'save_and_publish', 'label' => 'Save and publish', 'from[published]' => 'published', 'to' => 'published'], 'Save');
|
||||
$this->assertSession()->pageTextContains('Created Save and publish transition.');
|
||||
// Edit the new transition and try to add an existing transition.
|
||||
$this->clickLink('Edit', 4);
|
||||
$this->submitForm(['from[draft]' => 'draft'], 'Save');
|
||||
$this->assertSession()->pageTextContains('The transition from Draft to Live already exists.');
|
||||
|
||||
// Delete the transition.
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('published', 'published'), 'Can transition from published to published');
|
||||
$this->clickLink('Delete');
|
||||
$this->assertSession()->pageTextContains('Are you sure you want to delete Save and publish from Test?');
|
||||
$this->submitForm([], 'Delete');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('published', 'published'), 'Cannot transition from published to published');
|
||||
|
||||
// Try creating a duplicate state.
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test');
|
||||
$this->clickLink('Add a new state');
|
||||
$this->submitForm(['label' => 'Draft', 'id' => 'draft'], 'Save');
|
||||
$this->assertSession()->pageTextContains('The machine-readable name is already in use. It must be unique.');
|
||||
|
||||
// Ensure that weight changes the state ordering.
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertEquals('published', $workflow->getInitialState()->id());
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test');
|
||||
$this->submitForm(['states[draft][weight]' => '-1'], 'Save');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertEquals('draft', $workflow->getInitialState()->id());
|
||||
|
||||
// This will take us to the list of workflows, so we need to edit the
|
||||
// workflow again.
|
||||
$this->clickLink('Edit');
|
||||
|
||||
// Ensure that weight changes the transition ordering.
|
||||
$this->assertEquals(['publish', 'create_new_draft'], array_keys($workflow->getTransitions()));
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test');
|
||||
$this->submitForm(['transitions[create_new_draft][weight]' => '-1'], 'Save');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertEquals(['create_new_draft', 'publish'], array_keys($workflow->getTransitions()));
|
||||
|
||||
// This will take us to the list of workflows, so we need to edit the
|
||||
// workflow again.
|
||||
$this->clickLink('Edit');
|
||||
|
||||
// Ensure that a delete link for the published state exists before deleting
|
||||
// the draft state.
|
||||
$published_delete_link = Url::fromRoute('entity.workflow.delete_state_form', [
|
||||
'workflow' => $workflow->id(),
|
||||
'workflow_state' => 'published',
|
||||
])->toString();
|
||||
$draft_delete_link = Url::fromRoute('entity.workflow.delete_state_form', [
|
||||
'workflow' => $workflow->id(),
|
||||
'workflow_state' => 'draft',
|
||||
])->toString();
|
||||
$this->assertSession()->elementContains('css', 'tr[data-drupal-selector="edit-states-published"]', 'Delete');
|
||||
$this->assertSession()->linkByHrefExists($published_delete_link);
|
||||
$this->assertSession()->linkByHrefExists($draft_delete_link);
|
||||
|
||||
// Make the published state a default state and ensure it is no longer
|
||||
// linked.
|
||||
\Drupal::state()->set('workflow_type_test.required_states', ['published']);
|
||||
$this->getSession()->reload();
|
||||
$this->assertSession()->linkByHrefNotExists($published_delete_link);
|
||||
$this->assertSession()->linkByHrefExists($draft_delete_link);
|
||||
$this->assertSession()->elementNotContains('css', 'tr[data-drupal-selector="edit-states-published"]', 'Delete');
|
||||
\Drupal::state()->set('workflow_type_test.required_states', []);
|
||||
$this->getSession()->reload();
|
||||
$this->assertSession()->elementContains('css', 'tr[data-drupal-selector="edit-states-published"]', 'Delete');
|
||||
$this->assertSession()->linkByHrefExists($published_delete_link);
|
||||
$this->assertSession()->linkByHrefExists($draft_delete_link);
|
||||
|
||||
// Delete the Draft state.
|
||||
$this->clickLink('Delete');
|
||||
$this->assertSession()->pageTextContains('Are you sure you want to delete Draft from Test?');
|
||||
$this->submitForm([], 'Delete');
|
||||
$this->assertSession()->pageTextContains('State Draft deleted.');
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertFalse($workflow->hasState('draft'), 'Draft state deleted');
|
||||
$this->assertTrue($workflow->hasState('published'), 'Workflow still has published state');
|
||||
|
||||
// The last state cannot be deleted so the only delete link on the page will
|
||||
// be for the workflow.
|
||||
$this->assertSession()->linkByHrefNotExists($published_delete_link);
|
||||
$this->clickLink('Delete');
|
||||
$this->assertSession()->pageTextContains('Are you sure you want to delete Test?');
|
||||
$this->submitForm([], 'Delete');
|
||||
$this->assertSession()->pageTextContains('Workflow Test deleted.');
|
||||
$this->assertSession()->pageTextContains('There is no Workflow yet.');
|
||||
$this->assertNull($workflow_storage->loadUnchanged('test'), 'The test workflow has been deleted');
|
||||
|
||||
// Ensure that workflow types that implement
|
||||
// \Drupal\workflows\WorkflowTypeInterface::initializeWorkflow() are
|
||||
// initialized correctly.
|
||||
$this->drupalGet('admin/config/workflow/workflows');
|
||||
$this->clickLink('Add workflow');
|
||||
$this->submitForm(['label' => 'Test 2', 'id' => 'test2', 'workflow_type' => 'workflow_type_required_state_test'], 'Save');
|
||||
$this->assertSession()->addressEquals('admin/config/workflow/workflows/manage/test2');
|
||||
$workflow = $workflow_storage->loadUnchanged('test2');
|
||||
$this->assertTrue($workflow->hasState('fresh'), 'The workflow has the "fresh" state');
|
||||
$this->assertTrue($workflow->hasState('rotten'), 'The workflow has the "rotten" state');
|
||||
$this->assertTrue($workflow->hasTransition('rot'), 'The workflow has the "rot" transition');
|
||||
$this->assertSession()->pageTextContains('Fresh');
|
||||
$this->assertSession()->pageTextContains('Rotten');
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that workflow types can add form fields to states and transitions.
|
||||
*/
|
||||
public function testWorkflowDecoration() {
|
||||
// Create a minimal workflow for testing.
|
||||
$workflow = Workflow::create(['id' => 'test', 'type' => 'workflow_type_complex_test']);
|
||||
$workflow
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['published'], 'published')
|
||||
->save();
|
||||
|
||||
$this->assertEquals('', $workflow->getState('published')->getExtra());
|
||||
$this->assertEquals('', $workflow->getTransition('publish')->getExtra());
|
||||
|
||||
$this->drupalLogin($this->createUser(['administer workflows']));
|
||||
|
||||
// Add additional state information when editing.
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/state/published');
|
||||
$this->assertSession()->pageTextContains('Extra information added to state');
|
||||
$this->submitForm(['type_settings[workflow_type_complex_test][extra]' => 'Extra state information'], 'Save');
|
||||
|
||||
// Add additional transition information when editing.
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/transition/publish');
|
||||
$this->assertSession()->pageTextContains('Extra information added to transition');
|
||||
$this->submitForm(['type_settings[workflow_type_complex_test][extra]' => 'Extra transition information'], 'Save');
|
||||
|
||||
$workflow_storage = $this->container->get('entity_type.manager')->getStorage('workflow');
|
||||
/** @var \Drupal\workflows\WorkflowInterface $workflow */
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertEquals('Extra state information', $workflow->getState('published')->getExtra());
|
||||
$this->assertEquals('Extra transition information', $workflow->getTransition('publish')->getExtra());
|
||||
|
||||
// Add additional state information when adding.
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/add_state');
|
||||
$this->assertSession()->pageTextContains('Extra information added to state');
|
||||
$this->submitForm(['label' => 'Draft', 'id' => 'draft', 'type_settings[workflow_type_complex_test][extra]' => 'Extra state information on add'], 'Save');
|
||||
|
||||
// Add additional transition information when adding.
|
||||
$this->drupalGet('admin/config/workflow/workflows/manage/test/add_transition');
|
||||
$this->assertSession()->pageTextContains('Extra information added to transition');
|
||||
$this->submitForm(['id' => 'draft_published', 'label' => 'Publish', 'from[draft]' => 'draft', 'to' => 'published', 'type_settings[workflow_type_complex_test][extra]' => 'Extra transition information on add'], 'Save');
|
||||
|
||||
$workflow = $workflow_storage->loadUnchanged('test');
|
||||
$this->assertEquals('Extra state information on add', $workflow->getState('draft')->getExtra());
|
||||
$this->assertEquals('Extra transition information on add', $workflow->getTransition('draft_published')->getExtra());
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Kernel;
|
||||
|
||||
use Drupal\KernelTests\KernelTestBase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\workflow_type_test\DecoratedState;
|
||||
use Drupal\workflow_type_test\DecoratedTransition;
|
||||
|
||||
/**
|
||||
* Workflow entity tests that require modules or storage.
|
||||
*
|
||||
* @coversDefaultClass \Drupal\workflows\Entity\Workflow
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class ComplexWorkflowTypeTest extends KernelTestBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static $modules = ['workflows', 'workflow_type_test'];
|
||||
|
||||
/**
|
||||
* Tests a workflow type that decorates transitions and states.
|
||||
*
|
||||
* @covers ::getState
|
||||
* @covers ::getTransition
|
||||
*/
|
||||
public function testComplexType() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'workflow_type_complex_test'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft');
|
||||
$this->assertInstanceOf(DecoratedState::class, $workflow->getState('draft'));
|
||||
$this->assertInstanceOf(DecoratedTransition::class, $workflow->getTransition('create_new_draft'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::loadMultipleByType
|
||||
*/
|
||||
public function testLoadMultipleByType() {
|
||||
$workflow1 = new Workflow(['id' => 'test1', 'type' => 'workflow_type_complex_test'], 'workflow');
|
||||
$workflow1->save();
|
||||
$workflow2 = new Workflow(['id' => 'test2', 'type' => 'workflow_type_complex_test'], 'workflow');
|
||||
$workflow2->save();
|
||||
$workflow3 = new Workflow(['id' => 'test3', 'type' => 'workflow_type_test'], 'workflow');
|
||||
$workflow3->save();
|
||||
|
||||
$this->assertEquals(['test1', 'test2'], array_keys(Workflow::loadMultipleByType('workflow_type_complex_test')));
|
||||
$this->assertEquals(['test3'], array_keys(Workflow::loadMultipleByType('workflow_type_test')));
|
||||
$this->assertEquals([], Workflow::loadMultipleByType('a_type_that_does_not_exist'));
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Kernel;
|
||||
|
||||
use Drupal\KernelTests\KernelTestBase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\workflows\Exception\RequiredStateMissingException;
|
||||
|
||||
/**
|
||||
* Tests Workflow type's required states and configuration initialization.
|
||||
*
|
||||
* @coversDefaultClass \Drupal\workflows\Plugin\WorkflowTypeBase
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class RequiredStatesTest extends KernelTestBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static $modules = ['workflows', 'workflow_type_test'];
|
||||
|
||||
/**
|
||||
* @covers ::getRequiredStates
|
||||
* @covers ::initializeWorkflow
|
||||
* @covers ::__construct
|
||||
*/
|
||||
public function testGetRequiredStates() {
|
||||
$workflow = new Workflow([
|
||||
'id' => 'test',
|
||||
'type' => 'workflow_type_required_state_test',
|
||||
], 'workflow');
|
||||
$workflow = $workflow->getTypePlugin()->initializeWorkflow($workflow);
|
||||
$workflow->save();
|
||||
$this->assertEquals(['fresh', 'rotten'], $workflow->getTypePlugin()
|
||||
->getRequiredStates());
|
||||
|
||||
// Ensure that the workflow has the default configuration.
|
||||
$this->assertTrue($workflow->hasState('rotten'));
|
||||
$this->assertTrue($workflow->hasState('fresh'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('fresh', 'rotten'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers \Drupal\workflows\Entity\Workflow::preSave
|
||||
*/
|
||||
public function testDeleteRequiredStateAPI() {
|
||||
$workflow = new Workflow([
|
||||
'id' => 'test',
|
||||
'type' => 'workflow_type_required_state_test',
|
||||
], 'workflow');
|
||||
$workflow = $workflow->getTypePlugin()->initializeWorkflow($workflow);
|
||||
$workflow->save();
|
||||
// Ensure that required states can't be deleted.
|
||||
$this->setExpectedException(RequiredStateMissingException::class, "Required State Type Test' requires states with the ID 'fresh' in workflow 'test'");
|
||||
$workflow->deleteState('fresh')->save();
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers \Drupal\workflows\Entity\Workflow::preSave
|
||||
*/
|
||||
public function testNoStatesRequiredStateAPI() {
|
||||
$workflow = new Workflow([
|
||||
'id' => 'test',
|
||||
'type' => 'workflow_type_required_state_test',
|
||||
], 'workflow');
|
||||
$this->setExpectedException(RequiredStateMissingException::class, "Required State Type Test' requires states with the ID 'fresh', 'rotten' in workflow 'test'");
|
||||
$workflow->save();
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that initialized configuration can be changed.
|
||||
*/
|
||||
public function testChangeRequiredStateAPI() {
|
||||
$workflow = new Workflow([
|
||||
'id' => 'test',
|
||||
'type' => 'workflow_type_required_state_test',
|
||||
], 'workflow');
|
||||
$workflow = $workflow->getTypePlugin()->initializeWorkflow($workflow);
|
||||
$workflow->save();
|
||||
|
||||
// Ensure states added by default configuration can be changed.
|
||||
$this->assertEquals('Fresh', $workflow->getState('fresh')->label());
|
||||
$workflow
|
||||
->setStateLabel('fresh', 'Fresher')
|
||||
->save();
|
||||
$this->assertEquals('Fresher', $workflow->getState('fresh')->label());
|
||||
|
||||
// Ensure transitions can be altered.
|
||||
$workflow
|
||||
->addState('cooked', 'Cooked')
|
||||
->setTransitionFromStates('rot', ['fresh', 'cooked'])
|
||||
->save();
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('fresh', 'rotten'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('cooked', 'rotten'));
|
||||
|
||||
$workflow
|
||||
->setTransitionFromStates('rot', ['cooked'])
|
||||
->save();
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('fresh', 'rotten'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('cooked', 'rotten'));
|
||||
|
||||
// Ensure the default configuration does not cause ordering issues.
|
||||
$workflow->addTransition('cook', 'Cook', ['fresh'], 'cooked')->save();
|
||||
$this->assertSame([
|
||||
'cooked',
|
||||
'fresh',
|
||||
'rotten',
|
||||
], array_keys($workflow->get('states')));
|
||||
$this->assertSame([
|
||||
'cook',
|
||||
'rot',
|
||||
], array_keys($workflow->get('transitions')));
|
||||
|
||||
// Ensure that transitions can be deleted.
|
||||
$workflow->deleteTransition('rot')->save();
|
||||
$this->assertFalse($workflow->hasTransition('rot'));
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Kernel;
|
||||
|
||||
use Drupal\KernelTests\KernelTestBase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
|
||||
/**
|
||||
* Tests configuration dependencies in workflows.
|
||||
*
|
||||
* @coversDefaultClass \Drupal\workflows\Entity\Workflow
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class WorkflowDependenciesTest extends KernelTestBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static $modules = ['system', 'workflows', 'workflow_type_test', 'workflow_third_party_settings_test'];
|
||||
|
||||
/**
|
||||
* Tests \Drupal\workflows\Entity\Workflow::onDependencyRemoval().
|
||||
*/
|
||||
public function testOnDependencyRemoval() {
|
||||
// Create a workflow that has a dependency on a third party setting.
|
||||
$workflow = Workflow::create(['id' => 'test3', 'type' => 'workflow_type_complex_test']);
|
||||
$workflow->setThirdPartySetting('workflow_third_party_settings_test', 'key', 'value');
|
||||
$workflow->save();
|
||||
$this->assertSame(['workflow_third_party_settings_test', 'workflow_type_test'], $workflow->getDependencies()['module']);
|
||||
|
||||
// Uninstall workflow_third_party_settings_test to ensure
|
||||
// \Drupal\workflows\Entity\Workflow::onDependencyRemoval() works as
|
||||
// expected.
|
||||
\Drupal::service('module_installer')->uninstall(['node', 'workflow_third_party_settings_test']);
|
||||
$workflow = \Drupal::entityTypeManager()->getStorage('workflow')->loadUnchanged($workflow->id());
|
||||
$this->assertSame(['workflow_type_test'], $workflow->getDependencies()['module']);
|
||||
}
|
||||
|
||||
}
|
||||
131
web/core/modules/workflows/tests/src/Unit/StateTest.php
Normal file
131
web/core/modules/workflows/tests/src/Unit/StateTest.php
Normal file
|
|
@ -0,0 +1,131 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Unit;
|
||||
|
||||
use Drupal\Core\DependencyInjection\ContainerBuilder;
|
||||
use Drupal\Tests\UnitTestCase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\workflows\State;
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
use Drupal\workflows\WorkflowTypeInterface;
|
||||
use Drupal\workflows\WorkflowTypeManager;
|
||||
use Prophecy\Argument;
|
||||
|
||||
/**
|
||||
* @coversDefaultClass \Drupal\workflows\State
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class StateTest extends UnitTestCase {
|
||||
|
||||
/**
|
||||
* Sets up the Workflow Type manager so that workflow entities can be used.
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
// Create a container so that the plugin manager and workflow type can be
|
||||
// mocked.
|
||||
$container = new ContainerBuilder();
|
||||
$workflow_type = $this->prophesize(WorkflowTypeInterface::class);
|
||||
$workflow_type->decorateState(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->decorateTransition(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->deleteState(Argument::any())->willReturn(NULL);
|
||||
$workflow_type->deleteTransition(Argument::any())->willReturn(NULL);
|
||||
$workflow_manager = $this->prophesize(WorkflowTypeManager::class);
|
||||
$workflow_manager->createInstance('test_type', Argument::any())->willReturn($workflow_type->reveal());
|
||||
$container->set('plugin.manager.workflows.type', $workflow_manager->reveal());
|
||||
\Drupal::setContainer($container);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::__construct
|
||||
* @covers ::id
|
||||
* @covers ::label
|
||||
* @covers ::weight
|
||||
*/
|
||||
public function testGetters() {
|
||||
$state = new State(
|
||||
$this->prophesize(WorkflowInterface::class)->reveal(),
|
||||
'draft',
|
||||
'Draft',
|
||||
3
|
||||
);
|
||||
$this->assertEquals('draft', $state->id());
|
||||
$this->assertEquals('Draft', $state->label());
|
||||
$this->assertEquals(3, $state->weight());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::canTransitionTo
|
||||
*/
|
||||
public function testCanTransitionTo() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$state = $workflow->getState('draft');
|
||||
$this->assertTrue($state->canTransitionTo('published'));
|
||||
$this->assertFalse($state->canTransitionTo('some_other_state'));
|
||||
|
||||
$workflow->deleteTransition('publish');
|
||||
$this->assertFalse($state->canTransitionTo('published'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransitionTo
|
||||
*/
|
||||
public function testGetTransitionTo() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$state = $workflow->getState('draft');
|
||||
$transition = $state->getTransitionTo('published');
|
||||
$this->assertEquals('Publish', $transition->label());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransitionTo
|
||||
*/
|
||||
public function testGetTransitionToException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "Can not transition to 'published' state");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$state = $workflow->getState('draft');
|
||||
$state->getTransitionTo('published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransitions
|
||||
*/
|
||||
public function testGetTransitions() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published')
|
||||
->addTransition('archive', 'Archive', ['published'], 'archived');
|
||||
$state = $workflow->getState('draft');
|
||||
$transitions = $state->getTransitions();
|
||||
$this->assertCount(2, $transitions);
|
||||
$this->assertEquals('Create new draft', $transitions['create_new_draft']->label());
|
||||
$this->assertEquals('Publish', $transitions['publish']->label());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::labelCallback
|
||||
*/
|
||||
public function testLabelCallback() {
|
||||
$workflow = $this->prophesize(WorkflowInterface::class)->reveal();
|
||||
$states = [
|
||||
new State($workflow, 'draft', 'Draft'),
|
||||
new State($workflow, 'published', 'Published'),
|
||||
];
|
||||
$this->assertEquals(['Draft', 'Published'], array_map([State::class, 'labelCallback'], $states));
|
||||
}
|
||||
|
||||
}
|
||||
71
web/core/modules/workflows/tests/src/Unit/TransitionTest.php
Normal file
71
web/core/modules/workflows/tests/src/Unit/TransitionTest.php
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Unit;
|
||||
|
||||
use Drupal\Core\DependencyInjection\ContainerBuilder;
|
||||
use Drupal\Tests\UnitTestCase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\workflows\Transition;
|
||||
use Drupal\workflows\WorkflowInterface;
|
||||
use Drupal\workflows\WorkflowTypeInterface;
|
||||
use Drupal\workflows\WorkflowTypeManager;
|
||||
use Prophecy\Argument;
|
||||
|
||||
/**
|
||||
* @coversDefaultClass \Drupal\workflows\Transition
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class TransitionTest extends UnitTestCase {
|
||||
|
||||
/**
|
||||
* Sets up the Workflow Type manager so that workflow entities can be used.
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
// Create a container so that the plugin manager and workflow type can be
|
||||
// mocked.
|
||||
$container = new ContainerBuilder();
|
||||
$workflow_type = $this->prophesize(WorkflowTypeInterface::class);
|
||||
$workflow_type->decorateState(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->decorateTransition(Argument::any())->willReturnArgument(0);
|
||||
$workflow_manager = $this->prophesize(WorkflowTypeManager::class);
|
||||
$workflow_manager->createInstance('test_type', Argument::any())->willReturn($workflow_type->reveal());
|
||||
$container->set('plugin.manager.workflows.type', $workflow_manager->reveal());
|
||||
\Drupal::setContainer($container);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::__construct
|
||||
* @covers ::id
|
||||
* @covers ::label
|
||||
*/
|
||||
public function testGetters() {
|
||||
$state = new Transition(
|
||||
$this->prophesize(WorkflowInterface::class)->reveal(),
|
||||
'draft_published',
|
||||
'Publish',
|
||||
['draft'],
|
||||
'published'
|
||||
);
|
||||
$this->assertEquals('draft_published', $state->id());
|
||||
$this->assertEquals('Publish', $state->label());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::from
|
||||
* @covers ::to
|
||||
*/
|
||||
public function testFromAndTo() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$state = $workflow->getState('draft');
|
||||
$transition = $state->getTransitionTo('published');
|
||||
$this->assertEquals($state, $transition->from()['draft']);
|
||||
$this->assertEquals($workflow->getState('published'), $transition->to());
|
||||
}
|
||||
|
||||
}
|
||||
679
web/core/modules/workflows/tests/src/Unit/WorkflowTest.php
Normal file
679
web/core/modules/workflows/tests/src/Unit/WorkflowTest.php
Normal file
|
|
@ -0,0 +1,679 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\workflows\Unit;
|
||||
|
||||
use Drupal\Core\DependencyInjection\ContainerBuilder;
|
||||
use Drupal\Tests\UnitTestCase;
|
||||
use Drupal\workflows\Entity\Workflow;
|
||||
use Drupal\workflows\State;
|
||||
use Drupal\workflows\Transition;
|
||||
use Drupal\workflows\WorkflowTypeInterface;
|
||||
use Drupal\workflows\WorkflowTypeManager;
|
||||
use Prophecy\Argument;
|
||||
|
||||
/**
|
||||
* @coversDefaultClass \Drupal\workflows\Entity\Workflow
|
||||
*
|
||||
* @group workflows
|
||||
*/
|
||||
class WorkflowTest extends UnitTestCase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
// Create a container so that the plugin manager and workflow type can be
|
||||
// mocked.
|
||||
$container = new ContainerBuilder();
|
||||
$workflow_type = $this->prophesize(WorkflowTypeInterface::class);
|
||||
$workflow_type->decorateState(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->decorateTransition(Argument::any())->willReturnArgument(0);
|
||||
$workflow_manager = $this->prophesize(WorkflowTypeManager::class);
|
||||
$workflow_manager->createInstance('test_type', Argument::any())->willReturn($workflow_type->reveal());
|
||||
$container->set('plugin.manager.workflows.type', $workflow_manager->reveal());
|
||||
\Drupal::setContainer($container);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addState
|
||||
* @covers ::hasState
|
||||
*/
|
||||
public function testAddAndHasState() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$this->assertFalse($workflow->hasState('draft'));
|
||||
|
||||
// By default states are ordered in the order added.
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$this->assertTrue($workflow->hasState('draft'));
|
||||
$this->assertFalse($workflow->hasState('published'));
|
||||
$this->assertEquals(0, $workflow->getState('draft')->weight());
|
||||
// Adding a state does not set up a transition to itself.
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('draft', 'draft'));
|
||||
|
||||
// New states are added with a new weight 1 more than the current highest
|
||||
// weight.
|
||||
$workflow->addState('published', 'Published');
|
||||
$this->assertEquals(1, $workflow->getState('published')->weight());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addState
|
||||
*/
|
||||
public function testAddStateException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'draft' already exists in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addState
|
||||
*/
|
||||
public function testAddStateInvalidIdException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state ID 'draft-draft' must contain only lowercase letters, numbers, and underscores");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft-draft', 'Draft');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getStates
|
||||
*/
|
||||
public function testGetStates() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
|
||||
// Getting states works when there are none.
|
||||
$this->assertArrayEquals([], array_keys($workflow->getStates()));
|
||||
$this->assertArrayEquals([], array_keys($workflow->getStates([])));
|
||||
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived');
|
||||
|
||||
// States are stored in alphabetical key order.
|
||||
$this->assertArrayEquals([
|
||||
'archived',
|
||||
'draft',
|
||||
'published',
|
||||
], array_keys($workflow->get('states')));
|
||||
|
||||
// Ensure we're returning state objects.
|
||||
$this->assertInstanceOf(State::class, $workflow->getStates()['draft']);
|
||||
|
||||
// Passing in no IDs returns all states.
|
||||
$this->assertArrayEquals(['draft', 'published', 'archived'], array_keys($workflow->getStates()));
|
||||
|
||||
// The order of states is by weight.
|
||||
$workflow->setStateWeight('published', -1);
|
||||
$this->assertArrayEquals(['published', 'draft', 'archived'], array_keys($workflow->getStates()));
|
||||
|
||||
// The label is also used for sorting if weights are equal.
|
||||
$workflow->setStateWeight('archived', 0);
|
||||
$this->assertArrayEquals(['published', 'archived', 'draft'], array_keys($workflow->getStates()));
|
||||
|
||||
// You can limit the states returned by passing in states IDs.
|
||||
$this->assertArrayEquals(['archived', 'draft'], array_keys($workflow->getStates(['draft', 'archived'])));
|
||||
|
||||
// An empty array does not load all states.
|
||||
$this->assertArrayEquals([], array_keys($workflow->getStates([])));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getStates
|
||||
*/
|
||||
public function testGetStatesException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'state_that_does_not_exist' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->getStates(['state_that_does_not_exist']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getState
|
||||
*/
|
||||
public function testGetState() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
|
||||
// Ensure we're returning state objects and they are set up correctly
|
||||
$this->assertInstanceOf(State::class, $workflow->getState('draft'));
|
||||
$this->assertEquals('archived', $workflow->getState('archived')->id());
|
||||
$this->assertEquals('Archived', $workflow->getState('archived')->label());
|
||||
|
||||
$draft = $workflow->getState('draft');
|
||||
$this->assertTrue($draft->canTransitionTo('draft'));
|
||||
$this->assertTrue($draft->canTransitionTo('published'));
|
||||
$this->assertFalse($draft->canTransitionTo('archived'));
|
||||
$this->assertEquals('Publish', $draft->getTransitionTo('published')->label());
|
||||
$this->assertEquals(0, $draft->weight());
|
||||
$this->assertEquals(1, $workflow->getState('published')->weight());
|
||||
$this->assertEquals(2, $workflow->getState('archived')->weight());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getState
|
||||
*/
|
||||
public function testGetStateException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'state_that_does_not_exist' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->getState('state_that_does_not_exist');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setStateLabel
|
||||
*/
|
||||
public function testSetStateLabel() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$this->assertEquals('Draft', $workflow->getState('draft')->label());
|
||||
$workflow->setStateLabel('draft', 'Unpublished');
|
||||
$this->assertEquals('Unpublished', $workflow->getState('draft')->label());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setStateLabel
|
||||
*/
|
||||
public function testSetStateLabelException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'draft' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->setStateLabel('draft', 'Draft');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setStateWeight
|
||||
*/
|
||||
public function testSetStateWeight() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$this->assertEquals(0, $workflow->getState('draft')->weight());
|
||||
$workflow->setStateWeight('draft', -10);
|
||||
$this->assertEquals(-10, $workflow->getState('draft')->weight());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setStateWeight
|
||||
*/
|
||||
public function testSetStateWeightException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'draft' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->setStateWeight('draft', 10);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::deleteState
|
||||
*/
|
||||
public function testDeleteState() {
|
||||
// Create a container so that the plugin manager and workflow type can be
|
||||
// mocked and test that
|
||||
// \Drupal\workflows\WorkflowTypeInterface::deleteState() is called
|
||||
// correctly.
|
||||
$container = new ContainerBuilder();
|
||||
$workflow_type = $this->prophesize(WorkflowTypeInterface::class);
|
||||
$workflow_type->decorateState(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->decorateTransition(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->deleteState('draft')->shouldBeCalled();
|
||||
$workflow_type->deleteTransition('create_new_draft')->shouldBeCalled();
|
||||
$workflow_manager = $this->prophesize(WorkflowTypeManager::class);
|
||||
$workflow_manager->createInstance('test_type', Argument::any())->willReturn($workflow_type->reveal());
|
||||
$container->set('plugin.manager.workflows.type', $workflow_manager->reveal());
|
||||
\Drupal::setContainer($container);
|
||||
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft', 'published'], 'published')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft', 'published'], 'draft');
|
||||
$this->assertCount(2, $workflow->getStates());
|
||||
$this->assertCount(2, $workflow->getState('published')->getTransitions());
|
||||
$workflow->deleteState('draft');
|
||||
$this->assertFalse($workflow->hasState('draft'));
|
||||
$this->assertCount(1, $workflow->getStates());
|
||||
$this->assertCount(1, $workflow->getState('published')->getTransitions());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::deleteState
|
||||
*/
|
||||
public function testDeleteStateException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'draft' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->deleteState('draft');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::deleteState
|
||||
*/
|
||||
public function testDeleteOnlyStateException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'draft' can not be deleted from workflow 'test' as it is the only state");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$workflow->deleteState('draft');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getInitialState
|
||||
*/
|
||||
public function testGetInitialState() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived');
|
||||
|
||||
$this->assertEquals('draft', $workflow->getInitialState()->id());
|
||||
|
||||
// Make published the first state.
|
||||
$workflow->setStateWeight('published', -1);
|
||||
$this->assertEquals('published', $workflow->getInitialState()->id());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
* @covers ::hasTransition
|
||||
*/
|
||||
public function testAddTransition() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published');
|
||||
|
||||
$this->assertFalse($workflow->getState('draft')->canTransitionTo('published'));
|
||||
$workflow->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$this->assertTrue($workflow->getState('draft')->canTransitionTo('published'));
|
||||
$this->assertEquals(0, $workflow->getTransition('publish')->weight());
|
||||
$this->assertTrue($workflow->hasTransition('publish'));
|
||||
$this->assertFalse($workflow->hasTransition('draft'));
|
||||
|
||||
$workflow->addTransition('save_publish', 'Save', ['published'], 'published');
|
||||
$this->assertEquals(1, $workflow->getTransition('save_publish')->weight());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
*/
|
||||
public function testAddTransitionDuplicateException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition 'publish' already exists in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
$workflow->addTransition('publish', 'Publish', ['published'], 'published');
|
||||
$workflow->addTransition('publish', 'Publish', ['published'], 'published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
*/
|
||||
public function testAddTransitionInvalidIdException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition ID 'publish-publish' must contain only lowercase letters, numbers, and underscores");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
$workflow->addTransition('publish-publish', 'Publish', ['published'], 'published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
*/
|
||||
public function testAddTransitionMissingFromException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'draft' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
$workflow->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
*/
|
||||
public function testAddTransitionDuplicateTransitionStatesException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The 'publish' transition already allows 'draft' to 'published' transitions in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published');
|
||||
$workflow->addTransition('publish', 'Publish', ['draft', 'published'], 'published');
|
||||
$workflow->addTransition('draft_to_published', 'Publish a draft', ['draft'], 'published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
*/
|
||||
public function testAddTransitionConsistentAfterFromCatch() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
try {
|
||||
$workflow->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
}
|
||||
catch (\InvalidArgumentException $e) {
|
||||
}
|
||||
// Ensure that the workflow is not left in an inconsistent state after an
|
||||
// exception is thrown from Workflow::setTransitionFromStates() whilst
|
||||
// calling Workflow::addTransition().
|
||||
$this->assertFalse($workflow->hasTransition('publish'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::addTransition
|
||||
*/
|
||||
public function testAddTransitionMissingToException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'published' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('draft', 'Draft');
|
||||
$workflow->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransitions
|
||||
* @covers ::setTransitionWeight
|
||||
*/
|
||||
public function testGetTransitions() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
|
||||
// Getting transitions works when there are none.
|
||||
$this->assertArrayEquals([], array_keys($workflow->getTransitions()));
|
||||
$this->assertArrayEquals([], array_keys($workflow->getTransitions([])));
|
||||
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('a', 'A')
|
||||
->addState('b', 'B')
|
||||
->addTransition('a_b', 'A to B', ['a'], 'b')
|
||||
->addTransition('a_a', 'A to A', ['a'], 'a');
|
||||
|
||||
// Transitions are stored in alphabetical key order in configuration.
|
||||
$this->assertArrayEquals(['a_a', 'a_b'], array_keys($workflow->get('transitions')));
|
||||
|
||||
// Ensure we're returning transition objects.
|
||||
$this->assertInstanceOf(Transition::class, $workflow->getTransitions()['a_a']);
|
||||
|
||||
// Passing in no IDs returns all transitions.
|
||||
$this->assertArrayEquals(['a_b', 'a_a'], array_keys($workflow->getTransitions()));
|
||||
|
||||
// The order of states is by weight.
|
||||
$workflow->setTransitionWeight('a_a', -1);
|
||||
$this->assertArrayEquals(['a_a', 'a_b'], array_keys($workflow->getTransitions()));
|
||||
|
||||
// If all weights are equal it will fallback to labels.
|
||||
$workflow->setTransitionWeight('a_a', 0);
|
||||
$this->assertArrayEquals(['a_a', 'a_b'], array_keys($workflow->getTransitions()));
|
||||
$workflow->setTransitionLabel('a_b', 'A B');
|
||||
$this->assertArrayEquals(['a_b', 'a_a'], array_keys($workflow->getTransitions()));
|
||||
|
||||
// You can limit the states returned by passing in states IDs.
|
||||
$this->assertArrayEquals(['a_a'], array_keys($workflow->getTransitions(['a_a'])));
|
||||
|
||||
// An empty array does not load all states.
|
||||
$this->assertArrayEquals([], array_keys($workflow->getTransitions([])));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @covers ::getTransition
|
||||
*/
|
||||
public function testGetTransition() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
|
||||
// Ensure we're returning state objects and they are set up correctly
|
||||
$this->assertInstanceOf(Transition::class, $workflow->getTransition('create_new_draft'));
|
||||
$this->assertEquals('publish', $workflow->getTransition('publish')->id());
|
||||
$this->assertEquals('Publish', $workflow->getTransition('publish')->label());
|
||||
|
||||
$transition = $workflow->getTransition('publish');
|
||||
$this->assertEquals($workflow->getState('draft'), $transition->from()['draft']);
|
||||
$this->assertEquals($workflow->getState('published'), $transition->to());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransition
|
||||
*/
|
||||
public function testGetTransitionException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition 'transition_that_does_not_exist' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->getTransition('transition_that_does_not_exist');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransitionsForState
|
||||
*/
|
||||
public function testGetTransitionsForState() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['archived', 'draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft', 'published'], 'published')
|
||||
->addTransition('archive', 'Archive', ['published'], 'archived');
|
||||
|
||||
$this->assertEquals(['create_new_draft', 'publish'], array_keys($workflow->getTransitionsForState('draft')));
|
||||
$this->assertEquals(['create_new_draft'], array_keys($workflow->getTransitionsForState('draft', 'to')));
|
||||
$this->assertEquals(['publish', 'archive'], array_keys($workflow->getTransitionsForState('published')));
|
||||
$this->assertEquals(['publish'], array_keys($workflow->getTransitionsForState('published', 'to')));
|
||||
$this->assertEquals(['create_new_draft'], array_keys($workflow->getTransitionsForState('archived', 'from')));
|
||||
$this->assertEquals(['archive'], array_keys($workflow->getTransitionsForState('archived', 'to')));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @covers ::getTransitionFromStateToState
|
||||
* @covers ::hasTransitionFromStateToState
|
||||
*/
|
||||
public function testGetTransitionFromStateToState() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['archived', 'draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft', 'published'], 'published')
|
||||
->addTransition('archive', 'Archive', ['published'], 'archived');
|
||||
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('draft', 'published'));
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('archived', 'archived'));
|
||||
$transition = $workflow->getTransitionFromStateToState('published', 'archived');
|
||||
$this->assertEquals('Archive', $transition->label());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::getTransitionFromStateToState
|
||||
*/
|
||||
public function testGetTransitionFromStateToStateException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition from 'archived' to 'archived' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
// By default states are ordered in the order added.
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['archived', 'draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft', 'published'], 'published')
|
||||
->addTransition('archive', 'Archive', ['published'], 'archived');
|
||||
|
||||
$workflow->getTransitionFromStateToState('archived', 'archived');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionLabel
|
||||
*/
|
||||
public function testSetTransitionLabel() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$this->assertEquals('Publish', $workflow->getTransition('publish')->label());
|
||||
$workflow->setTransitionLabel('publish', 'Publish!');
|
||||
$this->assertEquals('Publish!', $workflow->getTransition('publish')->label());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionLabel
|
||||
*/
|
||||
public function testSetTransitionLabelException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition 'draft-published' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
$workflow->setTransitionLabel('draft-published', 'Publish');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionWeight
|
||||
*/
|
||||
public function testSetTransitionWeight() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$this->assertEquals(0, $workflow->getTransition('publish')->weight());
|
||||
$workflow->setTransitionWeight('publish', 10);
|
||||
$this->assertEquals(10, $workflow->getTransition('publish')->weight());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionWeight
|
||||
*/
|
||||
public function testSetTransitionWeightException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition 'draft-published' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
$workflow->setTransitionWeight('draft-published', 10);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionFromStates
|
||||
*/
|
||||
public function testSetTransitionFromStates() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('test', 'Test', ['draft'], 'draft');
|
||||
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('draft', 'draft'));
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('published', 'draft'));
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('archived', 'draft'));
|
||||
$workflow->setTransitionFromStates('test', ['draft', 'published', 'archived']);
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('draft', 'draft'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('published', 'draft'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('archived', 'draft'));
|
||||
$workflow->setTransitionFromStates('test', ['published', 'archived']);
|
||||
$this->assertFalse($workflow->hasTransitionFromStateToState('draft', 'draft'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('published', 'draft'));
|
||||
$this->assertTrue($workflow->hasTransitionFromStateToState('archived', 'draft'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionFromStates
|
||||
*/
|
||||
public function testSetTransitionFromStatesMissingTransition() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition 'test' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft');
|
||||
|
||||
$workflow->setTransitionFromStates('test', ['draft', 'published', 'archived']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionFromStates
|
||||
*/
|
||||
public function testSetTransitionFromStatesMissingState() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The state 'published' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('archived', 'Archived')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft');
|
||||
|
||||
$workflow->setTransitionFromStates('create_new_draft', ['draft', 'published', 'archived']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::setTransitionFromStates
|
||||
*/
|
||||
public function testSetTransitionFromStatesAlreadyExists() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The 'create_new_draft' transition already allows 'draft' to 'draft' transitions in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('archived', 'Archived')
|
||||
->addState('needs_review', 'Needs Review')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft')
|
||||
->addTransition('needs_review', 'Needs review', ['needs_review'], 'draft');
|
||||
|
||||
$workflow->setTransitionFromStates('needs_review', ['draft']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::deleteTransition
|
||||
*/
|
||||
public function testDeleteTransition() {
|
||||
// Create a container so that the plugin manager and workflow type can be
|
||||
// mocked and test that
|
||||
// \Drupal\workflows\WorkflowTypeInterface::deleteState() is called
|
||||
// correctly.
|
||||
$container = new ContainerBuilder();
|
||||
$workflow_type = $this->prophesize(WorkflowTypeInterface::class);
|
||||
$workflow_type->decorateState(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->decorateTransition(Argument::any())->willReturnArgument(0);
|
||||
$workflow_type->deleteTransition('publish')->shouldBeCalled();
|
||||
$workflow_manager = $this->prophesize(WorkflowTypeManager::class);
|
||||
$workflow_manager->createInstance('test_type', Argument::any())->willReturn($workflow_type->reveal());
|
||||
$container->set('plugin.manager.workflows.type', $workflow_manager->reveal());
|
||||
\Drupal::setContainer($container);
|
||||
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow
|
||||
->addState('draft', 'Draft')
|
||||
->addState('published', 'Published')
|
||||
->addTransition('create_new_draft', 'Create new draft', ['draft'], 'draft')
|
||||
->addTransition('publish', 'Publish', ['draft'], 'published');
|
||||
$this->assertTrue($workflow->getState('draft')->canTransitionTo('published'));
|
||||
$workflow->deleteTransition('publish');
|
||||
$this->assertFalse($workflow->getState('draft')->canTransitionTo('published'));
|
||||
$this->assertTrue($workflow->getState('draft')->canTransitionTo('draft'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::deleteTransition
|
||||
*/
|
||||
public function testDeleteTransitionException() {
|
||||
$this->setExpectedException(\InvalidArgumentException::class, "The transition 'draft-published' does not exist in workflow 'test'");
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$workflow->addState('published', 'Published');
|
||||
$workflow->deleteTransition('draft-published');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::status
|
||||
*/
|
||||
public function testStatus() {
|
||||
$workflow = new Workflow(['id' => 'test', 'type' => 'test_type'], 'workflow');
|
||||
$this->assertFalse($workflow->status());
|
||||
$workflow->addState('published', 'Published');
|
||||
$this->assertTrue($workflow->status());
|
||||
}
|
||||
|
||||
}
|
||||
7
web/core/modules/workflows/workflows.info.yml
Normal file
7
web/core/modules/workflows/workflows.info.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
name: 'Workflows'
|
||||
type: module
|
||||
description: 'Provides UI and API for managing workflows. This module can be used with the Content moderation module to add highly customisable workflows to content.'
|
||||
version: VERSION
|
||||
core: 8.x
|
||||
package: Core (Experimental)
|
||||
configure: entity.workflow.collection
|
||||
5
web/core/modules/workflows/workflows.links.action.yml
Normal file
5
web/core/modules/workflows/workflows.links.action.yml
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
entity.workflow.add_form:
|
||||
route_name: 'entity.workflow.add_form'
|
||||
title: 'Add workflow'
|
||||
appears_on:
|
||||
- entity.workflow.collection
|
||||
7
web/core/modules/workflows/workflows.links.menu.yml
Normal file
7
web/core/modules/workflows/workflows.links.menu.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Workflow menu items definition
|
||||
entity.workflow.collection:
|
||||
title: 'Workflows'
|
||||
route_name: entity.workflow.collection
|
||||
description: 'Configure workflows.'
|
||||
parent: system.admin_config_workflow
|
||||
|
||||
58
web/core/modules/workflows/workflows.module
Normal file
58
web/core/modules/workflows/workflows.module
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Provides hook implementations for the Workflow UI module.
|
||||
*/
|
||||
|
||||
use Drupal\Core\Routing\RouteMatchInterface;
|
||||
|
||||
use Drupal\workflows\Form\WorkflowAddForm;
|
||||
use Drupal\workflows\Form\WorkflowEditForm;
|
||||
use Drupal\workflows\Form\WorkflowDeleteForm;
|
||||
use Drupal\workflows\Form\WorkflowStateAddForm;
|
||||
use Drupal\workflows\Form\WorkflowStateEditForm;
|
||||
use Drupal\workflows\Form\WorkflowStateDeleteForm;
|
||||
use Drupal\workflows\Form\WorkflowTransitionAddForm;
|
||||
use Drupal\workflows\Form\WorkflowTransitionEditForm;
|
||||
use Drupal\workflows\Form\WorkflowTransitionDeleteForm;
|
||||
use Drupal\workflows\WorkflowListBuilder;
|
||||
|
||||
/**
|
||||
* Implements hook_help().
|
||||
*/
|
||||
function workflows_help($route_name, RouteMatchInterface $route_match) {
|
||||
switch ($route_name) {
|
||||
// Main module help for the Workflow UI module.
|
||||
case 'help.page.workflows':
|
||||
$output = '';
|
||||
$output .= '<h3>' . t('About') . '</h3>';
|
||||
$output .= '<p>' . t('The Workflows module provides a UI and an API for creating workflows content. This lets site admins define workflows and their states, and then define transitions between those states. For more information, see the <a href=":workflow">online documentation for the Workflows module</a>.', [':workflow' => 'https://www.drupal.org/documentation/modules/workflows']) . '</p>';
|
||||
return $output;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_entity_type_build().
|
||||
*/
|
||||
function workflows_entity_type_build(array &$entity_types) {
|
||||
/** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
|
||||
$entity_types['workflow']
|
||||
->setFormClass('add', WorkflowAddForm::class)
|
||||
->setFormClass('edit', WorkflowEditForm::class)
|
||||
->setFormClass('delete', WorkflowDeleteForm::class)
|
||||
->setFormClass('add-state', WorkflowStateAddForm::class)
|
||||
->setFormClass('edit-state', WorkflowStateEditForm::class)
|
||||
->setFormClass('delete-state', WorkflowStateDeleteForm::class)
|
||||
->setFormClass('add-transition', WorkflowTransitionAddForm::class)
|
||||
->setFormClass('edit-transition', WorkflowTransitionEditForm::class)
|
||||
->setFormClass('delete-transition', WorkflowTransitionDeleteForm::class)
|
||||
->setListBuilderClass(WorkflowListBuilder::class)
|
||||
->set('admin_permission', 'administer workflows')
|
||||
->setLinkTemplate('add-form', '/admin/config/workflow/workflows/add')
|
||||
->setLinkTemplate('edit-form', '/admin/config/workflow/workflows/manage/{workflow}')
|
||||
->setLinkTemplate('delete-form', '/admin/config/workflow/workflows/manage/{workflow}/delete')
|
||||
->setLinkTemplate('add-state-form', '/admin/config/workflow/workflows/manage/{workflow}/add_state')
|
||||
->setLinkTemplate('add-transition-form', '/admin/config/workflow/workflows/manage/{workflow}/add_transition')
|
||||
->setLinkTemplate('collection', '/admin/config/workflow/workflows');
|
||||
}
|
||||
4
web/core/modules/workflows/workflows.permissions.yml
Normal file
4
web/core/modules/workflows/workflows.permissions.yml
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
'administer workflows':
|
||||
title: 'Administer workflows'
|
||||
description: 'Create and edit workflows.'
|
||||
'restrict access': TRUE
|
||||
47
web/core/modules/workflows/workflows.routing.yml
Normal file
47
web/core/modules/workflows/workflows.routing.yml
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
entity.workflow.add_state_form:
|
||||
path: '/admin/config/workflow/workflows/manage/{workflow}/add_state'
|
||||
defaults:
|
||||
_entity_form: 'workflow.add-state'
|
||||
_title: 'Add state'
|
||||
requirements:
|
||||
_entity_access: 'workflow.edit'
|
||||
|
||||
entity.workflow.edit_state_form:
|
||||
path: '/admin/config/workflow/workflows/manage/{workflow}/state/{workflow_state}'
|
||||
defaults:
|
||||
_entity_form: 'workflow.edit-state'
|
||||
_title: 'Edit state'
|
||||
requirements:
|
||||
_entity_access: 'workflow.edit'
|
||||
|
||||
entity.workflow.delete_state_form:
|
||||
path: '/admin/config/workflow/workflows/manage/{workflow}/state/{workflow_state}/delete'
|
||||
defaults:
|
||||
_form: '\Drupal\workflows\Form\WorkflowStateDeleteForm'
|
||||
_title: 'Delete state'
|
||||
requirements:
|
||||
_workflow_state_delete_access: 'true'
|
||||
|
||||
entity.workflow.add_transition_form:
|
||||
path: '/admin/config/workflow/workflows/manage/{workflow}/add_transition'
|
||||
defaults:
|
||||
_entity_form: 'workflow.add-transition'
|
||||
_title: 'Add transition'
|
||||
requirements:
|
||||
_entity_access: 'workflow.edit'
|
||||
|
||||
entity.workflow.edit_transition_form:
|
||||
path: '/admin/config/workflow/workflows/manage/{workflow}/transition/{workflow_transition}'
|
||||
defaults:
|
||||
_entity_form: 'workflow.edit-transition'
|
||||
_title: 'Edit transition'
|
||||
requirements:
|
||||
_entity_access: 'workflow.edit'
|
||||
|
||||
entity.workflow.delete_transition_form:
|
||||
path: '/admin/config/workflow/workflows/manage/{workflow}/transition/{workflow_transition}/delete'
|
||||
defaults:
|
||||
_form: '\Drupal\workflows\Form\WorkflowTransitionDeleteForm'
|
||||
_title: 'Delete transition'
|
||||
requirements:
|
||||
_entity_access: 'workflow.edit'
|
||||
10
web/core/modules/workflows/workflows.services.yml
Normal file
10
web/core/modules/workflows/workflows.services.yml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
services:
|
||||
plugin.manager.workflows.type:
|
||||
class: Drupal\workflows\WorkflowTypeManager
|
||||
parent: default_plugin_manager
|
||||
tags:
|
||||
- { name: plugin_manager_cache_clear }
|
||||
workflows.access_check.delete_state:
|
||||
class: \Drupal\workflows\WorkflowDeleteAccessCheck
|
||||
tags:
|
||||
- { name: access_check, applies_to: _workflow_state_delete_access }
|
||||
Reference in a new issue