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

Breadcrumb

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

class CheckDefinitionValidityPass

This pass validates each definition individually only taking the information into account which is contained in the definition itself.

Later passes can rely on the following, and specifically do not need to perform these checks themselves:

  • non synthetic, non abstract services always have a class set
  • synthetic services are always public

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

Hierarchy

  • class \Symfony\Component\DependencyInjection\Compiler\CheckDefinitionValidityPass implements \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface

Expanded class hierarchy of CheckDefinitionValidityPass

File

vendor/symfony/dependency-injection/Compiler/CheckDefinitionValidityPass.php, line 31

Namespace

Symfony\Component\DependencyInjection\Compiler
View source
class CheckDefinitionValidityPass implements CompilerPassInterface {
    
    /**
     * Processes the ContainerBuilder to validate the Definition.
     *
     * @throws RuntimeException When the Definition is invalid
     */
    public function process(ContainerBuilder $container) : void {
        foreach ($container->getDefinitions() as $id => $definition) {
            // synthetic service is public
            if ($definition->isSynthetic() && !$definition->isPublic()) {
                throw new RuntimeException(\sprintf('A synthetic service ("%s") must be public.', $id));
            }
            // non-synthetic, non-abstract service has class
            if (!$definition->isAbstract() && !$definition->isSynthetic() && !$definition->getClass() && !$definition->hasTag('container.service_locator') && (!$definition->getFactory() || !preg_match(FileLoader::ANONYMOUS_ID_REGEXP, $id))) {
                if ($definition->getFactory()) {
                    throw new RuntimeException(\sprintf('Please add the class to service "%s" even if it is constructed by a factory since we might need to add method calls based on compile-time checks.', $id));
                }
                if (class_exists($id) || interface_exists($id, false)) {
                    if (str_starts_with($id, '\\') && 1 < substr_count($id, '\\')) {
                        throw new RuntimeException(\sprintf('The definition for "%s" has no class attribute, and appears to reference a class or interface. Please specify the class attribute explicitly or remove the leading backslash by renaming the service to "%s" to get rid of this error.', $id, substr($id, 1)));
                    }
                    throw new RuntimeException(\sprintf('The definition for "%s" has no class attribute, and appears to reference a class or interface in the global namespace. Leaving out the "class" attribute is only allowed for namespaced classes. Please specify the class attribute explicitly to get rid of this error.', $id));
                }
                throw new RuntimeException(\sprintf('The definition for "%s" has no class. If you intend to inject this service dynamically at runtime, please mark it as synthetic=true. If this is an abstract definition solely used by child definitions, please add abstract=true, otherwise specify a class to get rid of this error.', $id));
            }
            // tag attribute values must be scalars
            foreach ($definition->getTags() as $name => $tags) {
                foreach ($tags as $attributes) {
                    $this->validateAttributes($id, $name, $attributes);
                }
            }
            if ($definition->isPublic() && !$definition->isPrivate()) {
                $resolvedId = $container->resolveEnvPlaceholders($id, null, $usedEnvs);
                if (null !== $usedEnvs) {
                    throw new EnvParameterException([
                        $resolvedId,
                    ], null, 'A service name ("%s") cannot contain dynamic values.');
                }
            }
        }
        foreach ($container->getAliases() as $id => $alias) {
            if ($alias->isPublic() && !$alias->isPrivate()) {
                $resolvedId = $container->resolveEnvPlaceholders($id, null, $usedEnvs);
                if (null !== $usedEnvs) {
                    throw new EnvParameterException([
                        $resolvedId,
                    ], null, 'An alias name ("%s") cannot contain dynamic values.');
                }
            }
        }
    }
    private function validateAttributes(string $id, string $tag, array $attributes, array $path = []) : void {
        foreach ($attributes as $name => $value) {
            if (\is_array($value)) {
                $this->validateAttributes($id, $tag, $value, [
                    $path,
                    $name,
                ]);
            }
            elseif (!\is_scalar($value) && null !== $value) {
                $name = implode('.', [
                    $path,
                    $name,
                ]);
                throw new RuntimeException(\sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s", attribute "%s".', $id, $tag, $name));
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
CheckDefinitionValidityPass::process public function Processes the ContainerBuilder to validate the Definition. Overrides CompilerPassInterface::process
CheckDefinitionValidityPass::validateAttributes private function
RSS feed
Powered by Drupal