From 8f090bca12f3effa76e7bca28a29e1d311174cb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Pineau?= Date: Tue, 28 Mar 2017 09:52:43 +0200 Subject: [PATCH] [Workflow] Added more PHPDoc --- .../Twig/Extension/WorkflowExtension.php | 25 ++++++++++++++++--- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php b/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php index c2c5a55af9..766420a91d 100644 --- a/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php +++ b/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php @@ -35,14 +35,31 @@ class WorkflowExtension extends \Twig_Extension ); } - public function canTransition($object, $transition, $name = null) + /** + * Returns true if the transition is enabled. + * + * @param object $subject A subject + * @param string $transitionName A transition + * @param string $name A workflow name + * + * @return bool true if the transition is enabled + */ + public function canTransition($subject, $transitionName, $name = null) { - return $this->workflowRegistry->get($object, $name)->can($object, $transition); + return $this->workflowRegistry->get($subject, $name)->can($subject, $transitionName); } - public function getEnabledTransitions($object, $name = null) + /** + * Returns all enabled transitions. + * + * @param object $subject A subject + * @param string $name A workflow name + * + * @return Transition[] All enabled transitions + */ + public function getEnabledTransitions($subject, $name = null) { - return $this->workflowRegistry->get($object, $name)->getEnabledTransitions($object); + return $this->workflowRegistry->get($subject, $name)->getEnabledTransitions($subject); } public function getName()