FunctionLike
extends Declaration
in package
Table of Contents
- $attributes : mixed
- $params : mixed
- $returnByRef : mixed
- $returnType : string|Name|NullableType|null
- addParam() : $this
- Adds a parameter.
- addParams() : $this
- Adds multiple parameters.
- addStmt() : mixed
- addStmts() : $this
- Adds multiple statements.
- makeReturnByRef() : $this
- Make the function return by reference.
- setDocComment() : $this
- Sets doc comment for the declaration.
- setReturnType() : $this
- Sets the return type for PHP 7.
Properties
$attributes
protected
mixed
$attributes
= []
$params
protected
mixed
$params
= []
$returnByRef
protected
mixed
$returnByRef
= false
$returnType
protected
string|Name|NullableType|null
$returnType
= null
Methods
addParam()
Adds a parameter.
public
addParam(Param|Param $param) : $this
Parameters
Return values
$this —The builder instance (for fluid interface)
addParams()
Adds multiple parameters.
public
addParams(array<string|int, mixed> $params) : $this
Parameters
- $params : array<string|int, mixed>
-
The parameters to add
Return values
$this —The builder instance (for fluid interface)
addStmt()
public
abstract addStmt(mixed $stmt) : mixed
Parameters
- $stmt : mixed
Return values
mixed —addStmts()
Adds multiple statements.
public
addStmts(array<string|int, mixed> $stmts) : $this
Parameters
- $stmts : array<string|int, mixed>
-
The statements to add
Return values
$this —The builder instance (for fluid interface)
makeReturnByRef()
Make the function return by reference.
public
makeReturnByRef() : $this
Return values
$this —The builder instance (for fluid interface)
setDocComment()
Sets doc comment for the declaration.
public
setDocComment(Doc|string $docComment) : $this
Parameters
- $docComment : Doc|string
-
Doc comment to set
Return values
$this —The builder instance (for fluid interface)
setReturnType()
Sets the return type for PHP 7.
public
setReturnType(string|Name|Identifier|ComplexType $type) : $this
Parameters
- $type : string|Name|Identifier|ComplexType
Return values
$this —The builder instance (for fluid interface)