Overview

Namespaces

  • TokenReflection
    • Broker
      • Backend
    • Dummy
    • Exception
    • Invalid
    • Php
    • Stream

Classes

  • ReflectionClass
  • ReflectionConstant
  • ReflectionElement
  • ReflectionFunction
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class ReflectionFunction

Invalid function reflection.

The reflected function is not unique.

TokenReflection\Invalid\ReflectionElement
Extended by TokenReflection\Invalid\ReflectionFunction implements TokenReflection\IReflectionFunction
Namespace: TokenReflection\Invalid
Located at Invalid/ReflectionFunction.php
Methods summary
public
# __construct( string $name, string $fileName, TokenReflection\Broker $broker )

Constructor.

Constructor.

Parameters

$name
string
$name Function name
$fileName
string
$fileName Original definiton file name
$broker
TokenReflection\Broker
$broker Reflection broker
public string
# getName( )

Returns the name (FQN).

Returns the name (FQN).

Returns

string

Implementation of

TokenReflection\IReflection::getName()
public string
# getShortName( )

Returns the unqualified name (UQN).

Returns the unqualified name (UQN).

Returns

string
public string
# getNamespaceName( )

Returns the namespace name.

Returns the namespace name.

Returns

string

Implementation of

TokenReflection\IReflectionFunctionBase::getNamespaceName()
public boolean
# inNamespace( )

Returns if the class is defined within a namespace.

Returns if the class is defined within a namespace.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunctionBase::inNamespace()
public boolean
# isInternal( )

Returns if the reflection object is internal.

Returns if the reflection object is internal.

Returns

boolean

Implementation of

TokenReflection\IReflection::isInternal()
public boolean
# isUserDefined( )

Returns if the reflection object is user defined.

Returns if the reflection object is user defined.

Returns

boolean

Implementation of

TokenReflection\IReflection::isUserDefined()
public boolean
# isTokenized( )

Returns if the current reflection comes from a tokenized source.

Returns if the current reflection comes from a tokenized source.

Returns

boolean

Implementation of

TokenReflection\IReflection::isTokenized()
public TokenReflection\Broker
# getBroker( )

Returns the reflection broker used by this reflection object.

Returns the reflection broker used by this reflection object.

Returns

TokenReflection\Broker

Implementation of

TokenReflection\IReflection::getBroker()
public string
# getPrettyName( )

Returns an element pretty (docblock compatible) name.

Returns an element pretty (docblock compatible) name.

Returns

string

Implementation of

TokenReflection\IReflection::getPrettyName()
public TokenReflection\IReflectionExtension|null
# getExtension( )

Returns the PHP extension reflection.

Returns the PHP extension reflection.

Returns

TokenReflection\IReflectionExtension|null

Implementation of

TokenReflection\IReflectionFunctionBase::getExtension()
public false
# getExtensionName( )

Returns the PHP extension name.

Returns the PHP extension name.

Returns

false

Implementation of

TokenReflection\IReflectionFunctionBase::getExtensionName()
public null
# getFileName( )

Returns the file name the reflection object is defined in.

Returns the file name the reflection object is defined in.

Returns

null

Implementation of

TokenReflection\IReflectionFunctionBase::getFileName()
public TokenReflection\ReflectionFile
# getFileReflection( )

Returns a file reflection.

Returns a file reflection.

Returns

TokenReflection\ReflectionFile

Throws

TokenReflection\Exception\RuntimeException
If the file is not stored inside the broker
public string
# getSource( )

Returns the appropriate source code part.

Returns the appropriate source code part.

Returns

string
public integer
# getStartPosition( )

Returns the start position in the file token stream.

Returns the start position in the file token stream.

Returns

integer
public integer
# getEndPosition( )

Returns the end position in the file token stream.

Returns the end position in the file token stream.

Returns

integer
public integer
# getStartLine( )

Returns the definition start line number in the file.

Returns the definition start line number in the file.

Returns

integer

Implementation of

TokenReflection\IReflectionFunctionBase::getStartLine()
public integer
# getEndLine( )

Returns the definition end line number in the file.

Returns the definition end line number in the file.

Returns

integer

Implementation of

TokenReflection\IReflectionFunctionBase::getEndLine()
public boolean
# getDocComment( )

