ViolationPath
class ViolationPath implements IteratorAggregate, PropertyPathInterface
Методы
| __construct(string $violationPath) Создаёт новый путь нарушения из строки. | ||
| string | __toString() Возвращает строковое представление пути свойства. | |
| int | getLength() Возвращает длину пути свойства, т.е. количество элементов. | |
| PropertyPath | getParent() Возвращает родительский путь свойства. | |
| array | getElements() Возвращает элементы пути свойства в виде массива. | |
| string | getElement(int $index) Возвращает элемент по заданному индексу в пути свойства. | |
| bool | isProperty(int $index) Возвращает, является ли элемент по заданному индексу свойством. | |
| bool | isIndex(int $index) Возвращает, является ли элемент по заданному индексу индексом массива. | |
| bool | mapsForm(int $index) Возвращает, отображает ли элемент напрямую форму. | |
| ViolationPathIterator | getIterator() Возвращает новый итератор для этого пути. |
Подробности
__construct(string $violationPath)
Создаёт новый путь нарушения из строки.
Параметры
| string | $violationPath | Путь к свойству объекта {@link \Symfony\Component\Validator\ConstraintViolation} |
string __toString()
Возвращает строковое представление пути свойства.
Значение возврата
| string | Путь в виде строки |
int getLength()
Возвращает длину пути свойства, т.е. количество элементов.
Значение возврата
| int | Длина пути |
PropertyPath getParent()
Возвращает родительский путь свойства.
Родительский путь свойства содержит те же элементы, что и этот, за исключением последнего.
Если путь свойства содержит только один элемент, возвращается null.
Значение возврата
| PropertyPath | Родительский путь или null |
array getElements()
Возвращает элементы пути свойства в виде массива.
Значение возврата
| array | Массив имён свойств/индексов |
string getElement(int $index)
Возвращает элемент по заданному индексу в пути свойства.
Параметры
| int | $index | Ключ индекса |
Значение возврата
| string | Имя свойства или индекса |
Исключения
| OutOfBoundsException | Если смещение недействительно |
bool isProperty(int $index)
Возвращает, является ли элемент по заданному индексу свойством.
Параметры
| int | $index | Индекс в пути свойства |
Значение возврата
| bool | Является ли элемент по этому индексу свойством |
Исключения
| OutOfBoundsException | Если смещение недействительно |
bool isIndex(int $index)
Возвращает, является ли элемент по заданному индексу индексом массива.
Параметры
| int | $index | Индекс в пути свойства |
Значение возврата
| bool | Является ли элемент по этому индексу индексом массива |
Исключения
| OutOfBoundsException | Если смещение недействительно |
bool mapsForm(int $index)
Возвращает, отображает ли элемент напрямую форму.
Рассмотрим следующий путь нарушения:
children[address].children[office].data.street
В этом примере «address» и «office» отображают формы, а «street» — нет.
Параметры
| int | $index | Индекс элемента |
Значение возврата
| bool | Отображает ли элемент форму |
Исключения
| OutOfBoundsException | если смещение недействительно |
ViolationPathIterator getIterator()
Возвращает новый итератор для этого пути.
Значение возврата
| ViolationPathIterator |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationPath.html