W3cubDocs

/Symfony 4.1

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)
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

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