Spec-Zone.ru › Symfony 3.4

PropertyPathInterface

interface PropertyPathInterface implements Traversable

Последовательность имён свойств или индексов массива.

Методы

string __toString()

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

int getLength()

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

PropertyPath getParent()

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

array getElements()

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

string getElement(int $index)

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

bool isProperty(int $index)

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

bool isIndex(int $index)

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

Подробное описание

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/PropertyAccess/PropertyPathInterface.html

Spec-Zone.ru

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