PropertyPathBuilder
class PropertyPathBuilder
Методы
| __construct(PropertyPathInterface|string|null $path = null) Создаёт новый билдер пути свойств. | ||
| append(PropertyPathInterface|string $path, int $offset = 0, int $length = 0) Добавляет (под-)путь к текущему пути. | ||
| appendIndex(string $name) Добавляет элемент индекса к текущему пути. | ||
| appendProperty(string $name) Добавляет элемент свойства к текущему пути. | ||
| remove(int $offset, int $length = 1) Удаляет элементы из текущего пути. | ||
| replace(int $offset, int $length, PropertyPathInterface|string $path, int $pathOffset = 0, int $pathLength = 0) Заменяет подпуть другим (под-)путем. | ||
| replaceByIndex(int $offset, string $name = null) Заменяет элемент свойства элементом индекса. | ||
| replaceByProperty(int $offset, string $name = null) Заменяет элемент индекса элементом свойства. | ||
| int | getLength() Возвращает длину текущего пути. | |
| PropertyPathInterface | getPropertyPath() Возвращает текущий путь к свойству. | |
| string | __toString() Возвращает текущий путь к свойству в виде строки. |
Подробности
__construct(PropertyPathInterface|string|null $path = null)
Создаёт новый билдер пути свойств.
Параметры
| PropertyPathInterface|string|null | $path | Путь, который нужно первоначально сохранить в билдере. Необязательно. |
append(PropertyPathInterface|string $path, int $offset = 0, int $length = 0)
Добавляет (под-)путь к текущему пути.
Параметры
| 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 = 0, int $pathLength = 0)
Заменяет подпуть другим (под-)путем.
Параметры
| 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.
https://api.symfony.com/4.1/Symfony/Component/PropertyAccess/PropertyPathBuilder.html
