Spec-Zone.ru › Symfony 4.1

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.
https://api.symfony.com/4.1/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationPath.html

Spec-Zone.ru

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