Mercurial > hg > isophonics-drupal-site
view vendor/symfony/validator/Mapping/ClassMetadataInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | af1871eacc83 |
children |
line wrap: on
line source
<?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($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($property); /** * Returns the name of the backing PHP class. * * @return string The name of the backing class */ public function getClassName(); }