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

Breadcrumb

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

class ConstraintValidator

Base class for constraint validators.

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface

Expanded class hierarchy of ConstraintValidator

113 files declare their use of ConstraintValidator
AbstractComparisonValidator.php in vendor/symfony/validator/Constraints/AbstractComparisonValidator.php
AllValidator.php in vendor/symfony/validator/Constraints/AllValidator.php
AtLeastOneOfValidator.php in vendor/symfony/validator/Constraints/AtLeastOneOfValidator.php
BaseFileConstraintValidator.php in core/modules/file/src/Plugin/Validation/Constraint/BaseFileConstraintValidator.php
BicValidator.php in vendor/symfony/validator/Constraints/BicValidator.php

... See full list

File

vendor/symfony/validator/ConstraintValidator.php, line 21

Namespace

Symfony\Component\Validator
View source
abstract class ConstraintValidator implements ConstraintValidatorInterface {
    
    /**
     * Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter}
     * (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s").
     */
    public const PRETTY_DATE = 1;
    
    /**
     * Whether to cast objects with a "__toString()" method to strings.
     */
    public const OBJECT_TO_STRING = 2;
    protected ExecutionContextInterface $context;
    public function initialize(ExecutionContextInterface $context) : void {
        $this->context = $context;
    }
    
    /**
     * Returns a string representation of the type of the value.
     *
     * This method should be used if you pass the type of a value as
     * message parameter to a constraint violation. Note that such
     * parameters should usually not be included in messages aimed at
     * non-technical people.
     */
    protected function formatTypeOf(mixed $value) : string {
        return get_debug_type($value);
    }
    
    /**
     * Returns a string representation of the value.
     *
     * This method returns the equivalent PHP tokens for most scalar types
     * (i.e. "false" for false, "1" for 1 etc.). Strings are always wrapped
     * in double quotes ("). Objects, arrays and resources are formatted as
     * "object", "array" and "resource". If the $format bitmask contains
     * the PRETTY_DATE bit, then {@link \DateTime} objects will be formatted
     * with the {@link \IntlDateFormatter}. If it is not available, they will be
     * formatted as RFC-3339 dates ("Y-m-d H:i:s").
     *
     * Be careful when passing message parameters to a constraint violation
     * that (may) contain objects, arrays or resources. These parameters
     * should only be displayed for technical users. Non-technical users
     * won't know what an "object", "array" or "resource" is and will be
     * confused by the violation message.
     *
     * @param int $format A bitwise combination of the format constants in this class
     */
    protected function formatValue(mixed $value, int $format = 0) : string {
        if ($format & self::PRETTY_DATE && $value instanceof \DateTimeInterface) {
            if (class_exists(\IntlDateFormatter::class)) {
                $formatter = new \IntlDateFormatter(\Locale::getDefault(), \IntlDateFormatter::MEDIUM, \IntlDateFormatter::SHORT, 'UTC');
                return $formatter->format(new \DateTimeImmutable($value->format('Y-m-d H:i:s.u'), new \DateTimeZone('UTC')));
            }
            return $value->format('Y-m-d H:i:s');
        }
        if ($value instanceof \UnitEnum) {
            return $value->name;
        }
        if (\is_object($value)) {
            if ($format & self::OBJECT_TO_STRING && $value instanceof \Stringable) {
                return $value->__toString();
            }
            return 'object';
        }
        if (\is_array($value)) {
            return 'array';
        }
        if (\is_string($value)) {
            return '"' . $value . '"';
        }
        if (\is_resource($value)) {
            return 'resource';
        }
        if (null === $value) {
            return 'null';
        }
        if (false === $value) {
            return 'false';
        }
        if (true === $value) {
            return 'true';
        }
        return (string) $value;
    }
    
    /**
     * Returns a string representation of a list of values.
     *
     * Each of the values is converted to a string using
     * {@link formatValue()}. The values are then concatenated with commas.
     *
     * @param array $values A list of values
     * @param int   $format A bitwise combination of the format
     *                      constants in this class
     *
     * @see formatValue()
     */
    protected function formatValues(array $values, int $format = 0) : string {
        foreach ($values as $key => $value) {
            $values[$key] = $this->formatValue($value, $format);
        }
        return implode(', ', $values);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConstraintValidator::$context protected property
ConstraintValidator::formatTypeOf protected function Returns a string representation of the type of the value.
ConstraintValidator::formatValue protected function Returns a string representation of the value.
ConstraintValidator::formatValues protected function Returns a string representation of a list of values.
ConstraintValidator::initialize public function Initializes the constraint validator. Overrides ConstraintValidatorInterface::initialize
ConstraintValidator::OBJECT_TO_STRING public constant Whether to cast objects with a &quot;__toString()&quot; method to strings.
ConstraintValidator::PRETTY_DATE public constant Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter}
(if it is available) or as RFC-3339 dates (&quot;Y-m-d H:i:s&quot;).
ConstraintValidatorInterface::validate public function Checks if the passed value is valid. 119

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal