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

Breadcrumb

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

class RemoveEmptyControllerArgumentLocatorsPass

Removes empty service-locators registered for ServiceValueResolver.

@author Nicolas Grekas <p@tchwork.com>

Hierarchy

  • class \Symfony\Component\HttpKernel\DependencyInjection\RemoveEmptyControllerArgumentLocatorsPass implements \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface

Expanded class hierarchy of RemoveEmptyControllerArgumentLocatorsPass

File

vendor/symfony/http-kernel/DependencyInjection/RemoveEmptyControllerArgumentLocatorsPass.php, line 22

Namespace

Symfony\Component\HttpKernel\DependencyInjection
View source
class RemoveEmptyControllerArgumentLocatorsPass implements CompilerPassInterface {
    public function process(ContainerBuilder $container) : void {
        $controllerLocator = $container->findDefinition('argument_resolver.controller_locator');
        $controllers = $controllerLocator->getArgument(0);
        foreach ($controllers as $controller => $argumentRef) {
            $argumentLocator = $container->getDefinition((string) $argumentRef->getValues()[0]);
            if ($argumentLocator->getFactory()) {
                $argumentLocator = $container->getDefinition($argumentLocator->getFactory()[0]);
            }
            if (!$argumentLocator->getArgument(0)) {
                // remove empty argument locators
                $reason = \sprintf('Removing service-argument resolver for controller "%s": no corresponding services exist for the referenced types.', $controller);
            }
            else {
                // any methods listed for call-at-instantiation cannot be actions
                $reason = false;
                [
                    $id,
                    $action,
                ] = explode('::', $controller);
                if ($container->hasAlias($id)) {
                    continue;
                }
                $controllerDef = $container->getDefinition($id);
                foreach ($controllerDef->getMethodCalls() as [
                    $method,
                ]) {
                    if (0 === strcasecmp($action, $method)) {
                        $reason = \sprintf('Removing method "%s" of service "%s" from controller candidates: the method is called at instantiation, thus cannot be an action.', $action, $id);
                        break;
                    }
                }
                if (!$reason) {
                    // see Symfony\Component\HttpKernel\Controller\ContainerControllerResolver
                    $controllers[$id . ':' . $action] = $argumentRef;
                    if ('__invoke' === $action) {
                        $controllers[$id] = $argumentRef;
                    }
                    continue;
                }
            }
            unset($controllers[$controller]);
            $container->log($this, $reason);
        }
        $controllerLocator->replaceArgument(0, $controllers);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
RemoveEmptyControllerArgumentLocatorsPass::process public function You can modify the container here before it is dumped to PHP code. Overrides CompilerPassInterface::process
RSS feed
Powered by Drupal