PropertyPathBuilder
class PropertyPathBuilder
Методы
| __construct(null|PropertyPathInterface|string $path = null) Создаёт новый билдер пути свойства. | ||
| append(PropertyPathInterface|string $path, int $offset, int $length) Добавляет (под-)путь к текущему пути. | ||
| appendIndex(string $name) Добавляет элемент индекса к текущему пути. | ||
| appendProperty(string $name) Добавляет элемент свойства к текущему пути. | ||
| remove(int $offset, int $length = 1) Удаляет элементы из текущего пути. | ||
| replace(int $offset, int $length, PropertyPathInterface|string $path, int $pathOffset, int $pathLength) Заменяет подпуть другим (под-)путём. | ||
| replaceByIndex(int $offset, string $name = null) Заменяет элемент свойства элементом индекса. | ||
| replaceByProperty(int $offset, string $name = null) Заменяет элемент индекса элементом свойства. | ||
| int | getLength() Возвращает длину текущего пути. | |
| PropertyPathInterface | getPropertyPath() Возвращает текущий путь свойства. | |
| string | __toString() Возвращает текущий путь свойства в виде строки. |
Детали
__construct(null|PropertyPathInterface|string $path = null)
Создаёт новый билдер пути свойства.
Параметры
| null|PropertyPathInterface|string | $path | Путь для начальной записи в билдер. Необязательный. |
append(PropertyPathInterface|string $path, int $offset, int $length)
Добавляет (под-)путь к текущему пути.
Параметры
| PropertyPathInterface|string | $path | Путь для добавления |
| int | $offset | Смещение, с которого начинается добавляемый фрагмент в $path. |
| int | $length | Длина добавляемого фрагмента. Если 0, добавляется весь путь. |
appendIndex(string $name)
Добавляет элемент индекса к текущему пути.
Параметры
| string | $name | Имя добавляемого индекса |
appendProperty(string $name)
Добавляет элемент свойства к текущему пути.
Параметры
| string | $name | Имя добавляемого свойства |
remove(int $offset, int $length = 1)
Удаляет элементы из текущего пути.
Параметры
| int | $offset | Смещение для удаления |
| int | $length | Длина удаляемого фрагмента |
Исключения
| OutOfBoundsException | если смещение некорректно |
replace(int $offset, int $length, PropertyPathInterface|string $path, int $pathOffset, int $pathLength)
Заменяет подпуть другим (под-)путём.
Параметры
| int | $offset | Смещение для замены |
| int | $length | Длина заменяемого фрагмента |
| PropertyPathInterface|string | $path | Путь для вставки |
| int | $pathOffset | Смещение, с которого начинается вставляемый фрагмент в $path. |
| int | $pathLength | Длина вставляемого фрагмента. Если 0, вставляется весь путь. |
Исключения
| OutOfBoundsException | Если смещение некорректно |
replaceByIndex(int $offset, string $name = null)
Заменяет элемент свойства элементом индекса.
Параметры
| int | $offset | Смещение для замены |
| string | $name | Новое имя элемента. Необязательно |
Исключения
| OutOfBoundsException | Если смещение некорректно |
replaceByProperty(int $offset, string $name = null)
Заменяет элемент индекса элементом свойства.
Параметры
| int | $offset | Смещение для замены |
| string | $name | Новое имя элемента. Необязательно |
Исключения
| OutOfBoundsException | Если смещение некорректно |
int getLength()
Возвращает длину текущего пути.
Значение, возвращаемое функцией
| int | Длина пути |
PropertyPathInterface getPropertyPath()
Возвращает текущий путь свойства.
Значение, возвращаемое функцией
| PropertyPathInterface | Построенный путь свойства |
string __toString()
Возвращает текущий путь свойства в виде строки.
Значение, возвращаемое функцией
| string | Путь свойства в виде строки |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/PropertyAccess/PropertyPathBuilder.html
