Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Workflow] Added a way to not fire the announce event #35322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions 1 src/Symfony/Component/Workflow/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* Added context to `TransitionException` and its child classes whenever they are thrown in `Workflow::apply()`
* Added `Registry::has()` to check if a workflow exists
* Added support for `$context[Workflow::DISABLE_ANNOUNCE_EVENT] = true` when calling `workflow->apply()` to not fire the announce event

5.0.0
-----
Expand Down
24 changes: 24 additions & 0 deletions 24 src/Symfony/Component/Workflow/Tests/WorkflowTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,30 @@ public function testApplyWithEventDispatcher()
$this->assertSame($eventNameExpected, $eventDispatcher->dispatchedEvents);
}

public function provideApplyWithEventDispatcherForAnnounceTests()
{
yield [false, [Workflow::DISABLE_ANNOUNCE_EVENT => true]];
yield [true, [Workflow::DISABLE_ANNOUNCE_EVENT => false]];
yield [true, []];
}

/** @dataProvider provideApplyWithEventDispatcherForAnnounceTests */
public function testApplyWithEventDispatcherForAnnounce(bool $fired, array $context)
{
$definition = $this->createComplexWorkflowDefinition();
$subject = new Subject();
$eventDispatcher = new EventDispatcherMock();
$workflow = new Workflow($definition, new MethodMarkingStore(), $eventDispatcher, 'workflow_name');

$workflow->apply($subject, 't1', $context);

if ($fired) {
$this->assertContains('workflow.workflow_name.announce', $eventDispatcher->dispatchedEvents);
} else {
$this->assertNotContains('workflow.workflow_name.announce', $eventDispatcher->dispatchedEvents);
}
}

public function testApplyDoesNotTriggerExtraGuardWithEventDispatcher()
{
$transitions[] = new Transition('a-b', 'a', 'b');
Expand Down
6 changes: 5 additions & 1 deletion 6 src/Symfony/Component/Workflow/Workflow.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
*/
class Workflow implements WorkflowInterface
{
public const DISABLE_ANNOUNCE_EVENT = 'workflow_disable_announce_event';

private $definition;
private $markingStore;
private $dispatcher;
Expand Down Expand Up @@ -207,7 +209,9 @@ public function apply(object $subject, string $transitionName, array $context =

$this->completed($subject, $transition, $marking);

$this->announce($subject, $transition, $marking);
if (!($context[self::DISABLE_ANNOUNCE_EVENT] ?? false)) {
$this->announce($subject, $transition, $marking);
}
}

return $marking;
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.