W3cubDocs

/Symfony 4.1

PropertyInfoExtractor

class PropertyInfoExtractor implements PropertyInfoExtractorInterface

Default {see PropertyInfoExtractorInterface} implementation.

Methods

__construct(iterable $listExtractors = array(), iterable $typeExtractors = array(), iterable $descriptionExtractors = array(), iterable $accessExtractors = array())
string[]|null getProperties(string $class, array $context = array())

Gets the list of properties available for the given class.

string|null getShortDescription(string $class, string $property, array $context = array())

Gets the short description of the property.

string|null getLongDescription(string $class, string $property, array $context = array())

Gets the long description of the property.

Type[]|null getTypes(string $class, string $property, array $context = array())

Gets types of a property.

bool|null isReadable(string $class, string $property, array $context = array())

Is the property readable?

bool|null isWritable(string $class, string $property, array $context = array())

Is the property writable?

Details

__construct(iterable $listExtractors = array(), iterable $typeExtractors = array(), iterable $descriptionExtractors = array(), iterable $accessExtractors = array())

Parameters

iterable $listExtractors
iterable $typeExtractors
iterable $descriptionExtractors
iterable $accessExtractors

string[]|null getProperties(string $class, array $context = array())

Gets the list of properties available for the given class.

Parameters

string $class
array $context

Return Value

string[]|null

string|null getShortDescription(string $class, string $property, array $context = array())

Gets the short description of the property.

Parameters

string $class
string $property
array $context

Return Value

string|null

string|null getLongDescription(string $class, string $property, array $context = array())

Gets the long description of the property.

Parameters

string $class
string $property
array $context

Return Value

string|null

Type[]|null getTypes(string $class, string $property, array $context = array())

Gets types of a property.

Parameters

string $class
string $property
array $context

Return Value

Type[]|null

bool|null isReadable(string $class, string $property, array $context = array())

Is the property readable?

Parameters

string $class
string $property
array $context

Return Value

bool|null

bool|null isWritable(string $class, string $property, array $context = array())

Is the property writable?

Parameters

string $class
string $property
array $context

Return Value

bool|null

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/PropertyInfo/PropertyInfoExtractor.html