Returns the appropriate docblock definition.

Returns the appropriate docblock definition.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunctionBase::getDocComment()
public boolean
# hasAnnotation( string $name )

Checks if there is a particular annotation.

Checks if there is a particular annotation.

Parameters

$name
string
$name Annotation name

Returns

boolean
public string|array|null
# getAnnotation( string $name )

Returns a particular annotation value.

Returns a particular annotation value.

Parameters

$name
string
$name Annotation name

Returns

string|array|null
public array
# getAnnotations( )

Returns all annotations.

Returns all annotations.

Returns

array
public boolean
# isClosure( )

Returns if the function/method is a closure.

Returns if the function/method is a closure.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunctionBase::isClosure()
public boolean
# isDeprecated( )

Returns if the function/method is deprecated.

Returns if the function/method is deprecated.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunctionBase::isDeprecated()
public boolean
# returnsReference( )

Returns if the function/method returns its value as reference.

Returns if the function/method returns its value as reference.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunctionBase::returnsReference()
public TokenReflection\IReflectionParameter
# getParameter( integer|string $parameter )

Returns a function/method parameter.

Returns a function/method parameter.

Parameters

$parameter
integer|string
$parameter Parameter name or position

Returns

TokenReflection\IReflectionParameter

Implementation of

TokenReflection\IReflectionFunctionBase::getParameter()
public array
# getParameters( )

Returns function/method parameters.

Returns function/method parameters.

Returns

array

Implementation of

TokenReflection\IReflectionFunctionBase::getParameters()
public integer
# getNumberOfParameters( )

Returns the number of parameters.

Returns the number of parameters.

Returns

integer

Implementation of

TokenReflection\IReflectionFunctionBase::getNumberOfParameters()
public integer
# getNumberOfRequiredParameters( )

Returns the number of required parameters.

Returns the number of required parameters.

Returns

integer

Implementation of

TokenReflection\IReflectionFunctionBase::getNumberOfRequiredParameters()
public array
# getStaticVariables( )

Returns static variables.

Returns static variables.

Returns

array

Implementation of

TokenReflection\IReflectionFunctionBase::getStaticVariables()
public boolean
# isDisabled( )

Returns if the method is is disabled via the disable_functions directive.

Returns if the method is is disabled via the disable_functions directive.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunction::isDisabled()
public mixed
# invoke( )

Calls the function.

Calls the function.

Returns

mixed
public mixed
# invokeArgs( array $args )

Calls the function.

Calls the function.

Parameters

$args
array
$args Function parameter values

Returns

mixed

Implementation of

TokenReflection\IReflectionFunction::invokeArgs()
public array
# getNamespaceAliases( )

Returns imported namespaces and aliases from the declaring namespace.

Returns imported namespaces and aliases from the declaring namespace.

Returns

array

Implementation of

TokenReflection\IReflectionFunction::getNamespaceAliases()
public Closure
# getClosure( )

Returns the function/method as closure.

Returns the function/method as closure.

Returns

Closure

Implementation of

TokenReflection\IReflectionFunction::getClosure()
public null
# getClosureScopeClass( )

Returns the closure scope class.

Returns the closure scope class.

Returns

null
public null
# getClosureThis( )

Returns this pointer bound to closure.

Returns this pointer bound to closure.

Returns

null
public boolean
# isValid( )

Returns if the function definition is valid.

Returns if the function definition is valid.

Returns

boolean

Implementation of

TokenReflection\IReflectionFunction::isValid()
public string
# __toString( )

Returns the string representation of the reflection object.

Returns the string representation of the reflection object.

Returns

string
final public mixed
# __get( string $key )

Magic __get method.

Magic __get method.

Parameters

$key
string
$key Variable name

Returns

mixed

Implementation of

TokenReflection\IReflection::__get()
final public boolean
# __isset( string $key )

Magic __isset method.

Magic __isset method.

Parameters

$key
string
$key Variable name

Returns

boolean

Implementation of

TokenReflection\IReflection::__isset()
Methods inherited from TokenReflection\Invalid\ReflectionElement
addReason(), getReasons(), hasReasons()
PHP Token Reflection API documentation generated by ApiGen 2.8.0