Overview

Namespaces

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

Classes

  • Broker
  • ReflectionAnnotation
  • ReflectionBase
  • ReflectionClass
  • ReflectionConstant
  • ReflectionElement
  • ReflectionFile
  • ReflectionFileNamespace
  • ReflectionFunction
  • ReflectionFunctionBase
  • ReflectionMethod
  • ReflectionNamespace
  • ReflectionParameter
  • ReflectionProperty
  • Resolver

Interfaces

  • IReflection
  • IReflectionClass
  • IReflectionConstant
  • IReflectionExtension
  • IReflectionFunction
  • IReflectionFunctionBase
  • IReflectionMethod
  • IReflectionNamespace
  • IReflectionParameter
  • IReflectionProperty
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class ReflectionBase

Basic abstract TokenReflection class.

A common ancestor of ReflectionElement and ReflectionFile.

TokenReflection\ReflectionBase implements TokenReflection\IReflection

Direct known subclasses

TokenReflection\ReflectionElement, TokenReflection\ReflectionFile

Indirect known subclasses

TokenReflection\ReflectionClass, TokenReflection\ReflectionConstant, TokenReflection\ReflectionFileNamespace, TokenReflection\ReflectionFunction, TokenReflection\ReflectionFunctionBase, TokenReflection\ReflectionMethod, TokenReflection\ReflectionParameter, TokenReflection\ReflectionProperty
Abstract
Namespace: TokenReflection
Located at ReflectionBase.php
Methods summary
public
# __construct( TokenReflection\Stream\StreamBase $tokenStream, TokenReflection\Broker $broker, TokenReflection\IReflection $parent = null )

Constructor.

Constructor.

Parameters

$tokenStream
TokenReflection\Stream\StreamBase
$tokenStream Token substream
$broker
TokenReflection\Broker
$broker Reflection broker
$parent
TokenReflection\IReflection
$parent Parent reflection object
abstract protected
# parseStream( TokenReflection\Stream\StreamBase $tokenStream, TokenReflection\IReflection $parent = null )

Parses the token substream.

Parses the token substream.

Parameters

$tokenStream
TokenReflection\Stream\StreamBase
$tokenStream Token substream
$parent
TokenReflection\IReflection
$parent Parent reflection object
public string
# getName( )

Returns the name (FQN).

Returns the name (FQN).

Returns

string

Implementation of

TokenReflection\IReflection::getName()
public string|boolean
# getDocComment( )

Returns the appropriate docblock definition.

Returns the appropriate docblock definition.

Returns

string|boolean
final 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
final 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
final public array
# getAnnotations( )

Returns all annotations.

Returns all annotations.

Returns

array
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
# isInternal( )

Returns if the reflection object is internal.

Returns if the reflection object is internal.

Always returns false - everything is user defined.

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.

Always returns true - everything 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
abstract public string
# getSource( )

Returns the appropriate source code part.

Returns the appropriate source code part.

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()
final public static mixed
# get( TokenReflection\IReflection $object, string $key )

Magic __get method helper.

Magic __get method helper.

Parameters

$object
TokenReflection\IReflection
$object Reflection object
$key
string
$key Variable name

Returns

mixed

Throws

TokenReflection\Exception\RuntimeException
If the requested parameter does not exist.
final public static boolean
# exists( TokenReflection\IReflection $object, string $key )

Magic __isset method helper.

Magic __isset method helper.

Parameters

$object
TokenReflection\IReflection
$object Reflection object
$key
string
$key Variable name

Returns

boolean
Properties summary
protected string $name
#

Object name (FQN).

Object name (FQN).

protected TokenReflection\ReflectionAnnotation|boolean $docComment
#

Docblock definition.

Docblock definition.

PHP Token Reflection API documentation generated by ApiGen 2.8.0