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

Если смещение недействительно