Login Register

PhpDocExtractor

class PhpDocExtractor implements PropertyDescriptionExtractorInterface, PropertyTypeExtractorInterface

Extracts data using a PHPDoc parser.

Constants

PROPERTY
ACCESSOR
MUTATOR

Methods

	__construct(DocBlockFactoryInterface $docBlockFactory = 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)

Parameters

DocBlockFactoryInterface

$docBlockFactory

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

Links:

http://api.symfony.com/master/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.html

doc_Symfony

2016-10-28 06:26:18

Comments

Leave a Comment

Please login to continue.

Popular Articles

PhpDocExtractor::getLongDescription() string|null getLongDescription(string $class, string $property, array $context = array()) Gets the long description of the property.

PhpDocExtractor::getTypes() Type[]|null getTypes(string $class, string $property, array $context = array()) Gets types of a property. Parameters string $class

PhpDocExtractor::getShortDescription() string|null getShortDescription(string $class, string $property, array $context = array()) Gets the short description of the property.