79 lines
3.0 KiB
PHP
79 lines
3.0 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony framework.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* This source file is subject to the MIT license that is bundled
|
|
* with this source code in the file LICENSE.
|
|
*/
|
|
|
|
namespace Symfony\Component\DependencyInjection\Compiler;
|
|
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
|
|
/**
|
|
* 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
|
|
* - synthetic services are always of non-prototype scope
|
|
*
|
|
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
|
|
*/
|
|
class CheckDefinitionValidityPass implements CompilerPassInterface
|
|
{
|
|
/**
|
|
* Processes the ContainerBuilder to validate the Definition.
|
|
*
|
|
* @param ContainerBuilder $container
|
|
*
|
|
* @throws \RuntimeException When the Definition is invalid
|
|
*/
|
|
public function process(ContainerBuilder $container)
|
|
{
|
|
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
|
|
));
|
|
}
|
|
|
|
// synthetic service has non-prototype scope
|
|
if ($definition->isSynthetic() && ContainerInterface::SCOPE_PROTOTYPE === $definition->getScope()) {
|
|
throw new \RuntimeException(sprintf(
|
|
'A synthetic service ("%s") cannot be of scope "prototype".',
|
|
$id
|
|
));
|
|
}
|
|
|
|
// non-synthetic, non-abstract service has class
|
|
if (!$definition->isAbstract() && !$definition->isSynthetic() && !$definition->getClass()) {
|
|
if ($definition->getFactoryClass() || $definition->getFactoryService()) {
|
|
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
|
|
));
|
|
}
|
|
|
|
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
|
|
));
|
|
}
|
|
}
|
|
}
|
|
}
|