1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. PropertyInfo
  7. \
  8. Extractor
  9. \
  10. PhpDocExtractor

PhpDocExtractor

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 = 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.

Details

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

Parameters

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

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