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

Breadcrumb

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

class AutowireLocator

Autowires a service locator based on a tag name or an explicit list of key => service-type pairs.

Hierarchy

  • class \Symfony\Component\DependencyInjection\Attribute\Autowire
    • class \Symfony\Component\DependencyInjection\Attribute\AutowireLocator extends \Symfony\Component\DependencyInjection\Attribute\Autowire

Expanded class hierarchy of AutowireLocator

1 file declares its use of AutowireLocator
QueueFactory.php in core/lib/Drupal/Core/Queue/QueueFactory.php

File

vendor/symfony/dependency-injection/Attribute/AutowireLocator.php, line 25

Namespace

Symfony\Component\DependencyInjection\Attribute
View source
class AutowireLocator extends Autowire {
    
    /**
     * @see ServiceSubscriberInterface::getSubscribedServices()
     *
     * @param string|array<string|Autowire|SubscribedService> $services              A tag name or an explicit list of service ids
     * @param string|null                                     $indexAttribute        The name of the attribute that defines the key referencing each service in the locator
     * @param string|null                                     $defaultIndexMethod    The static method that should be called to get each service's key when their tag doesn't define the previous attribute
     * @param string|null                                     $defaultPriorityMethod The static method that should be called to get each service's priority when their tag doesn't define the "priority" attribute
     * @param string|array                                    $exclude               A service id or a list of service ids to exclude
     * @param bool                                            $excludeSelf           Whether to automatically exclude the referencing service from the locator
     */
    public function __construct(string|array $services, ?string $indexAttribute = null, ?string $defaultIndexMethod = null, ?string $defaultPriorityMethod = null, string|array $exclude = [], bool $excludeSelf = true) {
        if (\is_string($services)) {
            parent::__construct(new ServiceLocatorArgument(new TaggedIteratorArgument($services, $indexAttribute, $defaultIndexMethod, true, $defaultPriorityMethod, (array) $exclude, $excludeSelf)));
            return;
        }
        $references = [];
        foreach ($services as $key => $type) {
            $attributes = [];
            if ($type instanceof Autowire) {
                $references[$key] = $type;
                continue;
            }
            if ($type instanceof SubscribedService) {
                $key = $type->key ?? $key;
                $attributes = $type->attributes;
                $type = ($type->nullable ? '?' : '') . ($type->type ?? throw new InvalidArgumentException(\sprintf('When "%s" is used, a type must be set.', SubscribedService::class)));
            }
            if (!\is_string($type) || !preg_match('/(?(DEFINE)(?<cn>[a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*+))(?(DEFINE)(?<fqcn>(?&cn)(?:\\\\(?&cn))*+))^\\??(?&fqcn)(?:(?:\\|(?&fqcn))*+|(?:&(?&fqcn))*+)$/', $type)) {
                throw new InvalidArgumentException(\sprintf('"%s" is not a PHP type for key "%s".', \is_string($type) ? $type : get_debug_type($type), $key));
            }
            $optionalBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
            if ('?' === $type[0]) {
                $type = substr($type, 1);
                $optionalBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
            }
            if (\is_int($name = $key)) {
                $key = $type;
                $name = null;
            }
            $references[$key] = new TypedReference($type, $type, $optionalBehavior, $name, $attributes);
        }
        parent::__construct(new ServiceLocatorArgument($references));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Autowire::$lazy public property
Autowire::$value public property
AutowireLocator::__construct public function Overrides Autowire::__construct 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal