ReflectionFunctionAbstract

abstract class ReflectionFunctionAbstract implements Reflector (View source)

A parent class to ReflectionFunction, read its description for details.

Properties

string $name

Methods

bool
inNamespace()

Checks if function in namespace

bool
isClosure()

Checks if closure

bool
isDeprecated()

Checks if deprecated

bool
isInternal()

Checks if is internal

bool
isUserDefined()

Checks if user defined

bool
isGenerator()

Returns whether this function is a generator

bool
isVariadic()

Returns whether this function is variadic

object|null
getClosureThis()

Returns this pointer bound to closure

ReflectionClass|null
getClosureScopeClass()

Returns the scope associated to the closure

ReflectionClass|null
getClosureCalledClass()

No description

string|false
getDocComment()

Gets doc comment

int|false
getEndLine()

Gets end line number

ReflectionExtension|null
getExtension()

Gets extension info

string|false
getExtensionName()

Gets extension name

string|false
getFileName()

Gets file name

string
getName()

Gets function name

string
getNamespaceName()

Gets namespace name

int
getNumberOfParameters()

Gets number of parameters

int
getNumberOfRequiredParameters()

Gets number of required parameters

array
getParameters()

Gets parameters

ReflectionType|null
getReturnType()

Gets the specified return type of a function

string
getShortName()

Gets function short name

int|false
getStartLine()

Gets starting line number

array
getStaticVariables()

Gets static variables

bool
returnsReference()

Checks if returns reference

bool
hasReturnType()

Checks if the function has a specified return type

array
getAttributes(string|null $name = null, int $flags = 0)

No description

array
getClosureUsedVariables()

Returns an array of the used variables in the Closure

bool
hasTentativeReturnType()

Returns whether the function has a tentative return type

ReflectionType|null
getTentativeReturnType()

Returns the tentative return type associated with the function

bool
isStatic()

Checks if the function is static

string
__toString()

Returns the string representation of the ReflectionFunctionAbstract object

Details

at line 48
bool inNamespace()

Checks if function in namespace

Return Value

bool

{\true} if it's in a namespace, otherwise {\false}

at line 57
bool isClosure()

Checks if closure

Return Value

bool

{\true} if it's a closure, otherwise {\false}

at line 67
bool isDeprecated()

Checks if deprecated

Return Value

bool

{\true} if it's deprecated, otherwise {\false}

at line 77
bool isInternal()

Checks if is internal

Return Value

bool

{\true} if it's internal, otherwise {\false}

at line 87
bool isUserDefined()

Checks if user defined

Return Value

bool

{\true} if it's user-defined, otherwise {\false}

at line 98
bool isGenerator()

Since: 5.5

Returns whether this function is a generator

Return Value

bool

{\true} if the function is generator, otherwise {\false}

at line 109
bool isVariadic()

Since: 5.6

Returns whether this function is variadic

Return Value

bool

{\true} if the function is variadic, otherwise {\false}

at line 119
object|null getClosureThis()

Returns this pointer bound to closure

Return Value

object|null

Returns $this pointer or {\null} in case of an error.

at line 131
ReflectionClass|null getClosureScopeClass()

Since: 5.4

Returns the scope associated to the closure

Return Value

ReflectionClass|null

Returns the class on success or {\null} on failure.

at line 140
ReflectionClass|null getClosureCalledClass()

Since: 8.0

No description

Return Value

ReflectionClass|null

Returns the class on success or {\null} on failure.

at line 150
string|false getDocComment()

Gets doc comment

Return Value

string|false

The doc comment if it exists, otherwise {\false}

at line 161
int|false getEndLine()

Gets end line number

Return Value

int|false

The ending line number of the user defined function, or {\false} if unknown.

at line 172
ReflectionExtension|null getExtension()

Gets extension info

Return Value

ReflectionExtension|null

The extension information, as a {\ReflectionExtension} object or {\null} instead.

at line 182
string|false getExtensionName()

Gets extension name

Return Value

string|false

The extension's name or {\false} instead.

at line 192
string|false getFileName()

Gets file name

Return Value

string|false

The file name or {\false} in case of error.

at line 202
string getName()

Gets function name

Return Value

string

The name of the function.

at line 212
string getNamespaceName()

Gets namespace name

Return Value

string

The namespace name.

at line 223
int getNumberOfParameters()

Since: 5.0

Gets number of parameters

Return Value

int

The number of parameters.

at line 234
int getNumberOfRequiredParameters()

Since: 5.0

Gets number of required parameters

Return Value

int

The number of required parameters.

at line 244
array getParameters()

Gets parameters

Return Value

array

The parameters, as a ReflectionParameter objects.

at line 256
ReflectionType|null getReturnType()

Since: 7.0

Gets the specified return type of a function

Return Value

ReflectionType|null

Returns a {\ReflectionType} object if a return type is specified, {\null} otherwise.

at line 274
string getShortName()

Gets function short name

Return Value

string

The short name of the function.

at line 284
int|false getStartLine()

Gets starting line number

Return Value

int|false

The starting line number or {\false} if unknown.

at line 294
array getStaticVariables()

Gets static variables

Return Value

array

An array of static variables.

at line 304
bool returnsReference()

Checks if returns reference

Return Value

bool

{\true} if it returns a reference, otherwise {\false}

at line 315
bool hasReturnType()

Since: 7.0

Checks if the function has a specified return type

Return Value

bool

Returns {\true} if the function is a specified return type, otherwise {\false}.

at line 328
array getAttributes(string|null $name = null, int $flags = 0)

Since: 8.0

No description

Parameters

string|null $name

Name of an attribute class
int $flags

Сriteria by which the attribute is searched.

Return Value

array

at line 336
array getClosureUsedVariables()

Returns an array of the used variables in the Closure

Return Value

array

Returns an array of the used variables in the Closure.

at line 345
bool hasTentativeReturnType()

Returns whether the function has a tentative return type

Return Value

bool

Returns true if the function has a tentative return type, otherwise false.

at line 355
ReflectionType|null getTentativeReturnType()

Returns the tentative return type associated with the function

Return Value

ReflectionType|null

Returns a ReflectionType object if a tentative return type is specified, null otherwise.

at line 364
bool isStatic()

Checks if the function is static

Return Value

bool

true if the function is static, otherwise false

at line 376
string __toString()

Returns the string representation of the ReflectionFunctionAbstract object

Get a human-readable description of the function, its parameters and return values.

Return Value

string

Returns string representation of the object that implements this interface (and/or "__toString" magic method).