Annotation
in package
implements
Stringable
FinalYes
This represents an entire annotation from a docblock.
Tags
Table of Contents
Interfaces
Constants
- TAGS_WITH_TYPES = ['extends', 'implements', 'method', 'param', 'param-out', 'phpstan-import-type', 'phpstan-type', 'phpstan-var', 'property', 'property-read', 'property-write', 'psalm-import-type', 'psalm-type', 'psalm-var', 'return', 'throws', 'type', 'var']
- All the annotation tag names with types.
Methods
- __construct() : mixed
- Create a new line instance.
- __toString() : string
- Get the string representation of object.
- getContent() : string
- Get the annotation content.
- getEnd() : int
- Get the end position of this annotation.
- getNormalizedTypes() : array<int, string>
- Get the normalized types associated with this annotation, so they can easily be compared.
- getStart() : int
- Get the start position of this annotation.
- getTag() : Tag
- Get the associated tag.
- getTagsWithTypes() : array<int, string>
- Get all the annotation tag names with types.
- getTypes() : array<int, string>
- Get the types associated with this annotation.
- remove() : void
- Remove this annotation by removing all its lines.
- setTypes() : void
- Set the types associated with this annotation.
- supportTypes() : bool
Constants
TAGS_WITH_TYPES
All the annotation tag names with types.
public
array<int, string>
TAGS_WITH_TYPES
= ['extends', 'implements', 'method', 'param', 'param-out', 'phpstan-import-type', 'phpstan-type', 'phpstan-var', 'property', 'property-read', 'property-write', 'psalm-import-type', 'psalm-type', 'psalm-var', 'return', 'throws', 'type', 'var']
Methods
__construct()
Create a new line instance.
public
__construct(array<string|int, mixed> $lines[, null|NamespaceAnalysis $namespace = null ][, array<int, NamespaceUseAnalysis> $namespaceUses = [] ]) : mixed
Parameters
- $lines : array<string|int, mixed>
- $namespace : null|NamespaceAnalysis = null
- $namespaceUses : array<int, NamespaceUseAnalysis> = []
__toString()
Get the string representation of object.
public
__toString() : string
Return values
stringgetContent()
Get the annotation content.
public
getContent() : string
Return values
stringgetEnd()
Get the end position of this annotation.
public
getEnd() : int
Return values
intgetNormalizedTypes()
Get the normalized types associated with this annotation, so they can easily be compared.
public
getNormalizedTypes() : array<int, string>
Return values
array<int, string>getStart()
Get the start position of this annotation.
public
getStart() : int
Return values
intgetTag()
Get the associated tag.
public
getTag() : Tag
Return values
TaggetTagsWithTypes()
Get all the annotation tag names with types.
public
static getTagsWithTypes() : array<int, string>
Use Annotation::TAGS_WITH_TYPES constant instead
Tags
Return values
array<int, string>getTypes()
Get the types associated with this annotation.
public
getTypes() : array<int, string>
Return values
array<int, string>remove()
Remove this annotation by removing all its lines.
public
remove() : void
setTypes()
Set the types associated with this annotation.
public
setTypes(array<int, string> $types) : void
Parameters
- $types : array<int, string>
supportTypes()
public
supportTypes() : bool