Spec-Zone.ru › Symfony 2.7

Валюта

класс Currency расширяет Constraint

Константы

DEFAULT_GROUP

Имя группы, задаваемой всем ограничениям без явной группы.

CLASS_CONSTRAINT

Отмечает ограничение, которое может быть применено к классам.

PROPERTY_CONSTRAINT

Отмечает ограничение, которое может быть применено к свойствам.

Свойства

mixed $payload Данные, специфичные для области, присоединённые к ограничению. из Constraint
array $groups Группы, к которым относится ограничение из Constraint
$message

Методы

static string getErrorName(int $errorCode)

Возвращает имя заданного кода ошибки.

из Constraint
__construct(mixed $options = null)

Инициализирует ограничение параметрами.

из Constraint
__set(string $option, mixed $value)

Устанавливает значение отложенно инициализированного параметра.

из Constraint
mixed __get(string $option)

Возвращает значение отложенно инициализированного параметра.

из Constraint
addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе «По умолчанию».

из Constraint
string getDefaultOption()

Возвращает имя параметра по умолчанию.

из Constraint
array getRequiredOptions()

Возвращает имя необходимых параметров.

из Constraint
string validatedBy()

Возвращает имя класса, который проверяет это ограничение.

из Constraint
string|array getTargets()

Возвращает, можно ли применить ограничение к классам, свойствам или к обоим.

из Constraint
array __sleep()

Оптимизирует сериализованное значение для минимизации занимаемого места.

из Constraint

Подробности

static string getErrorName(int $errorCode)

Возвращает имя заданного кода ошибки.

Параметры

int $errorCode Код ошибки

Значение возврата

string Имя кода ошибки

Исключения

InvalidArgumentException Если код ошибки не существует

__construct(mixed $options = null)

Инициализирует ограничение параметрами.

Вы должны передать ассоциативный массив. Ключи должны соответствовать именам существующих свойств в этом классе. Значения должны быть значениями этих свойств.

В качестве альтернативы, вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передано ассоциативный массив, устанавливается это свойство.

Вы можете принудительно задать определённые параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не задан здесь, вызывается исключение.

Параметры

mixed $options Параметры (в виде ассоциативного массива) или значение для параметра по умолчанию (любой другой тип)

Исключения

InvalidOptionsException Когда вы передаёте имена несуществующих параметров
MissingOptionsException Когда вы не передаёте ни одного из параметров, возвращённых getRequiredOptions()
ConstraintDefinitionException Когда вы не передаёте ассоциативный массив, но getDefaultOption() возвращает null

__set(string $option, mixed $value)

Устанавливает значение отложенно инициализированного параметра.

Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра
mixed $value Значение для установки

Исключения

InvalidOptionsException Если указано некорректное имя параметра

mixed __get(string $option)

Возвращает значение отложенно инициализированного параметра.

Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра

Значение возврата

mixed Значение параметра

Исключения

InvalidOptionsException Если указано некорректное имя параметра

addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе «По умолчанию».

Параметры

string $group

string getDefaultOption()

Возвращает имя параметра по умолчанию.

Переопределите этот метод, чтобы определить параметр по умолчанию.

Значение возврата

string

См. также

__construct()

array getRequiredOptions()

Возвращает имя необходимых параметров.

Переопределите этот метод, если хотите определить необходимые параметры.

Значение возврата

array

См. также

__construct()

string validatedBy()

Возвращает имя класса, который проверяет это ограничение.

По умолчанию это полное имя класса ограничения с добавленным «Validator». Вы можете переопределить этот метод, чтобы изменить это поведение.

Значение возврата

string

string|array getTargets()

Возвращает, можно ли применить ограничение к классам, свойствам или к обоим.

Этот метод должен вернуть одно или несколько значений констант Constraint::CLASSCONSTRAINT и Constraint::PROPERTYCONSTRAINT.

Значение возврата

string|array Одно или несколько значений констант

array __sleep()

Оптимизирует сериализованное значение для минимизации занимаемого места.

Значение возврата

array Свойства для сериализации

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/Currency.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API