phpDocumentor

ParamDescriptor extends TypedVariableAbstract
in package

Descriptor representing the param tag with a function or method.

Table of Contents

Properties

$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$name  : string
$type  : Type|null
$variableName  : string

Methods

__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getName()  : string
Returns the name for this element.
getType()  : Type|null
getTypes()  : array<int, Type>
getVariableName()  : string
Retrieves the variable name stored on this descriptor.
setDescription()  : void
Sets a description or none to inherit from a parent.
setType()  : void
setVariableName()  : void
Sets the variable name on this descriptor.

Properties

$type

protected Type|null $type = null

normalized type of this argument

Methods

__toString()

public __toString() : string
Return values
string

getName()

Returns the name for this element.

public getName() : string
Return values
string

getType()

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

getTypes()

public getTypes() : array<int, Type>
Return values
array<int, Type>

getVariableName()

Retrieves the variable name stored on this descriptor.

public getVariableName() : string
Return values
string

setType()

public setType(Type|null $type) : void
Parameters
$type : Type|null

setVariableName()

Sets the variable name on this descriptor.

public setVariableName(string $variableName) : void
Parameters
$variableName : string

        
On this page

Search results