4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Validator\Mapping;
14 use Symfony\Component\Validator\Constraint;
15 use Symfony\Component\Validator\Constraints\GroupSequence;
16 use Symfony\Component\Validator\Constraints\Traverse;
17 use Symfony\Component\Validator\Constraints\Valid;
18 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
19 use Symfony\Component\Validator\Exception\GroupDefinitionException;
22 * Default implementation of {@link ClassMetadataInterface}.
24 * This class supports serialization and cloning.
26 * @author Bernhard Schussek <bschussek@gmail.com>
27 * @author Fabien Potencier <fabien@symfony.com>
29 class ClassMetadata extends GenericMetadata implements ClassMetadataInterface
34 * @internal This property is public in order to reduce the size of the
35 * class' serialized representation. Do not access it. Use
36 * {@link getClassName()} instead.
43 * @internal This property is public in order to reduce the size of the
44 * class' serialized representation. Do not access it. Use
45 * {@link getDefaultGroup()} instead.
50 * @var MemberMetadata[][]
52 * @internal This property is public in order to reduce the size of the
53 * class' serialized representation. Do not access it. Use
54 * {@link getPropertyMetadata()} instead.
56 public $members = array();
59 * @var PropertyMetadata[]
61 * @internal This property is public in order to reduce the size of the
62 * class' serialized representation. Do not access it. Use
63 * {@link getPropertyMetadata()} instead.
65 public $properties = array();
68 * @var GetterMetadata[]
70 * @internal This property is public in order to reduce the size of the
71 * class' serialized representation. Do not access it. Use
72 * {@link getPropertyMetadata()} instead.
74 public $getters = array();
79 * @internal This property is public in order to reduce the size of the
80 * class' serialized representation. Do not access it. Use
81 * {@link getGroupSequence()} instead.
83 public $groupSequence = array();
88 * @internal This property is public in order to reduce the size of the
89 * class' serialized representation. Do not access it. Use
90 * {@link isGroupSequenceProvider()} instead.
92 public $groupSequenceProvider = false;
95 * The strategy for traversing traversable objects.
97 * By default, only instances of {@link \Traversable} are traversed.
101 * @internal This property is public in order to reduce the size of the
102 * class' serialized representation. Do not access it. Use
103 * {@link getTraversalStrategy()} instead.
105 public $traversalStrategy = TraversalStrategy::IMPLICIT;
108 * @var \ReflectionClass
113 * Constructs a metadata for the given class.
115 * @param string $class
117 public function __construct($class)
119 $this->name = $class;
120 // class name without namespace
121 if (false !== $nsSep = strrpos($class, '\\')) {
122 $this->defaultGroup = substr($class, $nsSep + 1);
124 $this->defaultGroup = $class;
131 public function __sleep()
133 $parentProperties = parent::__sleep();
135 // Don't store the cascading strategy. Classes never cascade.
136 unset($parentProperties[array_search('cascadingStrategy', $parentProperties)]);
138 return array_merge($parentProperties, array(
141 'groupSequenceProvider',
152 public function getClassName()
158 * Returns the name of the default group for this class.
160 * For each class, the group "Default" is an alias for the group
161 * "<ClassName>", where <ClassName> is the non-namespaced name of the
162 * class. All constraints implicitly or explicitly assigned to group
163 * "Default" belong to both of these groups, unless the class defines
166 * If a class defines a group sequence, validating the class in "Default"
167 * will validate the group sequence. The constraints assigned to "Default"
168 * can still be validated by validating the class in "<ClassName>".
170 * @return string The name of the default group
172 public function getDefaultGroup()
174 return $this->defaultGroup;
180 public function addConstraint(Constraint $constraint)
182 if (!in_array(Constraint::CLASS_CONSTRAINT, (array) $constraint->getTargets())) {
183 throw new ConstraintDefinitionException(sprintf(
184 'The constraint "%s" cannot be put on classes.',
185 get_class($constraint)
189 if ($constraint instanceof Valid) {
190 throw new ConstraintDefinitionException(sprintf(
191 'The constraint "%s" cannot be put on classes.',
192 get_class($constraint)
196 if ($constraint instanceof Traverse) {
197 if ($constraint->traverse) {
198 // If traverse is true, traversal should be explicitly enabled
199 $this->traversalStrategy = TraversalStrategy::TRAVERSE;
201 // If traverse is false, traversal should be explicitly disabled
202 $this->traversalStrategy = TraversalStrategy::NONE;
205 // The constraint is not added
209 $constraint->addImplicitGroupName($this->getDefaultGroup());
211 parent::addConstraint($constraint);
217 * Adds a constraint to the given property.
219 * @param string $property The name of the property
220 * @param Constraint $constraint The constraint
224 public function addPropertyConstraint($property, Constraint $constraint)
226 if (!isset($this->properties[$property])) {
227 $this->properties[$property] = new PropertyMetadata($this->getClassName(), $property);
229 $this->addPropertyMetadata($this->properties[$property]);
232 $constraint->addImplicitGroupName($this->getDefaultGroup());
234 $this->properties[$property]->addConstraint($constraint);
240 * @param string $property
241 * @param Constraint[] $constraints
245 public function addPropertyConstraints($property, array $constraints)
247 foreach ($constraints as $constraint) {
248 $this->addPropertyConstraint($property, $constraint);
255 * Adds a constraint to the getter of the given property.
257 * The name of the getter is assumed to be the name of the property with an
258 * uppercased first letter and either the prefix "get" or "is".
260 * @param string $property The name of the property
261 * @param Constraint $constraint The constraint
265 public function addGetterConstraint($property, Constraint $constraint)
267 if (!isset($this->getters[$property])) {
268 $this->getters[$property] = new GetterMetadata($this->getClassName(), $property);
270 $this->addPropertyMetadata($this->getters[$property]);
273 $constraint->addImplicitGroupName($this->getDefaultGroup());
275 $this->getters[$property]->addConstraint($constraint);
281 * Adds a constraint to the getter of the given property.
283 * @param string $property The name of the property
284 * @param string $method The name of the getter method
285 * @param Constraint $constraint The constraint
289 public function addGetterMethodConstraint($property, $method, Constraint $constraint)
291 if (!isset($this->getters[$property])) {
292 $this->getters[$property] = new GetterMetadata($this->getClassName(), $property, $method);
294 $this->addPropertyMetadata($this->getters[$property]);
297 $constraint->addImplicitGroupName($this->getDefaultGroup());
299 $this->getters[$property]->addConstraint($constraint);
305 * @param string $property
306 * @param Constraint[] $constraints
310 public function addGetterConstraints($property, array $constraints)
312 foreach ($constraints as $constraint) {
313 $this->addGetterConstraint($property, $constraint);
320 * @param string $property
321 * @param string $method
322 * @param Constraint[] $constraints
326 public function addGetterMethodConstraints($property, $method, array $constraints)
328 foreach ($constraints as $constraint) {
329 $this->addGetterMethodConstraint($property, $method, $constraint);
336 * Merges the constraints of the given metadata into this object.
338 public function mergeConstraints(self $source)
340 if ($source->isGroupSequenceProvider()) {
341 $this->setGroupSequenceProvider(true);
344 foreach ($source->getConstraints() as $constraint) {
345 $this->addConstraint(clone $constraint);
348 foreach ($source->getConstrainedProperties() as $property) {
349 foreach ($source->getPropertyMetadata($property) as $member) {
350 $member = clone $member;
352 foreach ($member->getConstraints() as $constraint) {
353 if (in_array($constraint::DEFAULT_GROUP, $constraint->groups, true)) {
354 $member->constraintsByGroup[$this->getDefaultGroup()][] = $constraint;
357 $constraint->addImplicitGroupName($this->getDefaultGroup());
360 $this->addPropertyMetadata($member);
362 if ($member instanceof MemberMetadata && !$member->isPrivate($this->name)) {
363 $property = $member->getPropertyName();
365 if ($member instanceof PropertyMetadata && !isset($this->properties[$property])) {
366 $this->properties[$property] = $member;
367 } elseif ($member instanceof GetterMetadata && !isset($this->getters[$property])) {
368 $this->getters[$property] = $member;
378 public function hasPropertyMetadata($property)
380 return array_key_exists($property, $this->members);
386 public function getPropertyMetadata($property)
388 if (!isset($this->members[$property])) {
392 return $this->members[$property];
398 public function getConstrainedProperties()
400 return array_keys($this->members);
404 * Sets the default group sequence for this class.
406 * @param array $groupSequence An array of group names
410 * @throws GroupDefinitionException
412 public function setGroupSequence($groupSequence)
414 if ($this->isGroupSequenceProvider()) {
415 throw new GroupDefinitionException('Defining a static group sequence is not allowed with a group sequence provider');
418 if (is_array($groupSequence)) {
419 $groupSequence = new GroupSequence($groupSequence);
422 if (in_array(Constraint::DEFAULT_GROUP, $groupSequence->groups, true)) {
423 throw new GroupDefinitionException(sprintf('The group "%s" is not allowed in group sequences', Constraint::DEFAULT_GROUP));
426 if (!in_array($this->getDefaultGroup(), $groupSequence->groups, true)) {
427 throw new GroupDefinitionException(sprintf('The group "%s" is missing in the group sequence', $this->getDefaultGroup()));
430 $this->groupSequence = $groupSequence;
438 public function hasGroupSequence()
440 return $this->groupSequence && count($this->groupSequence->groups) > 0;
446 public function getGroupSequence()
448 return $this->groupSequence;
452 * Returns a ReflectionClass instance for this class.
454 * @return \ReflectionClass
456 public function getReflectionClass()
458 if (!$this->reflClass) {
459 $this->reflClass = new \ReflectionClass($this->getClassName());
462 return $this->reflClass;
466 * Sets whether a group sequence provider should be used.
468 * @param bool $active
470 * @throws GroupDefinitionException
472 public function setGroupSequenceProvider($active)
474 if ($this->hasGroupSequence()) {
475 throw new GroupDefinitionException('Defining a group sequence provider is not allowed with a static group sequence');
478 if (!$this->getReflectionClass()->implementsInterface('Symfony\Component\Validator\GroupSequenceProviderInterface')) {
479 throw new GroupDefinitionException(sprintf('Class "%s" must implement GroupSequenceProviderInterface', $this->name));
482 $this->groupSequenceProvider = $active;
488 public function isGroupSequenceProvider()
490 return $this->groupSequenceProvider;
494 * Class nodes are never cascaded.
498 public function getCascadingStrategy()
500 return CascadingStrategy::NONE;
503 private function addPropertyMetadata(PropertyMetadataInterface $metadata)
505 $property = $metadata->getPropertyName();
507 $this->members[$property][] = $metadata;