PropertyPath

__construct(PropertyPath|string $propertyPath)

Создаёт путь к свойству из строки.

Параметры

PropertyPath|string

$propertyPath

Путь к свойству в виде строки или экземпляра

Исключения

InvalidArgumentException	Если заданный путь не является строкой
InvalidPropertyPathException	Если синтаксис пути к свойству некорректен

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

Если смещение некорректно