117 lines
3.8 KiB
PHP
117 lines
3.8 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Bridge\Twig\Extension;
|
|
|
|
use Symfony\Component\Workflow\Registry;
|
|
use Symfony\Component\Workflow\Transition;
|
|
use Symfony\Component\Workflow\TransitionBlockerList;
|
|
use Twig\Extension\AbstractExtension;
|
|
use Twig\TwigFunction;
|
|
|
|
/**
|
|
* WorkflowExtension.
|
|
*
|
|
* @author Grégoire Pineau <lyrixx@lyrixx.info>
|
|
* @author Carlos Pereira De Amorim <carlos@shauri.fr>
|
|
*/
|
|
final class WorkflowExtension extends AbstractExtension
|
|
{
|
|
public function __construct(
|
|
private Registry $workflowRegistry,
|
|
) {
|
|
}
|
|
|
|
public function getFunctions(): array
|
|
{
|
|
return [
|
|
new TwigFunction('workflow_can', $this->canTransition(...)),
|
|
new TwigFunction('workflow_transitions', $this->getEnabledTransitions(...)),
|
|
new TwigFunction('workflow_transition', $this->getEnabledTransition(...)),
|
|
new TwigFunction('workflow_has_marked_place', $this->hasMarkedPlace(...)),
|
|
new TwigFunction('workflow_marked_places', $this->getMarkedPlaces(...)),
|
|
new TwigFunction('workflow_metadata', $this->getMetadata(...)),
|
|
new TwigFunction('workflow_transition_blockers', $this->buildTransitionBlockerList(...)),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns true if the transition is enabled.
|
|
*/
|
|
public function canTransition(object $subject, string $transitionName, ?string $name = null): bool
|
|
{
|
|
return $this->workflowRegistry->get($subject, $name)->can($subject, $transitionName);
|
|
}
|
|
|
|
/**
|
|
* Returns all enabled transitions.
|
|
*
|
|
* @return Transition[]
|
|
*/
|
|
public function getEnabledTransitions(object $subject, ?string $name = null): array
|
|
{
|
|
return $this->workflowRegistry->get($subject, $name)->getEnabledTransitions($subject);
|
|
}
|
|
|
|
public function getEnabledTransition(object $subject, string $transition, ?string $name = null): ?Transition
|
|
{
|
|
return $this->workflowRegistry->get($subject, $name)->getEnabledTransition($subject, $transition);
|
|
}
|
|
|
|
/**
|
|
* Returns true if the place is marked.
|
|
*/
|
|
public function hasMarkedPlace(object $subject, string $placeName, ?string $name = null): bool
|
|
{
|
|
return $this->workflowRegistry->get($subject, $name)->getMarking($subject)->has($placeName);
|
|
}
|
|
|
|
/**
|
|
* Returns marked places.
|
|
*
|
|
* @return string[]|int[]
|
|
*/
|
|
public function getMarkedPlaces(object $subject, bool $placesNameOnly = true, ?string $name = null): array
|
|
{
|
|
$places = $this->workflowRegistry->get($subject, $name)->getMarking($subject)->getPlaces();
|
|
|
|
if ($placesNameOnly) {
|
|
return array_keys($places);
|
|
}
|
|
|
|
return $places;
|
|
}
|
|
|
|
/**
|
|
* Returns the metadata for a specific subject.
|
|
*
|
|
* @param string|Transition|null $metadataSubject Use null to get workflow metadata
|
|
* Use a string (the place name) to get place metadata
|
|
* Use a Transition instance to get transition metadata
|
|
*/
|
|
public function getMetadata(object $subject, string $key, string|Transition|null $metadataSubject = null, ?string $name = null): mixed
|
|
{
|
|
return $this
|
|
->workflowRegistry
|
|
->get($subject, $name)
|
|
->getMetadataStore()
|
|
->getMetadata($key, $metadataSubject)
|
|
;
|
|
}
|
|
|
|
public function buildTransitionBlockerList(object $subject, string $transitionName, ?string $name = null): TransitionBlockerList
|
|
{
|
|
$workflow = $this->workflowRegistry->get($subject, $name);
|
|
|
|
return $workflow->buildTransitionBlockerList($subject, $transitionName);
|
|
}
|
|
}
|