phpDocumentor

TypedAbstract extends TagDescriptor
in package

Base descriptor for tags that have a type associated with them.

Table of Contents

$description  : DescriptionDescriptor
$errors  : Collection<string|int, Error>
$name  : string
$types  : Type|null
__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this tag,
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getName()  : string
Returns the name for this tag.
getType()  : Type|null
getTypes()  : list<string|int, Type>
Returns the list of types associated with this tag.
setDescription()  : void
Sets a description for this tab instance.
setErrors()  : void
Sets a list of errors found on the usage of this tag.
setType()  : void
Sets a list of types associated with this tag.
setTypes()  : void
Sets a list of types associated with this tag.
setName()  : void
Sets the name for this tag.

Properties

Methods

__toString()

public __toString() : string
Return values
string

getName()

Returns the name for this tag.

public getName() : string
Return values
string

getType()

public getType() : Type|null
Return values
Type|null

getTypes()

Returns the list of types associated with this tag.

public getTypes() : list<string|int, Type>
Tags
deprecated
codeCoverageIgnore

because deprecated and the error makes phpunit fail

Return values
list<string|int, Type>

setType()

Sets a list of types associated with this tag.

public setType([Type|null $types = null ]) : void
Parameters
$types : Type|null = null
Return values
void

setTypes()

Sets a list of types associated with this tag.

public setTypes([Type|null $types = null ]) : void
Parameters
$types : Type|null = null
Tags
deprecated
codeCoverageIgnore

because deprecated and the error makes phpunit fail

Return values
void

setName()

Sets the name for this tag.

protected setName(string $name) : void
Parameters
$name : string
Return values
void

Search results