100 lines
4.3 KiB
PHP
100 lines
4.3 KiB
PHP
<?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\Validator\Attribute\HasNamedArguments;
|
|
use Symfony\Component\Validator\Constraint;
|
|
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
|
|
|
|
/**
|
|
* Validates that a value is a valid timezone identifier.
|
|
*
|
|
* @author Javier Spagnoletti <phansys@gmail.com>
|
|
* @author Hugo Hamon <hugohamon@neuf.fr>
|
|
*/
|
|
#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
|
|
class Timezone extends Constraint
|
|
{
|
|
public const TIMEZONE_IDENTIFIER_ERROR = '5ce113e6-5e64-4ea2-90fe-d2233956db13';
|
|
public const TIMEZONE_IDENTIFIER_IN_ZONE_ERROR = 'b57767b1-36c0-40ac-a3d7-629420c775b8';
|
|
public const TIMEZONE_IDENTIFIER_IN_COUNTRY_ERROR = 'c4a22222-dc92-4fc0-abb0-d95b268c7d0b';
|
|
public const TIMEZONE_IDENTIFIER_INTL_ERROR = '45863c26-88dc-41ba-bf53-c73bd1f7e90d';
|
|
|
|
public int $zone = \DateTimeZone::ALL;
|
|
public ?string $countryCode = null;
|
|
public bool $intlCompatible = false;
|
|
public string $message = 'This value is not a valid timezone.';
|
|
|
|
protected const ERROR_NAMES = [
|
|
self::TIMEZONE_IDENTIFIER_ERROR => 'TIMEZONE_IDENTIFIER_ERROR',
|
|
self::TIMEZONE_IDENTIFIER_IN_ZONE_ERROR => 'TIMEZONE_IDENTIFIER_IN_ZONE_ERROR',
|
|
self::TIMEZONE_IDENTIFIER_IN_COUNTRY_ERROR => 'TIMEZONE_IDENTIFIER_IN_COUNTRY_ERROR',
|
|
self::TIMEZONE_IDENTIFIER_INTL_ERROR => 'TIMEZONE_IDENTIFIER_INTL_ERROR',
|
|
];
|
|
|
|
/**
|
|
* @param int|array<string,mixed>|null $zone Restrict valid timezones to this geographical zone (defaults to {@see \DateTimeZone::ALL})
|
|
* @param string|null $countryCode Restrict the valid timezones to this country if the zone option is {@see \DateTimeZone::PER_COUNTRY}
|
|
* @param bool|null $intlCompatible Whether to restrict valid timezones to ones available in PHP's intl (defaults to false)
|
|
* @param string[]|null $groups
|
|
* @param array<string,mixed>|null $options
|
|
*
|
|
* @see \DateTimeZone
|
|
*/
|
|
#[HasNamedArguments]
|
|
public function __construct(
|
|
int|array|null $zone = null,
|
|
?string $message = null,
|
|
?string $countryCode = null,
|
|
?bool $intlCompatible = null,
|
|
?array $groups = null,
|
|
mixed $payload = null,
|
|
?array $options = null,
|
|
) {
|
|
if (\is_array($zone)) {
|
|
trigger_deprecation('symfony/validator', '7.3', 'Passing an array of options to configure the "%s" constraint is deprecated, use named arguments instead.', static::class);
|
|
|
|
$options = array_merge($zone, $options ?? []);
|
|
} elseif (null !== $zone) {
|
|
if (\is_array($options)) {
|
|
trigger_deprecation('symfony/validator', '7.3', 'Passing an array of options to configure the "%s" constraint is deprecated, use named arguments instead.', static::class);
|
|
} else {
|
|
$options = [];
|
|
}
|
|
|
|
$options['value'] = $zone;
|
|
}
|
|
|
|
parent::__construct($options, $groups, $payload);
|
|
|
|
$this->message = $message ?? $this->message;
|
|
$this->countryCode = $countryCode ?? $this->countryCode;
|
|
$this->intlCompatible = $intlCompatible ?? $this->intlCompatible;
|
|
|
|
if (null === $this->countryCode) {
|
|
if (0 >= $this->zone || \DateTimeZone::ALL_WITH_BC < $this->zone) {
|
|
throw new ConstraintDefinitionException('The option "zone" must be a valid range of "\DateTimeZone" constants.');
|
|
}
|
|
} elseif (\DateTimeZone::PER_COUNTRY !== (\DateTimeZone::PER_COUNTRY & $this->zone)) {
|
|
throw new ConstraintDefinitionException('The option "countryCode" can only be used when the "zone" option is configured with "\DateTimeZone::PER_COUNTRY".');
|
|
}
|
|
if ($this->intlCompatible && !class_exists(\IntlTimeZone::class)) {
|
|
throw new ConstraintDefinitionException('The option "intlCompatible" can only be used when the PHP intl extension is available.');
|
|
}
|
|
}
|
|
|
|
public function getDefaultOption(): ?string
|
|
{
|
|
return 'zone';
|
|
}
|
|
}
|