PropertyAccessor
class PropertyAccessor implements PropertyAccessorInterface
Базовая реализация {@link PropertyAccessorInterface}.
Постоянные значения
| VALUE | |
| IS_REF | |
| IS_REF_CHAINED | |
| ACCESS_HAS_PROPERTY | |
| ACCESS_TYPE | |
| ACCESS_NAME | |
| ACCESS_REF | |
| ACCESS_ADDER | |
| ACCESS_REMOVER | |
| ACCESS_TYPE_METHOD | |
| ACCESS_TYPE_PROPERTY | |
| ACCESS_TYPE_MAGIC | |
| ACCESS_TYPE_ADDER_AND_REMOVER | |
| ACCESS_TYPE_NOT_FOUND |
Методы
| __construct($magicCall = false, $throwExceptionOnInvalidIndex = false) Не должно использоваться кодом приложения. Используйте {@link PropertyAccess::createPropertyAccessor()} вместо этого. | ||
| mixed | getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает значение в конце пути к свойству графа объекта. | |
| setValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value) Устанавливает значение в конце пути к свойству графа объекта. | ||
| bool | isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает, можно ли считать путь к свойству из графа объекта. | |
| bool | isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает, можно ли записать значение по заданному пути к свойству. |
Детали
__construct($magicCall = false, $throwExceptionOnInvalidIndex = false)
Не должно использоваться кодом приложения. Используйте {@link PropertyAccess::createPropertyAccessor()} вместо этого.
Параметры
| $magicCall | ||
| $throwExceptionOnInvalidIndex |
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 | Если значение в пути не является объектом и не является массивом |
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 | Если значение в пути не является объектом и не является массивом |
bool isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)
Возвращает, можно ли считать путь к свойству из графа объекта.
Всякий раз, когда этот метод возвращает true, {@link getValue()} гарантированно не выбросит исключение при вызове с теми же аргументами.
Параметры
| object|array | $objectOrArray | Объект или массив для проверки |
| string|PropertyPathInterface | $propertyPath | Путь к свойству для проверки |
Возвращаемое значение
| bool | Можно ли считать путь к свойству |
Исключения
| InvalidArgumentException | Если путь к свойству некорректен |
bool isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)
Возвращает, можно ли записать значение по заданному пути к свойству.
Всякий раз, когда этот метод возвращает true, {@link setValue()} гарантированно не выбросит исключение при вызове с теми же аргументами.
Параметры
| object|array | $objectOrArray | Объект или массив для проверки |
| string|PropertyPathInterface | $propertyPath | Путь к свойству для проверки |
Возвращаемое значение
| bool | Можно ли установить значение |
Исключения
| InvalidArgumentException | Если путь к свойству некорректен |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/PropertyAccess/PropertyAccessor.html