You are here

interface ClassMetadataInterface in Zircon Profile 8

Same name in this branch
  1. 8 vendor/symfony/validator/Mapping/ClassMetadataInterface.php \Symfony\Component\Validator\Mapping\ClassMetadataInterface
  2. 8 vendor/symfony/serializer/Mapping/ClassMetadataInterface.php \Symfony\Component\Serializer\Mapping\ClassMetadataInterface
Same name and namespace in other branches
  1. 8.0 vendor/symfony/validator/Mapping/ClassMetadataInterface.php \Symfony\Component\Validator\Mapping\ClassMetadataInterface

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.

@since 2.5

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

Expanded class hierarchy of ClassMetadataInterface

All classes that implement ClassMetadataInterface

See also

MetadataInterface

\Symfony\Component\Validator\Constraints\GroupSequence

\Symfony\Component\Validator\GroupSequenceProviderInterface

TraversalStrategy

2 files declare their use of ClassMetadataInterface
LazyLoadingMetadataFactory.php in vendor/symfony/validator/Mapping/Factory/LazyLoadingMetadataFactory.php
RecursiveContextualValidator.php in vendor/symfony/validator/Validator/RecursiveContextualValidator.php

File

vendor/symfony/validator/Mapping/ClassMetadataInterface.php, line 36

Namespace

Symfony\Component\Validator\Mapping
View source
interface ClassMetadataInterface extends MetadataInterface, LegacyPropertyMetadataContainerInterface, ClassBasedInterface {

  /**
   * 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();

}

Members

Namesort descending Modifiers Type Description Overrides
ClassBasedInterface::getClassName public function Returns the name of the backing PHP class. 2
ClassMetadataInterface::getConstrainedProperties public function Returns the names of all constrained properties. 1
ClassMetadataInterface::getGroupSequence public function Returns the group sequence that overrides the "Default" group for this class. 1
ClassMetadataInterface::hasGroupSequence public function Returns whether the "Default" group is overridden by a group sequence. 1
ClassMetadataInterface::isGroupSequenceProvider public function Returns whether the "Default" group is overridden by a dynamic group sequence obtained by the validated objects. 1
MetadataInterface::accept Deprecated public function Implementation of the Visitor design pattern. 2
MetadataInterface::findConstraints public function Returns all constraints for a given validation group. 2
MetadataInterface::getCascadingStrategy public function Returns the strategy for cascading objects. 2
MetadataInterface::getConstraints public function Returns all constraints of this element. 2
MetadataInterface::getTraversalStrategy public function Returns the strategy for traversing traversable objects. 2
PropertyMetadataContainerInterface::getPropertyMetadata public function Returns all metadata instances for the given named property. 1
PropertyMetadataContainerInterface::hasPropertyMetadata public function Check if there's any metadata attached to the given named property. 1