|
1 | 1 | CHANGELOG
|
2 | 2 | =========
|
3 | 3 |
|
| 4 | +6.3 |
| 5 | +--- |
| 6 | + |
| 7 | +* Add `with-metadata` option to the command `workflow:dump` to include places, |
| 8 | + transitions and workflow's metadata into dumped graph |
| 9 | + |
4 | 10 | 6.2
|
5 | 11 | ---
|
6 | 12 |
|
7 |
| - * Mark `Symfony\Component\Workflow\Registry` as internal |
8 |
| - * Deprecate calling `Definition::setInitialPlaces()` without arguments |
| 13 | +* Mark `Symfony\Component\Workflow\Registry` as internal |
| 14 | +* Deprecate calling `Definition::setInitialPlaces()` without arguments |
9 | 15 |
|
10 | 16 | 6.0
|
11 | 17 | ---
|
12 | 18 |
|
13 |
| - * Remove `InvalidTokenConfigurationException` |
| 19 | +* Remove `InvalidTokenConfigurationException` |
14 | 20 |
|
15 | 21 | 5.4
|
16 | 22 | ---
|
17 | 23 |
|
18 |
| - * Add support for getting updated context after a transition |
| 24 | +* Add support for getting updated context after a transition |
19 | 25 |
|
20 | 26 | 5.3
|
21 | 27 | ---
|
22 | 28 |
|
23 |
| - * Deprecate `InvalidTokenConfigurationException` |
24 |
| - * Added `MermaidDumper` to dump Workflow graphs in the Mermaid.js flowchart format |
| 29 | +* Deprecate `InvalidTokenConfigurationException` |
| 30 | +* Added `MermaidDumper` to dump Workflow graphs in the Mermaid.js flowchart |
| 31 | + format |
25 | 32 |
|
26 | 33 | 5.2.0
|
27 | 34 | -----
|
28 | 35 |
|
29 |
| - * Added `Workflow::getEnabledTransition()` to easily retrieve a specific transition object |
30 |
| - * Added context to the event dispatched |
31 |
| - * Dispatch an event when the subject enters in the workflow for the very first time |
32 |
| - * Added a default context to the previous event |
33 |
| - * Added support for specifying which events should be dispatched when calling `workflow->apply()` |
| 36 | +* Added `Workflow::getEnabledTransition()` to easily retrieve a specific |
| 37 | + transition object |
| 38 | +* Added context to the event dispatched |
| 39 | +* Dispatch an event when the subject enters in the workflow for the very first |
| 40 | + time |
| 41 | +* Added a default context to the previous event |
| 42 | +* Added support for specifying which events should be dispatched when |
| 43 | + calling `workflow->apply()` |
34 | 44 |
|
35 | 45 | 5.1.0
|
36 | 46 | -----
|
37 | 47 |
|
38 |
| - * Added context to `TransitionException` and its child classes whenever they are thrown in `Workflow::apply()` |
39 |
| - * Added `Registry::has()` to check if a workflow exists |
40 |
| - * Added support for `$context[Workflow::DISABLE_ANNOUNCE_EVENT] = true` when calling `workflow->apply()` to not fire the announce event |
| 48 | +* Added context to `TransitionException` and its child classes whenever they are |
| 49 | + thrown in `Workflow::apply()` |
| 50 | +* Added `Registry::has()` to check if a workflow exists |
| 51 | +* Added support for `$context[Workflow::DISABLE_ANNOUNCE_EVENT] = true` when |
| 52 | + calling `workflow->apply()` to not fire the announce event |
41 | 53 |
|
42 | 54 | 5.0.0
|
43 | 55 | -----
|
44 | 56 |
|
45 |
| - * Added argument `$context` to `MarkingStoreInterface::setMarking()` |
| 57 | +* Added argument `$context` to `MarkingStoreInterface::setMarking()` |
46 | 58 |
|
47 | 59 | 4.4.0
|
48 | 60 | -----
|
49 | 61 |
|
50 |
| - * Marked all dispatched event classes as `@final` |
| 62 | +* Marked all dispatched event classes as `@final` |
51 | 63 |
|
52 | 64 | 4.3.0
|
53 | 65 | -----
|
54 | 66 |
|
55 |
| - * Trigger `entered` event for subject entering in the Workflow for the first time. |
56 |
| - * Added a context to `Workflow::apply()`. The `MethodMarkingStore` could be used to leverage this feature. |
57 |
| - * The `TransitionEvent` is able to modify the context. |
58 |
| - * Add style to transitions by declaring metadata: |
59 |
| - |
60 |
| - use Symfony\Component\Workflow\Definition; |
61 |
| - use Symfony\Component\Workflow\Metadata\InMemoryMetadataStore; |
62 |
| - |
63 |
| - $transitionsMetadata = new \SplObjectStorage(); |
64 |
| - $transitionsMetadata[$transition] = [ |
65 |
| - 'color' => 'Red', |
66 |
| - 'arrow_color' => '#00ff00', |
67 |
| - ]; |
68 |
| - $inMemoryMetadataStore = new InMemoryMetadataStore([], [], $transitionsMetadata); |
69 |
| - |
70 |
| - return new Definition($places, $transitions, null, $inMemoryMetadataStore); |
71 |
| - * Dispatch `GuardEvent` on `workflow.guard` |
72 |
| - * Dispatch `LeaveEvent` on `workflow.leave` |
73 |
| - * Dispatch `TransitionEvent` on `workflow.transition` |
74 |
| - * Dispatch `EnterEvent` on `workflow.enter` |
75 |
| - * Dispatch `EnteredEvent` on `workflow.entered` |
76 |
| - * Dispatch `CompletedEvent` on `workflow.completed` |
77 |
| - * Dispatch `AnnounceEvent` on `workflow.announce` |
78 |
| - * Added support for many `initialPlaces` |
79 |
| - * Deprecated `DefinitionBuilder::setInitialPlace()` method, use `DefinitionBuilder::setInitialPlaces()` instead. |
80 |
| - * Deprecated the `MultipleStateMarkingStore` class, use the `MethodMarkingStore` instead. |
81 |
| - * Deprecated the `SingleStateMarkingStore` class, use the `MethodMarkingStore` instead. |
| 67 | +* Trigger `entered` event for subject entering in the Workflow for the first |
| 68 | + time. |
| 69 | +* Added a context to `Workflow::apply()`. The `MethodMarkingStore` could be used |
| 70 | + to leverage this feature. |
| 71 | +* The `TransitionEvent` is able to modify the context. |
| 72 | +* Add style to transitions by declaring metadata: |
| 73 | + |
| 74 | + use Symfony\Component\Workflow\Definition; |
| 75 | + use Symfony\Component\Workflow\Metadata\InMemoryMetadataStore; |
| 76 | + |
| 77 | + $transitionsMetadata = new \SplObjectStorage(); |
| 78 | + $transitionsMetadata[$transition] = [ |
| 79 | + 'color' => 'Red', |
| 80 | + 'arrow_color' => '#00ff00', |
| 81 | + ]; |
| 82 | + $inMemoryMetadataStore = new InMemoryMetadataStore([], [], |
| 83 | + $transitionsMetadata); |
| 84 | + |
| 85 | + return new Definition($places, $transitions, null, $inMemoryMetadataStore); |
| 86 | +* Dispatch `GuardEvent` on `workflow.guard` |
| 87 | +* Dispatch `LeaveEvent` on `workflow.leave` |
| 88 | +* Dispatch `TransitionEvent` on `workflow.transition` |
| 89 | +* Dispatch `EnterEvent` on `workflow.enter` |
| 90 | +* Dispatch `EnteredEvent` on `workflow.entered` |
| 91 | +* Dispatch `CompletedEvent` on `workflow.completed` |
| 92 | +* Dispatch `AnnounceEvent` on `workflow.announce` |
| 93 | +* Added support for many `initialPlaces` |
| 94 | +* Deprecated `DefinitionBuilder::setInitialPlace()` method, |
| 95 | + use `DefinitionBuilder::setInitialPlaces()` instead. |
| 96 | +* Deprecated the `MultipleStateMarkingStore` class, use the `MethodMarkingStore` |
| 97 | + instead. |
| 98 | +* Deprecated the `SingleStateMarkingStore` class, use the `MethodMarkingStore` |
| 99 | + instead. |
82 | 100 |
|
83 | 101 | 4.1.0
|
84 | 102 | -----
|
85 | 103 |
|
86 |
| - * Deprecated the `DefinitionBuilder::reset()` method, use the `clear()` one instead. |
87 |
| - * Deprecated the usage of `add(Workflow $workflow, $supportStrategy)` in `Workflow/Registry`, use `addWorkflow(WorkflowInterface, $supportStrategy)` instead. |
88 |
| - * Deprecated the usage of `SupportStrategyInterface`, use `WorkflowSupportStrategyInterface` instead. |
89 |
| - * The `Workflow` class now implements `WorkflowInterface`. |
90 |
| - * Deprecated the class `ClassInstanceSupportStrategy` in favor of the class `InstanceOfSupportStrategy`. |
91 |
| - * Added TransitionBlockers as a way to pass around reasons why exactly |
92 |
| - transitions can't be made. |
93 |
| - * Added a `MetadataStore`. |
94 |
| - * Added `Registry::all` to return all the workflows associated with the |
95 |
| - specific subject. |
| 104 | +* Deprecated the `DefinitionBuilder::reset()` method, use the `clear()` one |
| 105 | + instead. |
| 106 | +* Deprecated the usage of `add(Workflow $workflow, $supportStrategy)` |
| 107 | + in `Workflow/Registry`, use `addWorkflow(WorkflowInterface, $supportStrategy)` |
| 108 | + instead. |
| 109 | +* Deprecated the usage of `SupportStrategyInterface`, |
| 110 | + use `WorkflowSupportStrategyInterface` instead. |
| 111 | +* The `Workflow` class now implements `WorkflowInterface`. |
| 112 | +* Deprecated the class `ClassInstanceSupportStrategy` in favor of the |
| 113 | + class `InstanceOfSupportStrategy`. |
| 114 | +* Added TransitionBlockers as a way to pass around reasons why exactly |
| 115 | + transitions can't be made. |
| 116 | +* Added a `MetadataStore`. |
| 117 | +* Added `Registry::all` to return all the workflows associated with the |
| 118 | + specific subject. |
96 | 119 |
|
97 | 120 | 4.0.0
|
98 | 121 | -----
|
99 | 122 |
|
100 |
| - * Removed class name support in `WorkflowRegistry::add()` as second parameter. |
| 123 | +* Removed class name support in `WorkflowRegistry::add()` as second parameter. |
101 | 124 |
|
102 | 125 | 3.4.0
|
103 | 126 | -----
|
104 | 127 |
|
105 |
| - * Added guard `is_valid()` method support. |
106 |
| - * Added support for `Event::getWorkflowName()` for "announce" events. |
107 |
| - * Added `workflow.completed` events which are fired after a transition is completed. |
| 128 | +* Added guard `is_valid()` method support. |
| 129 | +* Added support for `Event::getWorkflowName()` for "announce" events. |
| 130 | +* Added `workflow.completed` events which are fired after a transition is |
| 131 | + completed. |
108 | 132 |
|
109 | 133 | 3.3.0
|
110 | 134 | -----
|
111 | 135 |
|
112 |
| - * Added support for expressions to guard transitions and added an `is_granted()` |
113 |
| - function that can be used in these expressions to use the authorization checker. |
114 |
| - * The `DefinitionBuilder` class now provides a fluent interface. |
115 |
| - * The `AuditTrailListener` now includes the workflow name in its log entries. |
116 |
| - * Added `workflow.entered` events which is fired after the marking has been set. |
117 |
| - * Deprecated class name support in `WorkflowRegistry::add()` as second parameter. |
118 |
| - Wrap the class name in an instance of ClassInstanceSupportStrategy instead. |
119 |
| - * Added support for `Event::getWorkflowName()`. |
120 |
| - * Added `SupportStrategyInterface` to allow custom strategies to decide whether |
121 |
| - or not a workflow supports a subject. |
122 |
| - * Added `ValidateWorkflowPass`. |
| 136 | +* Added support for expressions to guard transitions and added an `is_granted()` |
| 137 | + function that can be used in these expressions to use the authorization |
| 138 | + checker. |
| 139 | +* The `DefinitionBuilder` class now provides a fluent interface. |
| 140 | +* The `AuditTrailListener` now includes the workflow name in its log entries. |
| 141 | +* Added `workflow.entered` events which is fired after the marking has been set. |
| 142 | +* Deprecated class name support in `WorkflowRegistry::add()` as second |
| 143 | + parameter. |
| 144 | + Wrap the class name in an instance of ClassInstanceSupportStrategy instead. |
| 145 | +* Added support for `Event::getWorkflowName()`. |
| 146 | +* Added `SupportStrategyInterface` to allow custom strategies to decide whether |
| 147 | + or not a workflow supports a subject. |
| 148 | +* Added `ValidateWorkflowPass`. |
0 commit comments