Function_
in package
implements
Element, MetaDataContainer
Uses
MetadataContainer
Descriptor representing a function
Interfaces, Classes and Traits
- Element
- Interface for Api Elements
- MetaDataContainer
Table of Contents
- $arguments : array<string|int, mixed>
- $docBlock : DocBlock|null
- $endLocation : Location
- $fqsen : Fqsen
- $hasReturnByReference : bool
- $location : Location
- $returnType : Type
- __construct() : mixed
- Initializes the object.
- addArgument() : void
- Add an argument to the function.
- getArguments() : array<string|int, Argument>
- Returns the arguments of this function.
- getDocBlock() : DocBlock|null
- Returns the DocBlock of the element if available
- getEndLocation() : Location
- getFqsen() : Fqsen
- Returns the Fqsen of the element.
- getHasReturnByReference() : bool
- getLocation() : Location
- getName() : string
- Returns the name of the element.
- getReturnType() : Type
Properties
$arguments
private
array<string|int, mixed>
$arguments
= []
$docBlock
private
DocBlock|null
$docBlock
$endLocation
private
Location
$endLocation
$fqsen
private
Fqsen
$fqsen
Full Qualified Structural Element Name
$hasReturnByReference
private
bool
$hasReturnByReference
$location
private
Location
$location
$returnType
private
Type
$returnType
Methods
__construct()
Initializes the object.
public
__construct(Fqsen $fqsen[, DocBlock|null $docBlock = null ][, Location|null $location = null ][, Location|null $endLocation = null ][, Type|null $returnType = null ][, bool $hasReturnByReference = false ]) : mixed
Parameters
- $fqsen : Fqsen
- $docBlock : DocBlock|null = null
- $location : Location|null = null
- $endLocation : Location|null = null
- $returnType : Type|null = null
- $hasReturnByReference : bool = false
Return values
mixed —addArgument()
Add an argument to the function.
public
addArgument(Argument $argument) : void
Parameters
- $argument : Argument
Return values
void —getArguments()
Returns the arguments of this function.
public
getArguments() : array<string|int, Argument>
Return values
array<string|int, Argument> —getDocBlock()
Returns the DocBlock of the element if available
public
getDocBlock() : DocBlock|null
Return values
DocBlock|null —getEndLocation()
public
getEndLocation() : Location
Return values
Location —getFqsen()
Returns the Fqsen of the element.
public
getFqsen() : Fqsen
Return values
Fqsen —getHasReturnByReference()
public
getHasReturnByReference() : bool
Return values
bool —getLocation()
public
getLocation() : Location
Return values
Location —getName()
Returns the name of the element.
public
getName() : string
Return values
string —getReturnType()
public
getReturnType() : Type