summaryrefslogtreecommitdiffstatshomepage
path: root/core/modules/workflows/src/Transition.php
blob: 639f841d1c58164431342a25e9f5aad00ad200a5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?php

namespace Drupal\workflows;

/**
 * A transition value object that describes the transition between states.
 */
class Transition implements TransitionInterface {

  /**
   * The workflow that this transition is attached to.
   *
   * @var \Drupal\workflows\WorkflowTypeInterface
   */
  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\WorkflowTypeInterface $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(WorkflowTypeInterface $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;
  }

}