PropertyAccessor
class PropertyAccessor implements PropertyAccessorInterface
Базовая реализация {@link PropertyAccessorInterface}.
Постоянные значения
| VALUE | |
| 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(bool $magicCall = false, bool $throwExceptionOnInvalidIndex = false) Не должно использоваться кодом приложения. Используйте {@link PropertyAccess::createPropertyAccessor()} вместо этого. | ||
| mixed | getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает значение в конце пути к свойству в графе объекта. | |
| setValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value) Устанавливает значение в конце пути к свойству в графе объекта. | ||
| static | handleError($type, $message, $file, $line, $context) | |
| bool | isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает, может ли быть прочитано свойство по пути от графа объекта. | |
| bool | isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath) Возвращает, может ли быть установлено значение по данному пути к свойству. |
Подробное описание
__construct(bool $magicCall = false, bool $throwExceptionOnInvalidIndex = false)
Не должно использоваться кодом приложения. Используйте {@link PropertyAccess::createPropertyAccessor()} вместо этого.
Параметры
| bool | $magicCall | |
| bool | $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 | Если значение в пути не является объектом или массивом |
static handleError($type, $message, $file, $line, $context)
Параметры
| $type | ||
| $message | ||
| $file | ||
| $line | ||
| $context |
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/2.7/Symfony/Component/PropertyAccess/PropertyAccessor.html