TypeDocblockGeneratorPart
Type docblock generator part.
For all models that have a type and need docblock tag generated from it
Tags
Table of Contents
- getDocblock() : Docblock
- Returns the docblock.
- getType() : string
- Returns the type.
- getTypeDescription() : string
- Returns the type description.
- generateTypeTag() : void
- Generates a type tag (return or var) but checks if one exists and updates this one.
- transformNullable() : string
- Transform a `?type` PHP notation in `type|null` docblock notation.
Methods
getDocblock()
Returns the docblock.
public
abstract getDocblock() : Docblock
Return values
Docblock —getType()
Returns the type.
public
abstract getType() : string
Return values
string —getTypeDescription()
Returns the type description.
public
abstract getTypeDescription() : string
Return values
string —generateTypeTag()
Generates a type tag (return or var) but checks if one exists and updates this one.
protected
generateTypeTag(AbstractTypeTag $tag) : void
Parameters
- $tag : AbstractTypeTag
Return values
void —transformNullable()
Transform a `?type` PHP notation in `type|null` docblock notation.
private
transformNullable(string $type) : string
Parameters
- $type : string