vendor/symfony/dependency-injection/Compiler/PassConfig.php line 38

  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\DependencyInjection\Compiler;
  14. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  16. /**
  17.  * Compiler Pass Configuration.
  18.  *
  19.  * This class has a default configuration embedded.
  20.  *
  21.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  22.  */
  23. class PassConfig
  24. {
  25.     public const TYPE_AFTER_REMOVING = 'afterRemoving';
  26.     public const TYPE_BEFORE_OPTIMIZATION = 'beforeOptimization';
  27.     public const TYPE_BEFORE_REMOVING = 'beforeRemoving';
  28.     public const TYPE_OPTIMIZE = 'optimization';
  29.     public const TYPE_REMOVE = 'removing';
  31.     private MergeExtensionConfigurationPass $mergePass;
  32.     private array $afterRemovingPasses;
  33.     private array $beforeOptimizationPasses;
  34.     private array $beforeRemovingPasses = [];
  35.     private array $optimizationPasses;
  36.     private array $removingPasses;
  38.     public function __construct()
  39.     {
  40.         $this->mergePass = new MergeExtensionConfigurationPass();
  42.         $this->beforeOptimizationPasses = [
  43.             100 => [
  44.                 new ResolveClassPass(),
  45.                 new RegisterAutoconfigureAttributesPass(),
  46.                 new AutowireAsDecoratorPass(),
  47.                 new AttributeAutoconfigurationPass(),
  48.                 new ResolveInstanceofConditionalsPass(),
  49.                 new RegisterEnvVarProcessorsPass(),
  50.             ],
  51.             -1000 => [new ExtensionCompilerPass()],
  52.         ];
  54.         $this->optimizationPasses = [[
  55.             new AutoAliasServicePass(),
  56.             new ValidateEnvPlaceholdersPass(),
  57.             new ResolveDecoratorStackPass(),
  58.             new ResolveChildDefinitionsPass(),
  59.             new RegisterServiceSubscribersPass(),
  60.             new ResolveParameterPlaceHoldersPass(false, false),
  61.             new ResolveFactoryClassPass(),
  62.             new ResolveNamedArgumentsPass(),
  63.             new AutowireRequiredMethodsPass(),
  64.             new AutowireRequiredPropertiesPass(),
  65.             new ResolveBindingsPass(),
  66.             new ServiceLocatorTagPass(),
  67.             new DecoratorServicePass(),
  68.             new CheckDefinitionValidityPass(),
  69.             new AutowirePass(false),
  70.             new ServiceLocatorTagPass(),
  71.             new ResolveTaggedIteratorArgumentPass(),
  72.             new ResolveServiceSubscribersPass(),
  73.             new ResolveReferencesToAliasesPass(),
  74.             new ResolveInvalidReferencesPass(),
  75.             new AnalyzeServiceReferencesPass(true),
  76.             new CheckCircularReferencesPass(),
  77.             new CheckReferenceValidityPass(),
  78.             new CheckArgumentsValidityPass(false),
  79.         ]];
  81.         $this->removingPasses = [[
  82.             new RemovePrivateAliasesPass(),
  83.             new ReplaceAliasByActualDefinitionPass(),
  84.             new RemoveAbstractDefinitionsPass(),
  85.             new RemoveUnusedDefinitionsPass(),
  86.             new AnalyzeServiceReferencesPass(),
  87.             new CheckExceptionOnInvalidReferenceBehaviorPass(),
  88.             new InlineServiceDefinitionsPass(new AnalyzeServiceReferencesPass()),
  89.             new AnalyzeServiceReferencesPass(),
  90.             new DefinitionErrorExceptionPass(),
  91.         ]];
  93.         $this->afterRemovingPasses = [[
  94.             new ResolveHotPathPass(),
  95.             new ResolveNoPreloadPass(),
  96.             new AliasDeprecatedPublicServicesPass(),
  97.         ]];
  98.     }
  100.     /**
  101.      * Returns all passes in order to be processed.
  102.      *
  103.      * @return CompilerPassInterface[]
  104.      */
  105.     public function getPasses(): array
  106.     {
  107.         return array_merge(
  108.             [$this->mergePass],
  109.             $this->getBeforeOptimizationPasses(),
  110.             $this->getOptimizationPasses(),
  111.             $this->getBeforeRemovingPasses(),
  112.             $this->getRemovingPasses(),
  113.             $this->getAfterRemovingPasses()
  114.         );
  115.     }
  117.     /**
  118.      * Adds a pass.
  119.      *
  120.      * @throws InvalidArgumentException when a pass type doesn't exist
  121.      */
  122.     public function addPass(CompilerPassInterface $pass, string $type = self::TYPE_BEFORE_OPTIMIZATION, int $priority = 0)
  123.     {
  124.         $property = $type.'Passes';
  125.         if (!isset($this->$property)) {
  126.             throw new InvalidArgumentException(sprintf('Invalid type "%s".', $type));
  127.         }
  129.         $passes = &$this->$property;
  131.         if (!isset($passes[$priority])) {
  132.             $passes[$priority] = [];
  133.         }
  134.         $passes[$priority][] = $pass;
  135.     }
  137.     /**
  138.      * Gets all passes for the AfterRemoving pass.
  139.      *
  140.      * @return CompilerPassInterface[]
  141.      */
  142.     public function getAfterRemovingPasses(): array
  143.     {
  144.         return $this->sortPasses($this->afterRemovingPasses);
  145.     }
  147.     /**
  148.      * Gets all passes for the BeforeOptimization pass.
  149.      *
  150.      * @return CompilerPassInterface[]
  151.      */
  152.     public function getBeforeOptimizationPasses(): array
  153.     {
  154.         return $this->sortPasses($this->beforeOptimizationPasses);
  155.     }
  157.     /**
  158.      * Gets all passes for the BeforeRemoving pass.
  159.      *
  160.      * @return CompilerPassInterface[]
  161.      */
  162.     public function getBeforeRemovingPasses(): array
  163.     {
  164.         return $this->sortPasses($this->beforeRemovingPasses);
  165.     }
  167.     /**
  168.      * Gets all passes for the Optimization pass.
  169.      *
  170.      * @return CompilerPassInterface[]
  171.      */
  172.     public function getOptimizationPasses(): array
  173.     {
  174.         return $this->sortPasses($this->optimizationPasses);
  175.     }
  177.     /**
  178.      * Gets all passes for the Removing pass.
  179.      *
  180.      * @return CompilerPassInterface[]
  181.      */
  182.     public function getRemovingPasses(): array
  183.     {
  184.         return $this->sortPasses($this->removingPasses);
  185.     }
  187.     /**
  188.      * Gets the Merge pass.
  189.      */
  190.     public function getMergePass(): CompilerPassInterface
  191.     {
  192.         return $this->mergePass;
  193.     }
  195.     public function setMergePass(CompilerPassInterface $pass)
  196.     {
  197.         $this->mergePass = $pass;
  198.     }
  200.     /**
  201.      * Sets the AfterRemoving passes.
  202.      *
  203.      * @param CompilerPassInterface[] $passes
  204.      */
  205.     public function setAfterRemovingPasses(array $passes)
  206.     {
  207.         $this->afterRemovingPasses = [$passes];
  208.     }
  210.     /**
  211.      * Sets the BeforeOptimization passes.
  212.      *
  213.      * @param CompilerPassInterface[] $passes
  214.      */
  215.     public function setBeforeOptimizationPasses(array $passes)
  216.     {
  217.         $this->beforeOptimizationPasses = [$passes];
  218.     }
  220.     /**
  221.      * Sets the BeforeRemoving passes.
  222.      *
  223.      * @param CompilerPassInterface[] $passes
  224.      */
  225.     public function setBeforeRemovingPasses(array $passes)
  226.     {
  227.         $this->beforeRemovingPasses = [$passes];
  228.     }
  230.     /**
  231.      * Sets the Optimization passes.
  232.      *
  233.      * @param CompilerPassInterface[] $passes
  234.      */
  235.     public function setOptimizationPasses(array $passes)
  236.     {
  237.         $this->optimizationPasses = [$passes];
  238.     }
  240.     /**
  241.      * Sets the Removing passes.
  242.      *
  243.      * @param CompilerPassInterface[] $passes
  244.      */
  245.     public function setRemovingPasses(array $passes)
  246.     {
  247.         $this->removingPasses = [$passes];
  248.     }
  250.     /**
  251.      * Sort passes by priority.
  252.      *
  253.      * @param array $passes CompilerPassInterface instances with their priority as key
  254.      *
  255.      * @return CompilerPassInterface[]
  256.      */
  257.     private function sortPasses(array $passes): array
  258.     {
  259.         if (0 === \count($passes)) {
  260.             return [];
  261.         }
  263.         krsort($passes);
  265.         // Flatten the array
  266.         return array_merge(...$passes);
  267.     }
  268. }