diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Validator] Changed GroupSequenceProvider implementation

Browse Source
This commit is contained in:
Sebastian Hörl 2012-01-28 22:10:33 +01:00
parent 6c4455fef7
commit c3b04a3336
18 changed files with 66 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/Symfony/Component/Validator/Constraints/GroupSequenceProvider.php
View File

@ -19,13 +19,13 @@ namespace Symfony\Component\Validator\Constraints;
class GroupSequenceProvider
{
/**
* The name of the provider class
* @var string
* True if the group sequence provider should be used
* @var boolean
*/
public $class;
public $active;
public function __construct(array $options)
{
$this->class = $options['value'];
$this->active = (bool)$options['value'];
}
}

8
src/Symfony/Component/Validator/GraphWalker.php
View File

@ -17,6 +17,7 @@ use Symfony\Component\Validator\Exception\UnexpectedTypeException;
use Symfony\Component\Validator\Mapping\ClassMetadataFactoryInterface;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Mapping\MemberMetadata;
use Symfony\Component\Validator\GroupSequenceProviderInterface;
/**
* Responsible for walking over and initializing validation on different
@ -68,10 +69,11 @@ class GraphWalker
}
if ($group === Constraint::DEFAULT_GROUP && ($metadata->hasGroupSequence() || $metadata->hasGroupSequenceProvider())) {
$groups = $metadata->getGroupSequence();
if ($groupSequenceProvider = $metadata->getGroupSequenceProvider()) {
$groups = $groupSequenceProvider->getValidationGroups($object);
if ($metadata->hasGroupSequence()) {
$groups = $metadata->getGroupSequence();
} else {
$groups = $object->getValidationGroups();
}
foreach ($groups as $group) {

4
src/Symfony/Component/Validator/GroupSequenceProviderInterface.php
View File

@ -20,9 +20,7 @@ interface GroupSequenceProviderInterface
* Returns which validation groups should be used for a certain state
* of the object.
*
* @param mixed $object The object that is validated.
*
* @return array An array of validation groups
*/
function getValidationGroups($object);
function getValidationGroups();
}

70
src/Symfony/Component/Validator/Mapping/ClassMetadata.php
View File

@ -14,7 +14,6 @@ namespace Symfony\Component\Validator\Mapping;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
use Symfony\Component\Validator\Exception\GroupDefinitionException;
use Symfony\Component\Validator\GroupSequenceProviderInterface;
/**
* Represents all the configured constraints on a given class.
@ -30,8 +29,7 @@ class ClassMetadata extends ElementMetadata
public $properties = array();
public $getters = array();
public $groupSequence = array();
public $groupSequenceProviderClass;
public $groupSequenceProvider;
public $groupSequenceProvider = false;
private $reflClass;
/**
@ -60,7 +58,7 @@ class ClassMetadata extends ElementMetadata
return array_merge(parent::__sleep(), array(
'getters',
'groupSequence',
'groupSequenceProviderClass',
'groupSequenceProvider',
'members',
'name',
'properties',
@ -251,6 +249,10 @@ class ClassMetadata extends ElementMetadata
*/
public function setGroupSequence(array $groups)
{
if ($this->hasGroupSequenceProvider()) {
throw new GroupDefinitionException('Defining a static group sequence is not allowed with a group sequence provider');
}
if (in_array(Constraint::DEFAULT_GROUP, $groups, true)) {
throw new GroupDefinitionException(sprintf('The group "%s" is not allowed in group sequences', Constraint::DEFAULT_GROUP));
}
@ -299,64 +301,30 @@ class ClassMetadata extends ElementMetadata
}
/**
* Sets the class name of the group sequence provider.
* Sets whether a group sequence provider should be used
*
* @param string $class Sequence provider class name
* @param boolean $active
*/
public function setGroupSequenceProviderClass($class)
public function setGroupSequenceProvider($active)
{
$this->groupSequenceProviderClass = $class;
$this->groupSequenceProvider = null;
if ($this->hasGroupSequenceProvider()) {
throw new GroupDefinitionException('Defining a group sequence provider is not allowed with a static group sequence');
}
if (!$this->getReflectionClass()->implementsInterface('Symfony\Component\Validator\GroupSequenceProviderInterface')) {
throw new GroupDefinitionException(sprintf('Class "%s" must implement GroupSequenceProviderInterface', $this->name));
}
$this->groupSequenceProvider = $active;
}
/**
* Returns the name of the group sequence provider class.
*
* @return string Class name
*/
public function getGroupSequenceProviderClass()
{
return $this->groupSequenceProviderClass;
}
/**
* Returns whether a group sequence provider is set.
* Returns whether the class has a group sequence provider.
*
* @return boolean
*/
public function hasGroupSequenceProvider()
{
return $this->groupSequenceProviderClass || $this->groupSequenceProvider;
}
/**
* Returns the group sequence provider if specified.
*
* @return GroupSequenceProviderInterface The provider or null
*/
public function getGroupSequenceProvider()
{
if (!$this->groupSequenceProvider && $this->groupSequenceProviderClass) {
$reflClass = new \ReflectionClass($this->groupSequenceProviderClass);
$interface = 'Symfony\Component\Validator\GroupSequenceProviderInterface';
if (!$reflClass->implementsInterface($interface)) {
throw new \InvalidArgumentException(sprintf('The class "%s" must implement interface "%s".', $this->groupSequenceProviderClass, $interface));
}
$this->groupSequenceProvider = $reflClass->newInstance();
}
return $this->groupSequenceProvider;
}
/**
* Sets the group sequence provider.
*
* @param GroupSequenceProviderInterface $provider Group sequence provider
*/
public function setGroupSequenceProvider(GroupSequenceProviderInterface $provider)
{
$this->groupSequenceProvider = $provider;
}
}

