RelativePath
class RelativePath extends PropertyPath
Постоянные значения
| SINGULAR_SEPARATOR | Символ, используемый для разделения множественного и единственного числа элемента. |
Методы
| __construct(FormInterface $root, PropertyPath|string $propertyPath) | ||
| string | __toString() Возвращает строковое представление пути к свойству | из PropertyPath |
| integer | getLength() Возвращает длину пути к свойству, т.е. количество элементов. | из PropertyPath |
| PropertyPath | getParent() Возвращает родительский путь к свойству. | из PropertyPath |
| PropertyPathIteratorInterface | getIterator() Возвращает новый итератор для этого пути | из PropertyPath |
| array | getElements() Возвращает элементы пути к свойству в виде массива | из PropertyPath |
| string | getElement(integer $index) Возвращает элемент по заданному индексу в пути к свойству | из PropertyPath |
| Boolean | isProperty(integer $index) Возвращает, является ли элемент по заданному индексу свойством | из PropertyPath |
| Boolean | isIndex(integer $index) Возвращает, является ли элемент по заданному индексу индексом массива | из PropertyPath |
| FormInterface | getRoot() |
Подробности
__construct(FormInterface $root, PropertyPath|string $propertyPath)
Параметры
| FormInterface | $root | |
| PropertyPath|string | $propertyPath | Путь к свойству в виде строки или экземпляра |
string __toString()
Возвращает строковое представление пути к свойству
Значение возврата
| string | Путь в виде строки |
integer getLength()
Возвращает длину пути к свойству, т.е. количество элементов.
Значение возврата
| integer | Длина пути |
PropertyPath getParent()
Возвращает родительский путь к свойству.
Родительский путь к свойству — это тот, который содержит те же элементы, что и этот, за исключением последнего.
Если этот путь к свойству содержит только один элемент, возвращается null.
Значение возврата
| PropertyPath | Родительский путь или null |
PropertyPathIteratorInterface getIterator()
Возвращает новый итератор для этого пути
Значение возврата
| PropertyPathIteratorInterface |
array getElements()
Возвращает элементы пути к свойству в виде массива
Значение возврата
| array | Массив имён свойств/индексов |
string getElement(integer $index)
Возвращает элемент по заданному индексу в пути к свойству
Параметры
| integer | $index | Ключ индекса |
Значение возврата
| string | Имя свойства или индекса |
Исключения
| OutOfBoundsException | Если смещение недействительно |
Boolean isProperty(integer $index)
Возвращает, является ли элемент по заданному индексу свойством
Параметры
| integer | $index | Индекс в пути к свойству |
Значение возврата
| Boolean | Является ли элемент по данному индексу свойством |
Исключения
| OutOfBoundsException | Если смещение недействительно |
Boolean isIndex(integer $index)
Возвращает, является ли элемент по заданному индексу индексом массива
Параметры
| integer | $index | Индекс в пути к свойству |
Значение возврата
| Boolean | Является ли элемент по данному индексу индексом массива |
Исключения
| OutOfBoundsException | Если смещение недействительно |
FormInterface getRoot()
Значение возврата
| FormInterface |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Form/Extension/Validator/ViolationMapper/RelativePath.html