PropertyAccessorInterface
интерфейс PropertyAccessorInterface
Запись и чтение значений в/из графа объектов/массивов.
Методы
| setValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value) Устанавливает значение в конце пути свойства графа объектов. | ||
| mixed | getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает значение в конце пути свойства графа объектов. | |
| bool | isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает, можно ли записать значение по заданному пути свойства. | |
| bool | isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает, можно ли прочитать путь свойства из графа объектов. |
Подробности
setValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value)
Устанавливает значение в конце пути свойства графа объектов.
Пример:
use Symfony\Component\PropertyAccess\PropertyAccess;
$propertyAccessor = PropertyAccess::createPropertyAccessor();
echo $propertyAccessor->setValue($object, 'child.name', 'Fabien');
// equals echo $object->getChild()->setName('Fabien');
Этот метод сначала пытается найти публичный сеттер для каждого свойства в пути. Название сеттера должно быть именовано в формате «верблюжьийРегистр» и начинаться с префикса "set".
Если сеттер не найден, этот метод пытается найти публичное свойство. Значение свойства затем изменяется.
Если ни один из них не найден, генерируется исключение.
Параметры
| object|array | $objectOrArray | Объект или массив для изменения |
| string|PropertyPathInterface | $propertyPath | Путь к свойству для изменения |
| mixed | $value | Значение для установки в конце пути свойства |
Исключения
| InvalidArgumentException | Если путь свойства некорректен |
| AccessException | Если свойство/индекс не существует или не является публичным |
| UnexpectedTypeException | Если значение внутри пути не является объектом или массивом |
mixed getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)
Возвращает значение в конце пути свойства графа объектов.
Пример:
use Symfony\Component\PropertyAccess\PropertyAccess;
$propertyAccessor = PropertyAccess::createPropertyAccessor();
echo $propertyAccessor->getValue($object, 'child.name);
// equals echo $object->getChild()->getName();
Этот метод сначала пытается найти публичный геттер для каждого свойства в пути. Название геттера должно быть именовано в формате «верблюжьийРегистр» и начинаться с префикса "get", "is" или "has".
Если геттер не найден, этот метод пытается найти публичное свойство. Значение свойства затем возвращается.
Если ни один из них не найден, генерируется исключение.
Параметры
| object|array | $objectOrArray | Объект или массив для обхода |
| string|PropertyPathInterface | $propertyPath | Путь к свойству для чтения |
Значение, возвращаемое
| mixed | Значение в конце пути свойства |
Исключения
| InvalidArgumentException | Если путь свойства некорректен |
| AccessException | Если свойство/индекс не существует или не является публичным |
| UnexpectedTypeException | Если значение внутри пути не является объектом или массивом |
bool isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)
Возвращает, можно ли записать значение по заданному пути свойства.
Всякий раз, когда этот метод возвращает true, {@link setValue()} гарантированно не сгенерирует исключение при вызове с теми же аргументами.
Параметры
| object|array | $objectOrArray | Объект или массив для проверки |
| string|PropertyPathInterface | $propertyPath | Путь к свойству для проверки |
Значение, возвращаемое
| bool | Можно ли установить значение |
Исключения
| InvalidArgumentException | Если путь свойства некорректен |
bool isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)
Возвращает, можно ли прочитать путь свойства из графа объектов.
Всякий раз, когда этот метод возвращает true, {@link getValue()} гарантированно не сгенерирует исключение при вызове с теми же аргументами.
Параметры
| object|array | $objectOrArray | Объект или массив для проверки |
| string|PropertyPathInterface | $propertyPath | Путь к свойству для проверки |
Значение, возвращаемое
| bool | Можно ли прочитать путь свойства |
Исключения
| InvalidArgumentException | Если путь свойства некорректен |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/PropertyAccess/PropertyAccessorInterface.html