Overview

Namespaces

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

Classes

  • ReflectionClass
  • ReflectionConstant
  • ReflectionExtension
  • ReflectionFunction
  • ReflectionMethod
  • ReflectionParameter
  • ReflectionProperty

Interfaces

  • IReflection
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class ReflectionParameter

Reflection of a not tokenized but defined method/function parameter.

Descendant of the internal reflection with additional features.

ReflectionParameter implements Reflector
Extended by TokenReflection\Php\ReflectionParameter implements TokenReflection\Php\IReflection, TokenReflection\IReflectionParameter
Namespace: TokenReflection\Php
Located at Php/ReflectionParameter.php
Methods summary
public
# __construct( string|array $function, string $paramName, TokenReflection\Broker $broker, ReflectionFunctionAbstract $parent )

Constructor.

Constructor.

Parameters

$function
string|array
$function Defining function/method
$paramName
string
$paramName Parameter name
$broker
TokenReflection\Broker
$broker Reflection broker
$parent
ReflectionFunctionAbstract
$parent Parent reflection object

Overrides

ReflectionParameter::__construct()
public TokenReflection\IReflectionClass
# getDeclaringClass( )

Returns the declaring class reflection.

Returns the declaring class reflection.

Returns

TokenReflection\IReflectionClass

Overrides

ReflectionParameter::getDeclaringClass()

Implementation of

TokenReflection\IReflectionParameter::getDeclaringClass()
public string|null
# getDeclaringClassName( )

Returns the declaring class name.

Returns the declaring class name.

Returns

string|null

Implementation of

TokenReflection\IReflectionParameter::getDeclaringClassName()
public array
# getNamespaceAliases( )

Returns imported namespaces and aliases from the declaring namespace.

Returns imported namespaces and aliases from the declaring namespace.

Returns

array
public string
# getFileName( )

Returns the file name the reflection object is defined in.

Returns the file name the reflection object is defined in.

Returns

string
public TokenReflection\Php\ReflectionExtension
# getExtension( )

Returns the PHP extension reflection.

Returns the PHP extension reflection.

Returns

TokenReflection\Php\ReflectionExtension
public string|boolean
# getExtensionName( )

Returns the PHP extension name.

Returns the PHP extension name.

Returns

string|boolean
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 null
# getAnnotation( string $name )

Returns a particular annotation value.

Returns a particular annotation value.

Parameters

$name
string
$name Annotation name

Returns

null
public array
# getAnnotations( )

Returns parsed docblock.

Returns parsed docblock.

Returns

array
public TokenReflection\Php\ReflectionFunction|TokenReflection\Php\ReflectionMethod
# getDeclaringFunction( )

Returns the declaring function reflection.

Returns the declaring function reflection.

Returns

TokenReflection\Php\ReflectionFunction|TokenReflection\Php\ReflectionMethod

Overrides

ReflectionParameter::getDeclaringFunction()

Implementation of

TokenReflection\IReflectionParameter::getDeclaringFunction()
public string|null
# getDeclaringFunctionName( )

Returns the declaring function name.

Returns the declaring function name.

Returns

string|null

Implementation of

TokenReflection\IReflectionParameter::getDeclaringFunctionName()
public null
# getStartLine( )

Returns the definition start line number in the file.

Returns the definition start line number in the file.

Returns

null

Implementation of

TokenReflection\IReflectionParameter::getStartLine()
public null
# getEndLine( )

Returns the definition end line number in the file.

Returns the definition end line number in the file.

Returns

null

Implementation of

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

Returns the appropriate docblock definition.

Returns the appropriate docblock definition.

Returns

boolean

Implementation of

TokenReflection\IReflectionParameter::getDocComment()
public string|null
# getDefaultValueDefinition( )

Returns the part of the source code defining the paramter default value.

Returns the part of the source code defining the paramter default value.

Returns

string|null

Implementation of

TokenReflection\IReflectionParameter::getDefaultValueDefinition()
public boolean
# isCallable( )

Returns if the parameter expects a callback.

Returns if the parameter expects a callback.

Returns

boolean
public string|null
# getOriginalTypeHint( )

Returns the original type hint as defined in the source code.

Returns the original type hint as defined in the source code.

Returns

string|null
public string|null
# getClassName( )

Returns the required class name of the value.

Returns the required class name of the value.

Returns

string|null

Implementation of

TokenReflection\IReflectionParameter::getClassName()
public boolean
# isInternal( )

Returns if the parameter is internal.

Returns if the parameter is internal.

Returns

boolean

Implementation of

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

Returns if the parameter is user defined.

Returns if the parameter 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 boolean
# isDeprecated( )

Returns if the reflection subject is deprecated.

Returns if the reflection subject is deprecated.

Returns

boolean
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 boolean
# canBePassedByValue( )

Returns if the paramter value can be passed by value.

Returns if the paramter value can be passed by value.

Returns

boolean

Implementation of

TokenReflection\IReflectionParameter::canBePassedByValue()
public string
# getPrettyName( )

Returns an element pretty (docblock compatible) name.

Returns an element pretty (docblock compatible) name.

Returns

string

Implementation of

TokenReflection\IReflection::getPrettyName()
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()
public static TokenReflection\Php\ReflectionParameter
# create( Reflector $internalReflection, TokenReflection\Broker $broker )

Creates a reflection instance.

Creates a reflection instance.

Parameters

$internalReflection
ReflectionClass
$internalReflection Internal reflection instance
$broker
TokenReflection\Broker
$broker Reflection broker instance

Returns

TokenReflection\Php\ReflectionParameter

Throws

TokenReflection\Exception\RuntimeException
If an invalid internal reflection object was provided.

Implementation of

TokenReflection\Php\IReflection::create()
Methods inherited from ReflectionParameter
__toString(), allowsNull(), export(), getClass(), getDefaultValue(), getName(), getPosition(), isArray(), isDefaultValueAvailable(), isOptional(), isPassedByReference()
Properties inherited from ReflectionParameter
$name
PHP Token Reflection API documentation generated by ApiGen 2.8.0