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