3
src/Symfony/Component/Validator/Mapping/ClassMetadataFactory.php
View File

@ -58,6 +58,9 @@ class ClassMetadataFactory implements ClassMetadataFactoryInterface
// Include constraints from all implemented interfaces
foreach ($metadata->getReflectionClass()->getInterfaces() as $interface) {
if ('Symfony\Component\Validator\GroupSequenceProviderInterface' === $interface->getName()) {
continue;
}
$metadata->mergeConstraints($this->getClassMetadata($interface->getName()));
}

2
src/Symfony/Component/Validator/Mapping/Loader/AnnotationLoader.php
View File

@ -40,7 +40,7 @@ class AnnotationLoader implements LoaderInterface
if ($constraint instanceof GroupSequence) {
$metadata->setGroupSequence($constraint->groups);
} elseif ($constraint instanceof GroupSequenceProvider) {
$metadata->setGroupSequenceProviderClass($constraint->class);
$metadata->setGroupSequenceProvider($constraint->active);
} elseif ($constraint instanceof Constraint) {
$metadata->addConstraint($constraint);
}

2
src/Symfony/Component/Validator/Mapping/Loader/XmlFileLoader.php
View File

@ -44,7 +44,7 @@ class XmlFileLoader extends FileLoader
$xml = $this->classes[$metadata->getClassName()];
foreach ($xml->{'group-sequence-provider'} as $provider) {
$metadata->setGroupSequenceProviderClass($provider['class']);
$metadata->setGroupSequenceProvider((bool)$provider['active']);
}
foreach ($this->parseConstraints($xml->constraint) as $constraint) {

2
src/Symfony/Component/Validator/Mapping/Loader/YamlFileLoader.php
View File

@ -55,7 +55,7 @@ class YamlFileLoader extends FileLoader
$yaml = $this->classes[$metadata->getClassName()];
if (isset($yaml['group_sequence_provider'])) {
$metadata->setGroupSequenceProviderClass($yaml['group_sequence_provider']);
$metadata->setGroupSequenceProvider((bool)$yaml['group_sequence_provider']);
}
if (isset($yaml['constraints'])) {

2
src/Symfony/Component/Validator/Mapping/Loader/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd
View File

@ -66,7 +66,7 @@
Defines the name of the group sequence provider for a class.
]]></xsd:documentation>
</xsd:annotation>
<xsd:attribute name="class" type="xsd:string" use="required" />
<xsd:attribute name="active" type="xsd:boolean" use="required" />
</xsd:complexType>
<xsd:complexType name="property">

