Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. CheckExceptionOnInvalidReferenceBehaviorPass.php

class CheckExceptionOnInvalidReferenceBehaviorPass

Checks that all references are pointing to a valid service.

@author Johannes M. Schmitt <schmittjoh@gmail.com>

Hierarchy

  • class \Symfony\Component\DependencyInjection\Compiler\AbstractRecursivePass implements \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface
    • class \Symfony\Component\DependencyInjection\Compiler\CheckExceptionOnInvalidReferenceBehaviorPass extends \Symfony\Component\DependencyInjection\Compiler\AbstractRecursivePass

Expanded class hierarchy of CheckExceptionOnInvalidReferenceBehaviorPass

File

vendor/symfony/dependency-injection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php, line 24

Namespace

Symfony\Component\DependencyInjection\Compiler
View source
class CheckExceptionOnInvalidReferenceBehaviorPass extends AbstractRecursivePass {
    protected bool $skipScalars = true;
    private array $serviceLocatorContextIds = [];
    public function process(ContainerBuilder $container) : void {
        $this->serviceLocatorContextIds = [];
        foreach ($container->findTaggedServiceIds('container.service_locator_context') as $id => $tags) {
            $this->serviceLocatorContextIds[$id] = $tags[0]['id'];
            $container->getDefinition($id)
                ->clearTag('container.service_locator_context');
        }
        try {
            parent::process($container);
        } finally {
            $this->serviceLocatorContextIds = [];
        }
    }
    protected function processValue(mixed $value, bool $isRoot = false) : mixed {
        if (!$value instanceof Reference) {
            return parent::processValue($value, $isRoot);
        }
        if (ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE < $value->getInvalidBehavior() || $this->container
            ->has((string) $value)) {
            return $value;
        }
        $currentId = $this->currentId;
        $graph = $this->container
            ->getCompiler()
            ->getServiceReferenceGraph();
        if (isset($this->serviceLocatorContextIds[$currentId])) {
            $currentId = $this->serviceLocatorContextIds[$currentId];
            $locator = $this->container
                ->getDefinition($this->currentId)
                ->getFactory()[0];
            $this->throwServiceNotFoundException($value, $currentId, $locator->getArgument(0));
        }
        if ('.' === $currentId[0] && $graph->hasNode($currentId)) {
            foreach ($graph->getNode($currentId)
                ->getInEdges() as $edge) {
                if (!$edge->getValue() instanceof Reference || ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE < $edge->getValue()
                    ->getInvalidBehavior()) {
                    continue;
                }
                $sourceId = $edge->getSourceNode()
                    ->getId();
                if ('.' !== $sourceId[0]) {
                    $currentId = $sourceId;
                    break;
                }
                if (isset($this->serviceLocatorContextIds[$sourceId])) {
                    $currentId = $this->serviceLocatorContextIds[$sourceId];
                    $locator = $this->container
                        ->getDefinition($this->currentId);
                    $this->throwServiceNotFoundException($value, $currentId, $locator->getArgument(0));
                }
            }
        }
        $this->throwServiceNotFoundException($value, $currentId, $value);
    }
    private function throwServiceNotFoundException(Reference $ref, string $sourceId, mixed $value) : void {
        $id = (string) $ref;
        $alternatives = [];
        foreach ($this->container
            ->getServiceIds() as $knownId) {
            if ('' === $knownId || '.' === $knownId[0] || $knownId === $this->currentId) {
                continue;
            }
            $lev = levenshtein($id, $knownId);
            if ($lev <= \strlen($id) / 3 || str_contains($knownId, $id)) {
                $alternatives[] = $knownId;
            }
        }
        $pass = new class  extends AbstractRecursivePass {
            public Reference $ref;
            public string $sourceId;
            public array $alternatives;
            public function processValue(mixed $value, bool $isRoot = false) : mixed {
                if ($this->ref !== $value) {
                    return parent::processValue($value, $isRoot);
                }
                $sourceId = $this->sourceId;
                if (null !== $this->currentId && $this->currentId !== (string) $value) {
                    $sourceId = $this->currentId . '" in the container provided to "' . $sourceId;
                }
                throw new ServiceNotFoundException((string) $value, $sourceId, null, $this->alternatives);
            }

};
        $pass->ref = $ref;
        $pass->sourceId = $sourceId;
        $pass->alternatives = $alternatives;
        $pass->processValue($value, true);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractRecursivePass::$container protected property
AbstractRecursivePass::$currentId protected property
AbstractRecursivePass::$expressionLanguage private property 1
AbstractRecursivePass::$inExpression private property
AbstractRecursivePass::$processExpressions private property
AbstractRecursivePass::enableExpressionProcessing protected function
AbstractRecursivePass::getConstructor protected function
AbstractRecursivePass::getExpressionLanguage private function 1
AbstractRecursivePass::getReflectionMethod protected function
AbstractRecursivePass::inExpression protected function
CheckExceptionOnInvalidReferenceBehaviorPass::$serviceLocatorContextIds private property
CheckExceptionOnInvalidReferenceBehaviorPass::$skipScalars protected property Overrides AbstractRecursivePass::$skipScalars
CheckExceptionOnInvalidReferenceBehaviorPass::process public function You can modify the container here before it is dumped to PHP code. Overrides AbstractRecursivePass::process
CheckExceptionOnInvalidReferenceBehaviorPass::processValue protected function Processes a value found in a definition tree. Overrides AbstractRecursivePass::processValue
CheckExceptionOnInvalidReferenceBehaviorPass::throwServiceNotFoundException private function
RSS feed
Powered by Drupal