<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Validator\Constraints;
use Symfony\Component\ExpressionLanguage\Expression as ExpressionObject;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Exception\LogicException;
/**
* @Annotation
* @Target({"CLASS", "PROPERTY", "METHOD", "ANNOTATION"})
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bernhard Schussek <bschussek@gmail.com>
*/
#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
class Expression extends Constraint
{
public const EXPRESSION_FAILED_ERROR = '6b3befbc-2f01-4ddf-be21-b57898905284';
protected static $errorNames = [
self::EXPRESSION_FAILED_ERROR => 'EXPRESSION_FAILED_ERROR',
];
public $message = 'This value is not valid.';
public $expression;
public $values = [];
/**
* {@inheritdoc}
*
* @param string|ExpressionObject|array $expression The expression to evaluate or an array of options
*/
public function __construct(
$expression,
string $message = null,
array $values = null,
array $groups = null,
$payload = null,
array $options = []
) {
if (!class_exists(ExpressionLanguage::class)) {
throw new LogicException(sprintf('The "symfony/expression-language" component is required to use the "%s" constraint.', __CLASS__));
}
if (\is_array($expression)) {
$options = array_merge($expression, $options);
} elseif (!\is_string($expression) && !$expression instanceof ExpressionObject) {
throw new \TypeError(sprintf('"%s": Expected argument $expression to be either a string, an instance of "%s" or an array, got "%s".', __METHOD__, ExpressionObject::class, get_debug_type($expression)));
} else {
$options['value'] = $expression;
}
parent::__construct($options, $groups, $payload);
$this->message = $message ?? $this->message;
$this->values = $values ?? $this->values;
}
/**
* {@inheritdoc}
*/
public function getDefaultOption()
{
return 'expression';
}
/**
* {@inheritdoc}
*/
public function getRequiredOptions()
{
return ['expression'];
}
/**
* {@inheritdoc}
*/
public function getTargets()
{
return [self::CLASS_CONSTRAINT, self::PROPERTY_CONSTRAINT];
}
/**
* {@inheritdoc}
*/
public function validatedBy()
{
return 'validator.expression';
}
}