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 ReflectionProperty

Reflection of a not tokenized but defined class property.

Descendant of the internal reflection with additional features.

ReflectionProperty implements Reflector
Extended by TokenReflection\Php\ReflectionProperty implements TokenReflection\Php\IReflection, TokenReflection\IReflectionProperty
Namespace: TokenReflection\Php
Located at Php/ReflectionProperty.php
Methods summary
public
# __construct( string|TokenReflection\Php\ReflectionClass|ReflectionClass $class, string $propertyName, TokenReflection\Broker $broker )

Constructor.

Constructor.

Parameters

$class
string|TokenReflection\Php\ReflectionClass|ReflectionClass
$class Defining class
$propertyName
string
$propertyName Property name
$broker
TokenReflection\Broker
$broker Reflection broker

Overrides

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

Returns the declaring class reflection.

Returns the declaring class reflection.

Returns

TokenReflection\IReflectionClass

Overrides

ReflectionProperty::getDeclaringClass()

Implementation of

TokenReflection\IReflectionProperty::getDeclaringClass()
public string
# getDeclaringClassName( )

Returns the declaring class name.

Returns the declaring class name.

Returns

string

Implementation of

TokenReflection\IReflectionProperty::getDeclaringClassName()
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\IReflectionProperty::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\IReflectionProperty::getEndLine()
public boolean
# getDocComment( )

Returns the appropriate docblock definition.

Returns the appropriate docblock definition.

Returns

boolean

Overrides

ReflectionProperty::getDocComment()

Implementation of

TokenReflection\IReflectionProperty::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 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 mixed
# getDefaultValue( )

Returns the property default value.

Returns the property default value.

Returns

mixed

Implementation of

TokenReflection\IReflectionProperty::getDefaultValue()
public string
# getDefaultValueDefinition( )

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

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

Returns

string

Implementation of

TokenReflection\IReflectionProperty::getDefaultValueDefinition()
public boolean
# isInternal( )

Returns if the property is internal.

Returns if the property is internal.

Returns

boolean

Implementation of

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

Returns if the property is user defined.

Returns if the property 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

Implementation of

TokenReflection\IReflectionProperty::isDeprecated()
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 array
# getNamespaceAliases( )

Returns imported namespaces and aliases from the declaring namespace.

Returns imported namespaces and aliases from the declaring namespace.

Returns

array
public TokenReflection\IReflectionClass|null
# getDeclaringTrait( )

Returns the defining trait.

Returns the defining trait.

Returns

TokenReflection\IReflectionClass|null

Implementation of

TokenReflection\IReflectionProperty::getDeclaringTrait()
public string|null
# getDeclaringTraitName( )

Returns the declaring trait name.

Returns the declaring trait name.

Returns

string|null

Implementation of

TokenReflection\IReflectionProperty::getDeclaringTraitName()
public boolean
# isAccessible( )

Returns if the property is set accessible.

Returns if the property is set accessible.

Returns

boolean

Implementation of

TokenReflection\IReflectionProperty::isAccessible()
public
# setAccessible( boolean $accessible )

Sets a property to be accessible or not.

Sets a property to be accessible or not.

Parameters

$accessible
boolean
$accessible If the property should be accessible.

Overrides

ReflectionProperty::setAccessible()

Implementation of

TokenReflection\IReflectionProperty::setAccessible()
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 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 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\ReflectionProperty
# 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\ReflectionProperty

Throws

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

Implementation of

TokenReflection\Php\IReflection::create()
Methods inherited from ReflectionProperty
__toString(), export(), getModifiers(), getName(), getValue(), isDefault(), isPrivate(), isProtected(), isPublic(), isStatic(), setValue()
Constants inherited from ReflectionProperty
IS_PRIVATE, IS_PROTECTED, IS_PUBLIC, IS_STATIC
Properties inherited from ReflectionProperty
$class, $name
PHP Token Reflection API documentation generated by ApiGen 2.8.0