Constants

PROPERTY

PROPERTY = 0

ACCESSOR

ACCESSOR = 1

MUTATOR

MUTATOR = 2

Properties

$docBlocks

$docBlocks : \phpDocumentor\Reflection\DocBlock[]

Type

DocBlock[]

$contexts

$contexts : \phpDocumentor\Reflection\Types\Context[]

Type

Context[]

$docBlockFactory

$docBlockFactory

$contextFactory

$contextFactory

$phpDocTypeHelper

$phpDocTypeHelper

$mutatorPrefixes

$mutatorPrefixes

$accessorPrefixes

$accessorPrefixes

$arrayMutatorPrefixes

$arrayMutatorPrefixes

Methods

__construct()

__construct(\phpDocumentor\Reflection\DocBlockFactoryInterface  $docBlockFactory = null, string[]|null  $mutatorPrefixes = null, string[]|null  $accessorPrefixes = null, string[]|null  $arrayMutatorPrefixes = null) : mixed

Parameters

\phpDocumentor\Reflection\DocBlockFactoryInterface $docBlockFactory
string[]|null $mutatorPrefixes
string[]|null $accessorPrefixes
string[]|null $arrayMutatorPrefixes

Returns

mixed —

getShortDescription()

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

Gets the short description of the property.

Parameters

string $class
string $property
array $context

Returns

string|null —

getLongDescription()

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

Gets the long description of the property.

Parameters

string $class
string $property
array $context

Returns

string|null —

getTypes()

getTypes(string  $class, string  $property, array  $context = []) : \Symfony\Component\PropertyInfo\Type[]|null

Gets types of a property.

Parameters

string $class
string $property
array $context

Returns

\Symfony\Component\PropertyInfo\Type[]|null —

getTypesFromConstructor()

getTypesFromConstructor(string  $class, string  $property) : ?array

{@inheritdoc}

Parameters

string $class
string $property

Returns

?array —

getDocBlockFromConstructor()

getDocBlockFromConstructor(string  $class, string  $property) : ?\phpDocumentor\Reflection\DocBlock

Parameters

string $class
string $property

Returns

?\phpDocumentor\Reflection\DocBlock —

filterDocBlockParams()

filterDocBlockParams(\phpDocumentor\Reflection\DocBlock  $docBlock, string  $allowedParam) : \phpDocumentor\Reflection\DocBlock

Parameters

\phpDocumentor\Reflection\DocBlock $docBlock
string $allowedParam

Returns

\phpDocumentor\Reflection\DocBlock —

getDocBlock()

getDocBlock(string  $class, string  $property) : array

Parameters

string $class
string $property

Returns

array —

getDocBlockFromProperty()

getDocBlockFromProperty(string  $class, string  $property) : ?\phpDocumentor\Reflection\DocBlock

Parameters

string $class
string $property

Returns

?\phpDocumentor\Reflection\DocBlock —

getDocBlockFromMethod()

getDocBlockFromMethod(string  $class, string  $ucFirstProperty, int  $type) : ?array

Parameters

string $class
string $ucFirstProperty
int $type

Returns

?array —

createFromReflector()

createFromReflector(\ReflectionClass  $reflector) : \phpDocumentor\Reflection\Types\Context

Prevents a lot of redundant calls to ContextFactory::createForNamespace().

Parameters

\ReflectionClass $reflector

Returns

\phpDocumentor\Reflection\Types\Context —