www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/validator/Mapping/PropertyMetadataInterface.php

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