Skip to content

[FrameworkBundle] "mappings" for validation #13878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[FrameworkBundle] "mappings" for validation #13878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5003395
[FrameworkBundle] add "mapping" configuration key at validation secti…
Oct 6, 2015
31964c0
cs fix
Oct 6, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,21 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
->then(function ($v) { return (string) $v; })
->end()
->end()
->arrayNode('mapping')
->addDefaultsIfNotSet()
->fixXmlConfig('file')
->fixXmlConfig('dir')
->children()
->arrayNode('files')
->prototype('scalar')->end()
->end()
->end()
->children()
->arrayNode('dirs')
->prototype('scalar')->end()
->end()
->end()
->end()
->end()
->end()
->end()
Expand Down
85 changes: 63 additions & 22 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,13 +752,16 @@ private function registerValidationConfiguration(array $config, ContainerBuilder

$container->setParameter('validator.translation_domain', $config['translation_domain']);

list($xmlMappings, $yamlMappings) = $this->getValidatorMappingFiles($container);
if (count($xmlMappings) > 0) {
$validatorBuilder->addMethodCall('addXmlMappings', array($xmlMappings));
$files = array('xml' => array(), 'yml' => array());
$this->getValidatorMappingFiles($container, $files);
$this->getValidatorMappingFilesFromConfig($config, $files);

if (!empty($files['xml'])) {
$validatorBuilder->addMethodCall('addXmlMappings', array($files['xml']));
}

if (count($yamlMappings) > 0) {
$validatorBuilder->addMethodCall('addYamlMappings', array($yamlMappings));
if (!empty($files['yml'])) {
$validatorBuilder->addMethodCall('addYamlMappings', array($files['yml']));
}

$definition = $container->findDefinition('validator.email');
Expand Down Expand Up @@ -790,44 +793,82 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
$container->setParameter('validator.api', '2.5-bc');
}

private function getValidatorMappingFiles(ContainerBuilder $container)
/**
* Get all validation files.
*
* @param ContainerBuilder $container A ContainerBuilder instance
* @param array $files A array reference of validation files
*/
private function getValidatorMappingFiles(ContainerBuilder $container, array &$files)
{
$files = array(array(), array());

if (interface_exists('Symfony\Component\Form\FormInterface')) {
$reflClass = new \ReflectionClass('Symfony\Component\Form\FormInterface');
$files[0][] = dirname($reflClass->getFileName()).'/Resources/config/validation.xml';
$container->addResource(new FileResource($files[0][0]));
$files['xml'][] = $file = dirname($reflClass->getFileName()).'/Resources/config/validation.xml';
$container->addResource(new FileResource($file));
}

$bundles = $container->getParameter('kernel.bundles');
foreach ($bundles as $bundle) {
$reflection = new \ReflectionClass($bundle);
$dirname = dirname($reflection->getFileName());

if (is_file($file = $dirname.'/Resources/config/validation.xml')) {
$files[0][] = realpath($file);
if (is_file($file = $dirname.'/Resources/config/validation.yml')) {
$files['yml'][] = realpath($file);
$container->addResource(new FileResource($file));
}

if (is_file($file = $dirname.'/Resources/config/validation.yml')) {
$files[1][] = realpath($file);
if (is_file($file = $dirname.'/Resources/config/validation.xml')) {
$files['xml'][] = realpath($file);
$container->addResource(new FileResource($file));
}

if (is_dir($dir = $dirname.'/Resources/config/validation')) {
foreach (Finder::create()->files()->in($dir)->name('*.xml') as $file) {
$files[0][] = $file->getRealpath();
}
foreach (Finder::create()->files()->in($dir)->name('*.yml') as $file) {
$files[1][] = $file->getRealpath();
}

$this->getValidatorMappingFilesFromDir($dir, $files);
$container->addResource(new DirectoryResource($dir));
}
}
}

return $files;
/**
* Search for validation files in directory.
*
* @param string $dir The directory that contains the validation files
* @param array $files A array reference of validation files
*/
private function getValidatorMappingFilesFromDir($dir, array &$files)
{
foreach (Finder::create()->files()->in($dir)->name('/\.xml|yml$/') as $file) {
$files[$file->getExtension()][] = $file->getRealpath();
}
}

/**
* Get all validation files from config.
*
* @param array $config A validation configuration array
* @param array $files A array reference of validation files
*/
private function getValidatorMappingFilesFromConfig(array $config, array &$files)
{
foreach ($config['mapping']['dirs'] as $dir) {
if (!is_dir($dir)) {
throw new \RuntimeException(sprintf('Could not open directory "%s".', $dir));
}
$this->getValidatorMappingFilesFromDir($dir, $files);
}

foreach ($config['mapping']['files'] as $file) {
if (!is_file($file)) {
throw new \RuntimeException(sprintf('Could not load file "%s".', $file));
}

$ext = substr($file, -3);
if ($ext !== 'xml' && $ext !== 'yml') {
throw new \RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & Yaml.', $file));
}

$files[$ext][] = realpath($file);
}
}

private function registerAnnotationsConfiguration(array $config, ContainerBuilder $container, $loader)
Expand Down
4 changes: 4 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ protected static function getBundleDefaultConfig()
'static_method' => array('loadValidatorMetadata'),
'translation_domain' => 'validators',
'strict_email' => false,
'mapping' => array(
'files' => array(),
'dirs' => array(),
),
),
'annotations' => array(
'cache' => 'file',
Expand Down
9 changes: 9 additions & 0 deletions ...Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_mapping_dirs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

$container->loadFromExtension('framework', array(
'validation' => array(
'mapping' => array(
'dirs' => array('%kernel.root_dir%/Fixtures/TestBundle/Resources/config'),
),
),
));
9 changes: 9 additions & 0 deletions ...undle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_mapping_files.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

$container->loadFromExtension('framework', array(
'validation' => array(
'mapping' => array(
'files' => array('%kernel.root_dir%/Fixtures/TestBundle/Resources/config/validation.yml'),
),
),
));
14 changes: 14 additions & 0 deletions ...Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_mapping_dirs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony">

<framework:config>
<framework:validation>
<framework:mapping>
<framework:dir>%kernel.root_dir%/Fixtures/TestBundle/Resources/config</framework:dir>
</framework:mapping>
</framework:validation>
</framework:config>
</container>
14 changes: 14 additions & 0 deletions ...undle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_mapping_files.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony">

<framework:config>
<framework:validation>
<framework:mapping>
<framework:file>%kernel.root_dir%/Fixtures/TestBundle/Resources/config/validation.yml</framework:file>
</framework:mapping>
</framework:validation>
</framework:config>
</container>
5 changes: 5 additions & 0 deletions ...Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_mapping_dirs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
framework:
validation:
mapping:
dirs:
- "%kernel.root_dir%/Fixtures/TestBundle/Resources/config"
5 changes: 5 additions & 0 deletions ...undle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_mapping_files.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
framework:
validation:
mapping:
files:
- "%kernel.root_dir%/Fixtures/TestBundle/Resources/config/validation.yml"
23 changes: 23 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,29 @@ public function testValidationNoStaticMethod()
// no cache, no annotations, no static methods
}

public function testValidationMappingFiles()
{
$container = $this->createContainerFromFile('validation_mapping_files');

$calls = $container->getDefinition('validator.builder')->getMethodCalls();

$this->assertSame('addYamlMappings', $calls[4][0]);
$this->assertCount(1, $calls[4][1][0]);
}

public function testValidationMappingDirs()
{
$container = $this->createContainerFromFile('validation_mapping_dirs');

$calls = $container->getDefinition('validator.builder')->getMethodCalls();

$this->assertSame('addXmlMappings', $calls[3][0]);
$this->assertCount(2, $calls[3][1][0]);

$this->assertSame('addYamlMappings', $calls[4][0]);
$this->assertCount(1, $calls[4][1][0]);
}

public function testFormsCanBeEnabledWithoutCsrfProtection()
{
$container = $this->createContainerFromFile('form_no_csrf');
Expand Down