class PhpDocExtractor implements PropertyDescriptionExtractorInterface, PropertyTypeExtractorInterface

Extracts data using a PHPDoc parser.

Constants

PROPERTY

ACCESSOR

MUTATOR

Methods

__construct(DocBlockFactoryInterface $docBlockFactory = null, array $mutatorPrefixes = null, array $accessorPrefixes = null, array $arrayMutatorPrefixes = null)

No description

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

Gets the short description of the property.

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

Gets the long description of the property.

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

Gets types of a property.

Details

at line 54
__construct(DocBlockFactoryInterface $docBlockFactory = null, array $mutatorPrefixes = null, array $accessorPrefixes = null, array $arrayMutatorPrefixes = null)

Parameters

DocBlockFactoryInterface $docBlockFactory
array $mutatorPrefixes
array $accessorPrefixes
array $arrayMutatorPrefixes

at line 71
string|null getShortDescription(string $class, string $property, array $context = [])

Gets the short description of the property.

Parameters

string $class
string $property
array $context

Return Value

string|null

at line 97
string|null getLongDescription(string $class, string $property, array $context = [])

Gets the long description of the property.

Parameters

string $class
string $property
array $context

Return Value

string|null

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

Gets types of a property.

Parameters

string $class
string $property
array $context

Return Value

Type[]|null