vendor/symfony/symfony/src/Symfony/Component/Workflow/Registry.php line 31

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Workflow;
  14. use Symfony\Component\Workflow\Exception\InvalidArgumentException;
  15. use Symfony\Component\Workflow\SupportStrategy\SupportStrategyInterface;
  16. use Symfony\Component\Workflow\SupportStrategy\WorkflowSupportStrategyInterface;
  18. /**
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  21.  */
  22. class Registry
  23. {
  24.     private $workflows = [];
  26.     /**
  27.      * @param SupportStrategyInterface $supportStrategy
  28.      *
  29.      * @deprecated since Symfony 4.1, use addWorkflow() instead
  30.      */
  31.     public function add(Workflow $workflow, $supportStrategy)
  32.     {
  33.         @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.1. Use addWorkflow() instead.', __METHOD__), E_USER_DEPRECATED);
  34.         $this->workflows[] = [$workflow, $supportStrategy];
  35.     }
  37.     public function addWorkflow(WorkflowInterface $workflow, WorkflowSupportStrategyInterface $supportStrategy)
  38.     {
  39.         $this->workflows[] = [$workflow, $supportStrategy];
  40.     }
  42.     /**
  43.      * @param object      $subject
  44.      * @param string|null $workflowName
  45.      *
  46.      * @return Workflow
  47.      */
  48.     public function get($subject, $workflowName = null)
  49.     {
  50.         $matched = [];
  52.         foreach ($this->workflows as list($workflow, $supportStrategy)) {
  53.             if ($this->supports($workflow, $supportStrategy, $subject, $workflowName)) {
  54.                 $matched[] = $workflow;
  55.             }
  56.         }
  58.         if (!$matched) {
  59.             throw new InvalidArgumentException(sprintf('Unable to find a workflow for class "%s".', \get_class($subject)));
  60.         }
  62.         if (2 <= \count($matched)) {
  63.             $names = array_map(static function (WorkflowInterface $workflow): string {
  64.                 return $workflow->getName();
  65.             }, $matched);
  67.             throw new InvalidArgumentException(sprintf('Too many workflows (%s) match this subject (%s); set a different name on each and use the second (name) argument of this method.', implode(', ', $names), \get_class($subject)));
  68.         }
  70.         return $matched[0];
  71.     }
  73.     /**
  74.      * @param object $subject
  75.      *
  76.      * @return Workflow[]
  77.      */
  78.     public function all($subject): array
  79.     {
  80.         $matched = [];
  81.         foreach ($this->workflows as list($workflow, $supportStrategy)) {
  82.             if ($supportStrategy->supports($workflow, $subject)) {
  83.                 $matched[] = $workflow;
  84.             }
  85.         }
  87.         return $matched;
  88.     }
  90.     /**
  91.      * @param WorkflowSupportStrategyInterface $supportStrategy
  92.      * @param object                           $subject
  93.      */
  94.     private function supports(WorkflowInterface $workflow, $supportStrategy, $subject, ?string $workflowName): bool
  95.     {
  96.         if (null !== $workflowName && $workflowName !== $workflow->getName()) {
  97.             return false;
  98.         }
  100.         return $supportStrategy->supports($workflow, $subject);
  101.     }
  102. }