Spec-Zone.ru › Symfony 3.2

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.2/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationPath.html

Spec-Zone.ru

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