8000 [Workflow] Event parameters by Padam87 · Pull Request #20789 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Workflow] Event parameters #20789

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

[Workflow] Event parameters #20789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
[Workflow] Event parameters
  • Loading branch information
@Padam87
Padam87 committed Dec 13, 2016
commit f44fc7c1d0acb8970cb6d9d7f9ad30bf9d4ed105
16 changes: 6 additions & 10 deletions src/Symfony/Component/Workflow/Event/Event.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,29 @@

namespace Symfony\Component\Workflow\Event;

use Symfony\Component\EventDispatcher\Event as BaseEvent;
use Symfony\Component\EventDispatcher\GenericEvent;
use Symfony\Component\Workflow\Marking;
use Symfony\Component\Workflow\Transition;

/**
* @author Fabien Potencier <fabien@symfony.com>
* @author Grégoire Pineau <lyrixx@lyrixx.info>
*/
class Event extends BaseEvent
class Event extends GenericEvent
{
private $subject;
private $marking;
private $transition;

/**
* @param object $subject
* @param Marking $marking
* @param Transition $transition
* @param array $arguments
*/
public function __construct($subject, Marking $marking, Transition $transition)
public function __construct($subject, Marking $marking, Transition $transition, array $arguments = array())
{
$this->subject = $subject;
parent::__construct($subject, $arguments);

$this->marking = $marking;
$this->transition = $transition;
}
Expand All @@ -42,11 +43,6 @@ public function getMarking()
return $this->marking;
}

public function getSubject()
{
return $this->subject;
}

public function getTransition()
{
return $this->transition;
Expand Down
20 changes: 18 additions & 2 deletions src/Symfony/Component/Workflow/Tests/WorkflowTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,21 @@ public function testApplyWithEventDispatcher()

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

$this->assertSame($eventNameExpected, $eventDispatcher->dispatchedEvents);
$this->assertSame($eventNameExpected, $eventDispatcher->dispatchedEventNames);
}

public function testApplyWithEventDispatcherAndEventArguments()
{
$definition = $this->createComplexWorkflowDefinition();
$subject = new \stdClass();
$subject->marking = null;
$eventDispatcher = new EventDispatcherMock();
$workflow = new Workflow($definition, new MultipleStateMarkingStore(), $eventDispatcher, 'workflow_name');

$arguments = array('code' => '123');
$marking = $workflow->apply($subject, 't1', $arguments);

$this->assertSame($arguments, $eventDispatcher->dispatchedEvents[0]->getArguments());
}

