Gitee
\
App
HttpController
Api
Lib
Process
Redis
Composer
Autoload
CaBundle
Command
Config
Console
DependencyResolver
Operation
Downloader
EventDispatcher
Exception
Installer
IO
Json
Package
Archiver
Comparer
Dumper
LinkConstraint
Loader
Version
Plugin
Capability
Question
Repository
Pear
Vcs
Script
SelfUpdate
Semver
Constraint
Spdx
Util
XdebugHandler
Cron
Tests
EasySwoole
FastRoute
DataGenerator
Dispatcher
RouteParser
JsonSchema
Constraints
TypeCheck
Entity
Exception
Iterator
Uri
Retrievers
PhpParser
Builder
Comment
ErrorHandler
Lexer
Node
Expr
AssignOp
BinaryOp
Cast
Name
Scalar
MagicConst
Stmt
TraitUseAdaptation
NodeVisitor
Parser
PrettyPrinter
Serializer
Unserializer
Psr
Log
Test
Seld
JsonLint
PharUtils
SuperClosure
Analyzer
Visitor
Exception
Swoole
Connection
Coroutine
Http
Http2
Mysql
Http
Http2
Mysql
Redis
Server
WebSocket
Symfony
Component
Console
Command
CommandLoader
DependencyInjection
Descriptor
Event
EventListener
Exception
Formatter
Helper
Input
Logger
Output
Question
Style
Tester
Tests
Command
CommandLoader
DependencyInjection
Descriptor
EventListener
Fixtures
Formatter
Helper
Input
Logger
Output
Style
Tester
Filesystem
Exception
Tests
Fixtures
MockStream
Finder
Comparator
Exception
Iterator
Tests
Comparator
Iterator
Process
Exception
Pipes
Tests
Polyfill
Ctype
Mbstring
Php56
Util

\PhpParser\Node\StmtFunction_

Summary

Methods
Properties
Constants
__construct()
getType()
getLine()
setLine()
getDocComment()
setDocComment()
setAttribute()
hasAttribute()
getAttribute()
getAttributes()
jsonSerialize()
getSubNodeNames()
returnsByRef()
getParams()
getReturnType()
getStmts()
$byRef
$name
$params
$returnType
$stmts
No constants found
No protected methods found
$attributes
N/A
No private methods found
No private properties found
N/A

Properties

$byRef

$byRef : boolean

Type

boolean — Whether function returns by reference

$name

$name : string

Type

string — Name

$params

$params : array<mixed,\PhpParser\Node\Param>

Type

array<mixed,\PhpParser\Node\Param> — Parameters

$stmts

$stmts : array<mixed,\PhpParser\Node>

Type

array<mixed,\PhpParser\Node> — Statements

$attributes

$attributes :

Type

Methods

__construct()

__construct(string  $name, array  $subNodes = array(), array  $attributes = array())

Constructs a function node.

Parameters

string $name

Name
array $subNodes

Array of the following optional subnodes: 'byRef' => false : Whether to return by reference 'params' => array(): Parameters 'returnType' => null : Return type 'stmts' => array(): Statements
array $attributes

Additional attributes

getType()

getType() : string

Gets the type of the node.

Returns

string —

Type of the node

getLine()

getLine() : integer

Gets line the node started in.

Returns

integer —

Line

setLine()

setLine(integer  $line)

Sets line the node started in.

Parameters

integer $line

Line

getDocComment()

getDocComment() : null|\PhpParser\Comment\Doc

Gets the doc comment of the node.

The doc comment has to be the last comment associated with the node.

Returns

null|\PhpParser\Comment\Doc —

Doc comment object or null

setDocComment()

setDocComment(\PhpParser\Comment\Doc  $docComment)

Sets the doc comment of the node.

This will either replace an existing doc comment or add it to the comments array.

Parameters

\PhpParser\Comment\Doc $docComment

Doc comment to set

setAttribute()

setAttribute(string  $key, mixed  $value)

Sets an attribute on a node.

Parameters

string $key
mixed $value

hasAttribute()

hasAttribute(string  $key) : boolean

Returns whether an attribute exists.

Parameters

string $key

Returns

boolean

getAttribute()

getAttribute(string  $key, mixed  $default = null) : mixed

Returns the value of an attribute.

Parameters

string $key
mixed $default

Returns

mixed

getAttributes()

getAttributes() : array

Returns all attributes for the given node.

Returns

array

jsonSerialize()

jsonSerialize()

getSubNodeNames()

getSubNodeNames()

returnsByRef()

returnsByRef() : boolean

Whether to return by reference

Returns

boolean

getParams()

getParams() : array<mixed,\PhpParser\Node\Param>

List of parameters

Returns

array<mixed,\PhpParser\Node\Param>

getStmts()

getStmts() : array<mixed,\PhpParser\Node\Stmt>

The function body

Returns

array<mixed,\PhpParser\Node\Stmt>