15
tests/Symfony/Tests/Component/Validator/Fixtures/Entity.php
View File

@ -6,13 +6,14 @@ require_once __DIR__.'/EntityParent.php';
require_once __DIR__.'/EntityInterface.php';
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\GroupSequenceProviderInterface;
/**
* @Symfony\Tests\Component\Validator\Fixtures\ConstraintA
* @Assert\GroupSequence({"Foo", "Entity"})
* @Assert\GroupSequenceProvider("Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider")
*/
class Entity extends EntityParent implements EntityInterface
class Entity extends EntityParent implements EntityInterface, GroupSequenceProviderInterface
{
/**
* @Assert\NotNull
@ -29,6 +30,8 @@ class Entity extends EntityParent implements EntityInterface
protected $lastName;
public $reference;
protected $groups = array();
private $internal;
public function __construct($internal = null)
@ -48,4 +51,14 @@ class Entity extends EntityParent implements EntityInterface
{
return $this->lastName;
}
public function setGroups($groups)
{
$this->groups = $groups;
}
public function getValidationGroups()
{
return $this->groups;
}
}

20
tests/Symfony/Tests/Component/Validator/Fixtures/GroupSequenceProvider.php
View File

@ -1,20 +0,0 @@
<?php
namespace Symfony\Tests\Component\Validator\Fixtures;
use Symfony\Component\Validator\GroupSequenceProviderInterface;
class GroupSequenceProvider implements GroupSequenceProviderInterface
{
protected $groups = array();
public function setGroups($groups)
{
$this->groups = $groups;
}
public function getValidationGroups($object)
{
return $this->groups;
}
}

14
tests/Symfony/Tests/Component/Validator/Mapping/ClassMetadataTest.php
View File

@ -14,6 +14,7 @@ namespace Symfony\Tests\Component\Validator\Mapping;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Valid;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Exception\GroupDefinitionException;
use Symfony\Tests\Component\Validator\Fixtures\Entity;
use Symfony\Tests\Component\Validator\Fixtures\ConstraintA;
use Symfony\Tests\Component\Validator\Fixtures\ConstraintB;
@ -24,7 +25,6 @@ require_once __DIR__.'/../Fixtures/Entity.php';
require_once __DIR__.'/../Fixtures/ConstraintA.php';
require_once __DIR__.'/../Fixtures/ConstraintB.php';
require_once __DIR__.'/../Fixtures/PropertyConstraint.php';
require_once __DIR__.'/../Fixtures/GroupSequenceProvider.php';
class ClassMetadataTest extends \PHPUnit_Framework_TestCase
{
@ -194,16 +194,14 @@ class ClassMetadataTest extends \PHPUnit_Framework_TestCase
public function testGroupSequenceProvider()
{
$this->assertNull($this->metadata->getGroupSequenceProvider());
$this->metadata->setGroupSequenceProviderClass('stdClass');
$metadata = new ClassMetadata('stdClass');
try {
$this->metadata->getGroupSequenceProvider();
$metadata->setGroupSequenceProvider(true);
$this->fail();
} catch(\InvalidArgumentException $e) {}
} catch(GroupDefinitionException $e) {}
$this->metadata->setGroupSequenceProviderClass('Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider');
$this->assertTrue($this->metadata->getGroupSequenceProvider() instanceof GroupSequenceProvider);
$this->metadata->setGroupSequenceProvider(true);
$this->assertTrue($this->metadata->hasGroupSequenceProvider());
}
}

4
tests/Symfony/Tests/Component/Validator/Mapping/Loader/AnnotationLoaderTest.php
View File

@ -73,7 +73,7 @@ class AnnotationLoaderTest extends \PHPUnit_Framework_TestCase
'choices' => array('A', 'B'),
)));
$expected->addGetterConstraint('lastName', new NotNull());
$expected->setGroupSequenceProviderClass('Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider');
$expected->setGroupSequenceProvider(true);
// load reflection class so that the comparison passes
$expected->getReflectionClass();
@ -138,7 +138,7 @@ class AnnotationLoaderTest extends \PHPUnit_Framework_TestCase
'choices' => array('A', 'B'),
)));
$expected->addGetterConstraint('lastName', new NotNull());
$expected->setGroupSequenceProviderClass('Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider');
$expected->setGroupSequenceProvider(true);
// load reflection class so that the comparison passes
$expected->getReflectionClass();

2
tests/Symfony/Tests/Component/Validator/Mapping/Loader/XmlFileLoaderTest.php
View File

@ -67,7 +67,7 @@ class XmlFileLoaderTest extends \PHPUnit_Framework_TestCase
'choices' => array('A', 'B'),
)));
$expected->addGetterConstraint('lastName', new NotNull());
$expected->setGroupSequenceProviderClass('Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider');
$expected->setGroupSequenceProvider(true);
$this->assertEquals($expected, $metadata);
}

2
tests/Symfony/Tests/Component/Validator/Mapping/Loader/YamlFileLoaderTest.php
View File

@ -85,7 +85,7 @@ class YamlFileLoaderTest extends \PHPUnit_Framework_TestCase
'choices' => array('A', 'B'),
)));
$expected->addGetterConstraint('lastName', new NotNull());
$expected->setGroupSequenceProviderClass('Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider');
$expected->setGroupSequenceProvider(true);
$this->assertEquals($expected, $metadata);
}

2
tests/Symfony/Tests/Component/Validator/Mapping/Loader/constraint-mapping.xml
View File

@ -9,7 +9,7 @@
<class name="Symfony\Tests\Component\Validator\Fixtures\Entity">
<!-- GROUP SEQUENCE PROVIDER -->
<group-sequence-provider class="Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider" />
<group-sequence-provider active="true" />
<!-- CLASS CONSTRAINTS -->

2
tests/Symfony/Tests/Component/Validator/Mapping/Loader/constraint-mapping.yml
View File

@ -2,7 +2,7 @@ namespaces:
custom: Symfony\Tests\Component\Validator\Fixtures\
Symfony\Tests\Component\Validator\Fixtures\Entity:
group_sequence_provider: Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider
group_sequence_provider: true
constraints:
# Custom constraint
- Symfony\Tests\Component\Validator\Fixtures\ConstraintA: ~

11
tests/Symfony/Tests/Component/Validator/ValidatorTest.php
View File

@ -19,7 +19,6 @@ require_once __DIR__.'/Fixtures/FakeClassMetadataFactory.php';
use Symfony\Tests\Component\Validator\Fixtures\Entity;
use Symfony\Tests\Component\Validator\Fixtures\FakeClassMetadataFactory;
use Symfony\Tests\Component\Validator\Fixtures\FailingConstraint;
use Symfony\Tests\Component\Validator\Fixtures\GroupSequenceProvider;
use Symfony\Component\Validator\Validator;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationList;
@ -125,8 +124,6 @@ class ValidatorTest extends \PHPUnit_Framework_TestCase
public function testValidate_groupSequenceProvider()
{
$groupSequenceProvider = new GroupSequenceProvider;
$entity = new Entity();
$metadata = new ClassMetadata(get_class($entity));
$metadata->addPropertyConstraint('firstName', new FailingConstraint(array(
@ -135,7 +132,7 @@ class ValidatorTest extends \PHPUnit_Framework_TestCase
$metadata->addPropertyConstraint('lastName', new FailingConstraint(array(
'groups' => 'Second',
)));
$metadata->setGroupSequenceProvider($groupSequenceProvider);
$metadata->setGroupSequenceProvider(true);
$this->factory->addClassMetadata($metadata);
$violations = new ConstraintViolationList();
@ -147,7 +144,7 @@ class ValidatorTest extends \PHPUnit_Framework_TestCase
''
));
$groupSequenceProvider->setGroups(array('First'));
$entity->setGroups(array('First'));
$result = $this->validator->validate($entity);
$this->assertEquals($violations, $result);
@ -160,11 +157,11 @@ class ValidatorTest extends \PHPUnit_Framework_TestCase
''
));
$groupSequenceProvider->setGroups(array('Second'));
$entity->setGroups(array('Second'));
$result = $this->validator->validate($entity);
$this->assertEquals($violations, $result);
$groupSequenceProvider->setGroups(array());
$entity->setGroups(array());
$result = $this->validator->validate($entity);
$this->assertEquals(new ConstraintViolationList(), $result);
}