Spec-Zone.ru › Symfony 2.7

RelativePath

class RelativePath extends PropertyPath

Постоянные значения

SINGULAR_SEPARATOR

Символ, используемый для разделения множественного и единственного числа элемента.

Методы

__construct(FormInterface $root, PropertyPath|string $propertyPath)
string __toString()

Возвращает строковое представление пути к свойству

из PropertyPath
int getLength()

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

из PropertyPath
PropertyPath getParent()

Возвращает родительский путь к свойству.

из PropertyPath
PropertyPathIteratorInterface getIterator()

Возвращает новый итератор для этого пути.

из PropertyPath
array getElements()

Возвращает элементы пути к свойству в виде массива.

из PropertyPath
string getElement(int $index)

Возвращает элемент по заданному индексу в пути к свойству.

из PropertyPath
bool isProperty(int $index)

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

из PropertyPath
bool isIndex(int $index)

Возвращает, является ли элемент по заданному индексу индексом массива.

из PropertyPath
FormInterface getRoot()

Подробности

__construct(FormInterface $root, PropertyPath|string $propertyPath)

Параметры

FormInterface $root
PropertyPath|string $propertyPath Путь к свойству в виде строки или экземпляра

string __toString()

Возвращает строковое представление пути к свойству

Значение, возвращаемое

string Путь в виде строки

int getLength()

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

Значение, возвращаемое

int Длина пути

PropertyPath getParent()

Возвращает родительский путь к свойству.

Родительский путь к свойству содержит те же элементы, что и текущий, за исключением последнего.

Если путь к свойству содержит только один элемент, возвращается null.

Значение, возвращаемое

PropertyPath Родительский путь или null

PropertyPathIteratorInterface getIterator()

Возвращает новый итератор для этого пути.

Значение, возвращаемое

PropertyPathIteratorInterface

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 Если смещение недействительно

FormInterface getRoot()

Значение, возвращаемое

FormInterface

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Form/Extension/Validator/ViolationMapper/RelativePath.html

Spec-Zone.ru

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