annotate vendor/symfony/validator/Mapping/PropertyMetadataInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Validator\Mapping;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Stores all metadata needed for validating the value of a class property.
Chris@0 16 *
Chris@0 17 * Most importantly, the metadata stores the constraints against which the
Chris@0 18 * property's value should be validated.
Chris@0 19 *
Chris@0 20 * Additionally, the metadata stores whether objects stored in the property
Chris@0 21 * should be validated against their class' metadata and whether traversable
Chris@0 22 * objects should be traversed or not.
Chris@0 23 *
Chris@0 24 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 25 *
Chris@0 26 * @see MetadataInterface
Chris@0 27 * @see CascadingStrategy
Chris@0 28 * @see TraversalStrategy
Chris@0 29 */
Chris@0 30 interface PropertyMetadataInterface extends MetadataInterface
Chris@0 31 {
Chris@0 32 /**
Chris@0 33 * Returns the name of the property.
Chris@0 34 *
Chris@0 35 * @return string The property name
Chris@0 36 */
Chris@0 37 public function getPropertyName();
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Extracts the value of the property from the given container.
Chris@0 41 *
Chris@0 42 * @param mixed $containingValue The container to extract the property value from
Chris@0 43 *
Chris@0 44 * @return mixed The value of the property
Chris@0 45 */
Chris@0 46 public function getPropertyValue($containingValue);
Chris@0 47 }