1. interface
  2. Symfony
  3. Component
  4. PropertyInfo
  5. PropertyInfoExtractorInterface

PropertyInfoExtractorInterface

interface PropertyInfoExtractorInterface implements PropertyTypeExtractorInterface, PropertyDescriptionExtractorInterface, PropertyAccessExtractorInterface, PropertyListExtractorInterface

Gets info about PHP class properties.

A convenient interface inheriting all specific info interfaces.

Methods

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

Gets types of a property.

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

Gets the short description of the property.

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

Gets the long description of the property.

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

Is the property readable?

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

Is the property writable?

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

Gets the list of properties available for the given class.

from PropertyListExtractorInterface

Details

in PropertyTypeExtractorInterface at line line 30
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

in PropertyDescriptionExtractorInterface at line line 30
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

in PropertyDescriptionExtractorInterface at line line 41
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

in PropertyAccessExtractorInterface at line line 30
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

in PropertyAccessExtractorInterface at line line 41
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

in PropertyListExtractorInterface at line line 29
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