123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Validator\Mapping;
- /**
- * Stores all metadata needed for validating objects of specific class.
- *
- * Most importantly, the metadata stores the constraints against which an object
- * and its properties should be validated.
- *
- * Additionally, the metadata stores whether the "Default" group is overridden
- * by a group sequence for that class and whether instances of that class
- * should be traversed or not.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- *
- * @see MetadataInterface
- * @see \Symfony\Component\Validator\Constraints\GroupSequence
- * @see \Symfony\Component\Validator\GroupSequenceProviderInterface
- * @see TraversalStrategy
- */
- interface ClassMetadataInterface extends MetadataInterface
- {
- /**
- * Returns the names of all constrained properties.
- *
- * @return string[] A list of property names
- */
- public function getConstrainedProperties();
- /**
- * Returns whether the "Default" group is overridden by a group sequence.
- *
- * If it is, you can access the group sequence with {@link getGroupSequence()}.
- *
- * @return bool Returns true if the "Default" group is overridden
- *
- * @see \Symfony\Component\Validator\Constraints\GroupSequence
- */
- public function hasGroupSequence();
- /**
- * Returns the group sequence that overrides the "Default" group for this
- * class.
- *
- * @return \Symfony\Component\Validator\Constraints\GroupSequence|null The group sequence or null
- *
- * @see \Symfony\Component\Validator\Constraints\GroupSequence
- */
- public function getGroupSequence();
- /**
- * Returns whether the "Default" group is overridden by a dynamic group
- * sequence obtained by the validated objects.
- *
- * If this method returns true, the class must implement
- * {@link \Symfony\Component\Validator\GroupSequenceProviderInterface}.
- * This interface will be used to obtain the group sequence when an object
- * of this class is validated.
- *
- * @return bool Returns true if the "Default" group is overridden by
- * a dynamic group sequence
- *
- * @see \Symfony\Component\Validator\GroupSequenceProviderInterface
- */
- public function isGroupSequenceProvider();
- /**
- * Check if there's any metadata attached to the given named property.
- *
- * @param string $property The property name
- *
- * @return bool
- */
- public function hasPropertyMetadata(string $property);
- /**
- * Returns all metadata instances for the given named property.
- *
- * If your implementation does not support properties, throw an exception
- * in this method (for example a <tt>BadMethodCallException</tt>).
- *
- * @param string $property The property name
- *
- * @return PropertyMetadataInterface[] A list of metadata instances. Empty if
- * no metadata exists for the property.
- */
- public function getPropertyMetadata(string $property);
- /**
- * Returns the name of the backing PHP class.
- *
- * @return string The name of the backing class
- */
- public function getClassName();
- }
|