Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ClassMetadataInterface.php

interface ClassMetadataInterface

Same name in this branch
  1. 11.1.x vendor/symfony/serializer/Mapping/ClassMetadataInterface.php \Symfony\Component\Serializer\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.

@author Bernhard Schussek <bschussek@gmail.com>

@method string|null getGroupProvider()

Hierarchy

  • interface \Symfony\Component\Validator\Mapping\MetadataInterface
    • interface \Symfony\Component\Validator\Mapping\ClassMetadataInterface extends \Symfony\Component\Validator\Mapping\MetadataInterface

Expanded class hierarchy of ClassMetadataInterface

All classes that implement ClassMetadataInterface

See also

MetadataInterface

GroupSequence

GroupSequenceProviderInterface

TraversalStrategy

3 files declare their use of ClassMetadataInterface
DebugCommand.php in vendor/symfony/validator/Command/DebugCommand.php
ExecutionContext.php in vendor/symfony/validator/Context/ExecutionContext.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 {
    
    /**
     * Returns the names of all constrained properties.
     *
     * @return string[]
     */
    public function getConstrainedProperties() : array;
    
    /**
     * Returns whether the "Default" group is overridden by a group sequence.
     *
     * If it is, you can access the group sequence with {@link getGroupSequence()}.
     */
    public function hasGroupSequence() : bool;
    
    /**
     * Returns the group sequence that overrides the "Default" group for this
     * class.
     */
    public function getGroupSequence() : ?GroupSequence;
    
    /**
     * 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 GroupSequenceProviderInterface}.
     * This interface will be used to obtain the group sequence when an object
     * of this class is validated.
     */
    public function isGroupSequenceProvider() : bool;
    
    /**
     * Check if there's any metadata attached to the given named property.
     *
     * @param string $property The property name
     */
    public function hasPropertyMetadata(string $property) : bool;
    
    /**
     * 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[]
     */
    public function getPropertyMetadata(string $property) : array;
    
    /**
     * Returns the name of the backing PHP class.
     */
    public function getClassName() : string;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ClassMetadataInterface::getClassName public function Returns the name of the backing PHP class. 1
ClassMetadataInterface::getConstrainedProperties public function Returns the names of all constrained properties. 1
ClassMetadataInterface::getGroupSequence public function Returns the group sequence that overrides the &quot;Default&quot; group for this
class.
1
ClassMetadataInterface::getPropertyMetadata public function Returns all metadata instances for the given named property. 1
ClassMetadataInterface::hasGroupSequence public function Returns whether the &quot;Default&quot; group is overridden by a group sequence. 1
ClassMetadataInterface::hasPropertyMetadata public function Check if there&#039;s any metadata attached to the given named property. 1
ClassMetadataInterface::isGroupSequenceProvider public function Returns whether the &quot;Default&quot; group is overridden by a dynamic group
sequence obtained by the validated objects.
1
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
RSS feed
Powered by Drupal