By Matthias Noback
Using Composer:
php composer.phar require matthiasnoback/symfony-service-definition-validator ~1
Using the service definition validator in this library, the following service definition problems can be recognized:
- Non-existing classes
- Non-existing factory methods
- Method calls to non-existing methods
- Missing required arguments for constructors
- Non-public constructor methods
- Non-static factory methods
- Missing required arguments for method calls
- Type-hint mismatches for constructor arguments (array or class/interface)
- Type-hint mismatches for method call arguments (array or class/interface)
- Syntax errors in arguments that are expressions
- Expressions that cause errors when being evaluated
This will prevent lots of run-time problems, and will warn you about inconsistencies in your service definitions early on.
I've tested the validator with the latest Symfony Standard Edition which has (of course) only valid service definitions.
Please let me know if the validator fails inside your project when it should not have failed. When you report an issue,
please attach a copy of the error message and the relevant lines in app/cache/dev/appDevDebugProjectContainer.xml.
You can use the stand-alone validator for single definitions:
<?php
use Matthias\SymfonyServiceDefinitionValidator\ServiceDefinitionValidatorFactory;
// an instance of Symfony\Component\DependencyInjection\ContainerBuilder
$containerBuilder = ...;
$validatorFactory = new ServiceDefinitionValidatorFactory();
$validator = $validatorFactory->create($containerBuilder);
// an instance of Symfony\Component\DependencyInjection\Definition
$definition = ...;
// will throw an exception for any validation error
$validator->validate($definition);To process multiple definitions at once, wrap the validator inside a batch validator:
<?php
use Matthias\SymfonyServiceDefinitionValidator\BatchServiceDefinitionValidator;
use Matthias\SymfonyServiceDefinitionValidator\Error\ValidationErrorFactory;
$batchValidator = new BatchServiceDefinitionValidator(
$validator,
new ValidationErrorFactory()
);
$errorList = $batchValidator->validate($serviceDefinitions);The resulting error list will contain errors about problematic service definitions.
To check for the validity of all your service definitions at compile time, add the ValidateServiceDefinitionsPass
compiler pass to the ContainerBuilder instance:
<?php
use Matthias\SymfonyServiceDefinitionValidator\Compiler\ValidateServiceDefinitionsPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\PassConfig;
class SomeBundle extends Bundle
{
public function build(ContainerBuilder $container)
{
if ($container->getParameter('kernel.debug')) {
$container->addCompilerPass(
new ValidateServiceDefinitionsPass(),
PassConfig::TYPE_AFTER_REMOVING
);
}
}
}This compiler pass will throw an exception. The message of this exception will contain a list of invalid service definitions.
Both ValidateServiceDefinitionsPass and ServiceDefinitionValidatorFactory accept a Configuration object.
It allows you to configure whether or not expression arguments should be evaluated. Since evaluating expressions can
cause all kinds of runtime errors, it is off by default, but you can easily turn it on:
<?php
use Matthias\SymfonyServiceDefinitionValidator\Configuration;
use Matthias\SymfonyServiceDefinitionValidator\Compiler\ValidateServiceDefinitionsPass;
$configuration = new Configuration();
$configuration->setEvaluateExpressions(true);
$compilerPass = new ValidateServiceDefinitionsPass($configuration);
// or
$validatorFactory = new ServiceDefinitionValidatorFactory($configuration);When the validator finds a problem with one of the service definitions that is your own, you can of course fix the problem yourself, but when the invalid service definition is defined in some other bundle, you can still fix problems by dynamically modifying the service definition. First you need to create a compiler pass:
<?php
namespace YourBundle\DependencyInjection\Compiler;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
class FixInvalidServiceDefinitionPass implements CompilerPassInterface
{
public function process(ContainerBuilder $container)
{
// find the bad definition:
$invalidDefinition = $container->findDefinition('the_service_id');
// for example, fix the class
$invalidDefinition->setClass('TheRightClass');
}
}After you have selected the invalid service definition, you can modify it in any way you like. For a list of everything
you can do with Definition objects, see
http://symfony.com/doc/master/components/dependency_injection/definitions.html.
Don't forget to register the compiler pass in your bundle class:
<?php
namespace MyBundle;
use Symfony\Component\HttpKernel\Bundle\Bundle;
use Symfony\Component\DependencyInjection\ContainerBuilder;
class MyBundle extends Bundle
{
public function build(ContainerBuilder $container)
{
if ($container->getParameter('kernel.debug')) {
$container->addCompilerPass(new FixInvalidServiceDefinitionPass());
}
}
}