www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/validator/Mapping/MetadataInterface.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 use Symfony\Component\Validator\Constraint;
  15
  16 /**
  17  * A container for validation metadata.
  18  *
  19  * Most importantly, the metadata stores the constraints against which an object
  20  * and its properties should be validated.
  21  *
  22  * Additionally, the metadata stores whether objects should be validated
  23  * against their class' metadata and whether traversable objects should be
  24  * traversed or not.
  25  *
  26  * @author Bernhard Schussek <bschussek@gmail.com>
  27  *
  28  * @see CascadingStrategy
  29  * @see TraversalStrategy
  30  */
  31 interface MetadataInterface
  32 {
  33     /**
  34      * Returns the strategy for cascading objects.
  35      *
  36      * @return int The cascading strategy
  37      *
  38      * @see CascadingStrategy
  39      */
  40     public function getCascadingStrategy();
  41
  42     /**
  43      * Returns the strategy for traversing traversable objects.
  44      *
  45      * @return int The traversal strategy
  46      *
  47      * @see TraversalStrategy
  48      */
  49     public function getTraversalStrategy();
  50
  51     /**
  52      * Returns all constraints of this element.
  53      *
  54      * @return Constraint[] A list of Constraint instances
  55      */
  56     public function getConstraints();
  57
  58     /**
  59      * Returns all constraints for a given validation group.
  60      *
  61      * @param string $group The validation group
  62      *
  63      * @return Constraint[] A list of constraint instances
  64      */
  65     public function findConstraints($group);
  66 }