Skip to content

[FrameworkBundle] add email_validation_mode option #25478

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.

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

Merged
merged 1 commit into from
Dec 14, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,27 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
->arrayNode('validation')
->info('validation configuration')
->{!class_exists(FullStack::class) && class_exists(Validation::class) ? 'canBeDisabled' : 'canBeEnabled'}()
->validate()
->ifTrue(function ($v) { return isset($v['strict_email']) && isset($v['email_validation_mode']); })
->thenInvalid('"strict_email" and "email_validation_mode" cannot be used together.')
->end()
->beforeNormalization()
->ifTrue(function ($v) { return isset($v['strict_email']); })
->then(function ($v) {
@trigger_error('The "framework.validation.strict_email" configuration key has been deprecated in Symfony 4.1. Use the "framework.validation.email_validation_mode" configuration key instead.', E_USER_DEPRECATED);

return $v;
})
->end()
->beforeNormalization()
->ifTrue(function ($v) { return isset($v['strict_email']) && !isset($v['email_validation_mode']); })
->then(function ($v) {
$v['email_validation_mode'] = $v['strict_email'] ? 'strict' : 'loose';
unset($v['strict_email']);

return $v;
})
->end()
->children()
->scalarNode('cache')->end()
->booleanNode('enable_annotations')->{!class_exists(FullStack::class) && class_exists(Annotation::class) ? 'defaultTrue' : 'defaultFalse'}()->end()
Expand All @@ -658,7 +679,8 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
->end()
->end()
->scalarNode('translation_domain')->defaultValue('validators')->end()
->booleanNode('strict_email')->defaultFalse()->end()
->booleanNode('strict_email')->end()
->enumNode('email_validation_mode')->values(array('html5', 'loose', 'strict'))->end()
->arrayNode('mapping')
->addDefaultsIfNotSet()
->fixXmlConfig('path')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -976,6 +976,10 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
throw new LogicException('Validation support cannot be enabled as the Validator component is not installed.');
}

if (!isset($config['email_validation_mode'])) {
$config['email_validation_mode'] = 'loose';
}

$loader->load('validator.xml');

$validatorBuilder = $container->getDefinition('validator.builder');
Expand All @@ -994,7 +998,7 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
}

$definition = $container->findDefinition('validator.email');
$definition->replaceArgument(0, $config['strict_email']);
$definition->replaceArgument(0, $config['email_validation_mode']);

if (array_key_exists('enable_annotations', $config) && $config['enable_annotations']) {
if (!$this->annotationsConfigEnabled) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@
<xsd:attribute name="cache" type="xsd:string" />
<xsd:attribute name="enable-annotations" type="xsd:boolean" />
<xsd:attribute name="static-method" type="xsd:boolean" />
<xsd:attribute name="strict-email" type="xsd:boolean" />
Copy link
Member Author

@xabbuh xabbuh Dec 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This option must also be added in older versions too (see #25480).

<xsd:attribute name="email-validation-mode" type="email-validation-mode" />
</xsd:complexType>

<xsd:complexType name="file_mapping">
Expand All @@ -207,6 +209,14 @@
</xsd:sequence>
</xsd:complexType>

<xsd:simpleType name="email-validation-mode">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="html5" />
<xsd:enumeration value="loose" />
<xsd:enumeration value="strict" />
</xsd:restriction>
</xsd:simpleType>

<xsd:complexType name="annotations">
<xsd:attribute name="cache" type="xsd:string" />
<xsd:attribute name="debug" type="xsd:string" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,6 @@ protected static function getBundleDefaultConfig()
'enable_annotations' => !class_exists(FullStack::class),
'static_method' => array('loadValidatorMetadata'),
'translation_domain' => 'validators',
'strict_email' => false,
'mapping' => array(
'paths' => array(),
),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

$container->loadFromExtension('framework', array(
'validation' => array(
'email_validation_mode' => 'html5',
),
));
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

$container->loadFromExtension('framework', array(
'validation' => array(
'strict_email' => true,
'email_validation_mode' => 'strict',
),
));
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

$container->loadFromExtension('framework', array(
'validation' => array(
'strict_email' => false,
),
));
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

$container->loadFromExtension('framework', array(
'validation' => array(
'strict_email' => true,
),
));
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?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"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:validation email-validation-mode="html5" />
</framework:config>
</container>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?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"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:validation strict-email="true" email-validation-mode="strict" />
</framework:config>
</container>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?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"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:validation strict-email="false" />
</framework:config>
</container>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?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"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:validation strict-email="true" />
</framework:config>
</container>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
framework:
validation:
email_validation_mode: html5
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
framework:
validation:
strict_email: true
email_validation_mode: html5
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
framework:
validation:
strict_email: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
framework:
validation:
strict_email: true
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,46 @@ public function testValidationNoStaticMethod()
// no cache, no annotations, no static methods
}

/**
* @group legacy
* @expectedDeprecation The "framework.validation.strict_email" configuration key has been deprecated in Symfony 4.1. Use the "framework.validation.email_validation_mode" configuration key instead.
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage "strict_email" and "email_validation_mode" cannot be used together.
*/
public function testCannotConfigureStrictEmailAndEmailValidationModeAtTheSameTime()
{
$this->createContainerFromFile('validation_strict_email_and_validation_mode');
}

/**
* @group legacy
* @expectedDeprecation The "framework.validation.strict_email" configuration key has been deprecated in Symfony 4.1. Use the "framework.validation.email_validation_mode" configuration key instead.
*/
public function testEnabledStrictEmailOptionIsMappedToStrictEmailValidationMode()
{
$container = $this->createContainerFromFile('validation_strict_email_enabled');

$this->assertSame('strict', $container->getDefinition('validator.email')->getArgument(0));
}

/**
* @group legacy
* @expectedDeprecation The "framework.validation.strict_email" configuration key has been deprecated in Symfony 4.1. Use the "framework.validation.email_validation_mode" configuration key instead.
*/
public function testDisabledStrictEmailOptionIsMappedToLooseEmailValidationMode()
{
$container = $this->createContainerFromFile('validation_strict_email_disabled');

$this->assertSame('loose', $container->getDefinition('validator.email')->getArgument(0));
}

public function testEmailValidationModeIsPassedToEmailValidator()
{
$container = $this->createContainerFromFile('validation_email_validation_mode');

$this->assertSame('html5', $container->getDefinition('validator.email')->getArgument(0));
}

public function testValidationMapping()
{
$container = $this->createContainerFromFile('validation_mapping');
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"symfony/stopwatch": "~3.4|~4.0",
"symfony/translation": "~3.4|~4.0",
"symfony/templating": "~3.4|~4.0",
"symfony/validator": "~3.4|~4.0",
"symfony/validator": "~4.1",
"symfony/var-dumper": "~3.4|~4.0",
"symfony/workflow": "~3.4|~4.0",
"symfony/yaml": "~3.4|~4.0",
Expand All @@ -70,7 +70,7 @@
"symfony/serializer": "<3.4",
"symfony/stopwatch": "<3.4",
"symfony/translation": "<3.4",
"symfony/validator": "<3.4",
"symfony/validator": "<4.1",
"symfony/workflow": "<3.4"
},
"suggest": {
Expand Down