public function testGetEnabledTransitions()
Expand Down Expand Up @@ -214,10 +228,12 @@ public function testGetEnabledTransitions()
class EventDispatcherMock implements \Symfony\Component\EventDispatcher\EventDispatcherInterface
{
public $dispatchedEvents = array();
public $dispatchedEventNames = array();

public function dispatch($eventName, \Symfony\Component\EventDispatcher\Event $event = null)
{
$this->dispatchedEvents[] = $eventName;
$this->dispatchedEvents[] = $event;
$this->dispatchedEventNames[] = $eventName;
}

public function addListener($eventName, $listener, $priority = 0)
Expand Down
58 changes: 28 additions & 30 deletions src/Symfony/Component/Workflow/Workflow.php
View file
Open in desktop
3892
Original file line number Diff line number Diff line change
Expand Up @@ -85,50 +85,47 @@ public function getMarking($subject)
/**
* Returns true if the transition is enabled.
*
* @param object $subject A subject
* @param string $transitionName A transition
* @param object $subject A subject
* @param string $transitionName A transition
* @param array $eventArguments
*
* @return bool true if the transition is enabled
*
* @throws LogicException If the transition does not exist
*/
public function can($subject, $transitionName)
public function can($subject, $transitionName, array $eventArguments = array())
{
$transitions = $this->getTransitions($transitionName);
$marking = $this->getMarking($subject);

return null !== $this->getTransitionForSubject($subject, $marking, $transitions);
return null !== $this->getTransitionForSubject($subject, $marking, $transitions, $eventArguments);
}

/**
* Fire a transition.
*
* @param object $subject A subject
* @param string $transitionName A transition
* @param object $subject A subject
* @param string $transitionName A transition
* @param array $eventArguments
*
* @return Marking The new Marking
*
* @throws LogicException If the transition is not applicable
* @throws LogicException If the transition does not exist
*/
public function apply($subject, $transitionName)
public function apply($subject, $transitionName, array $eventArguments = array())
{
$transitions = $this->getTransitions($transitionName);
$marking = $this->getMarking($subject);

if (null === $transition = $this->getTransitionForSubject($subject, $marking, $transitions)) {
if (null === $transition = $this->getTransitionForSubject($subject, $marking, $transitions, $eventArguments)) {
throw new LogicException(sprintf('Unable to apply transition "%s" for workflow "%s".', $transitionName, $this->name));
}

$this->leave($subject, $transition, $marking);
$this->leave($subject, $transition, $marking, $eventArguments);

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

$this->enter($subject, $transition, $marking);
$this->enter($subject, $transition, $marking, $eventArguments);

$this->markingStore->setMarking($subject, $marking);

$this->announce($subject, $transition, $marking);
$this->announce($subject, $transition, $marking, $eventArguments);

return $marking;
}
Expand Down Expand Up @@ -174,13 +171,13 @@ public function getDefinition()
*
* @return bool|void boolean true if this transition is guarded, ie you cannot use it
*/
private function guardTransition($subject, Marking $marking, Transition $transition)
private function guardTransition($subject, Marking $marking, Transition $transition, array $eventArguments = array())
{
if (null === $this->dispatcher) {
return;
}

$event = new GuardEvent($subject, $marking, $transition);
$event = new GuardEvent($subject, $marking, $transition, $eventArguments);

$this->dispatcher->dispatch('workflow.guard', $event);
$this->dispatcher->dispatch(sprintf('workflow.%s.guard', $this->name), $event);
Expand All @@ -189,10 +186,10 @@ private function guardTransition($subject, Marking $marking, Transition $transit
return $event->isBlocked();
}

private function leave($subject, Transition $transition, Marking $marking)
private function leave($subject, Transition $transition, Marking $marking, array $eventArguments = array())
{
if (null !== $this->dispatcher) {
$event = new Event($subject, $marking, $transition);
$event = new Event($subject, $marking, $transition, $eventArguments);

$this->dispatcher->dispatch('workflow.leave', $event);
$this->dispatcher->dispatch(sprintf('workflow.%s.leave', $this->name), $event);
Expand All @@ -207,23 +204,23 @@ private function leave($subject, Transition $transition, Marking $marking)
}
}

private function transition($subject, Transition $transition, Marking $marking)
private function transition($subject, Transition $transition, Marking $marking, array $eventArguments = array())
{
if (null === $this->dispatcher) {
return;
}

$event = new Event($subject, $marking, $transition);
$event = new Event($subject, $marking, $transition, $eventArguments);

$this->dispatcher->dispatch('workflow.transition', $event);
$this->dispatcher->dispatch(sprintf('workflow.%s.transition', $this->name), $event);
$this->dispatcher->dispatch(sprintf('workflow.%s.transition.%s', $this->name, $transition->getName()), $event);
}

private function enter($subject, Transition $transition, Marking $marking)
private function enter($subject, Transition $transition, Marking $marking, array $eventArguments = array())
{
if (null !== $this->dispatcher) {
$event = new Event($subject, $marking, $transition);
$event = new Event($subject, $marking, $transition, $eventArguments);

$this->dispatcher->disp B2E0 atch('workflow.enter', $event);
$this->dispatcher->dispatch(sprintf('workflow.%s.enter', $this->name), $event);
Expand All @@ -238,13 +235,13 @@ private function enter($subject, Transition $transition, Marking $marking)
}
}

private function announce($subject, Transition $initialTransition, Marking $marking)
private function announce($subject, Transition $initialTransition, Marking $marking, array $eventArguments = array())
{
if (null === $this->dispatcher) {
return;
}

$event = new Event($subject, $marking, $initialTransition);
$event = new Event($subject, $marking, $initialTransition, $eventArguments);

foreach ($this->definition->getTransitions() as $transition) {
if (null !== $this->getTransitionForSubject($subject, $marking, array($transition))) {
Expand Down Expand Up @@ -281,10 +278,11 @@ private function getTransitions($transitionName)
* @param object $subject
* @param Marking $marking
* @param Transition[] $transitions
* @param array $eventArguments
*
* @return Transition|null
* @return null|Transition
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change should be reverted

*/
private function getTransitionForSubject($subject, Marking $marking, array $transitions)
private function getTransitionForSubject($subject, Marking $marking, array $transitions, array $eventArguments = array())
{
foreach ($transitions as $transition) {
foreach ($transition->getFroms() as $place) {
Expand All @@ -293,7 +291,7 @@ private function getTransitionForSubject($subject, Marking $marking, array $tran
}
}

if (true !== $this->guardTransition($subject, $marking, $transition)) {
if (true !== $this->guardTransition($subject, $marking, $transition, $eventArguments)) {
return $transition;
}
}
Expand Down
0