class CurrencyValidator

Validates whether a value is a valid currency.

@author Miha Vrhovnik <miha.vrhovnik@pagein.si> @author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
- class \Symfony\Component\Validator\Constraints\CurrencyValidator extends \Symfony\Component\Validator\ConstraintValidator

Expanded class hierarchy of CurrencyValidator

File

vendor/symfony/validator/Constraints/CurrencyValidator.php, line 26

Namespace

Symfony\Component\Validator\Constraints

View source

class CurrencyValidator extends ConstraintValidator {
    public function validate(mixed $value, Constraint $constraint) : void {
        if (!$constraint instanceof Currency) {
            throw new UnexpectedTypeException($constraint, Currency::class);
        }
        if (null === $value || '' === $value) {
            return;
        }
        if (!\is_scalar($value) && !$value instanceof \Stringable) {
            throw new UnexpectedValueException($value, 'string');
        }
        $value = (string) $value;
        if (!Currencies::exists($value)) {
            $this->context
                ->buildViolation($constraint->message)
                ->setParameter('{{ value }}', $this->formatValue($value))
                ->setCode(Currency::NO_SUCH_CURRENCY_ERROR)
                ->addViolation();
        }
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
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 "__toString()" 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 ("Y-m-d H:i:s").
CurrencyValidator::validate	public	function	Checks if the passed value is valid.	Overrides ConstraintValidatorInterface::validate