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

Interface IReflectionClass

Common reflection classes interface.

TokenReflection\IReflectionClass implements TokenReflection\IReflection

Direct known implementers

TokenReflection\Dummy\ReflectionClass, TokenReflection\Invalid\ReflectionClass, TokenReflection\Php\ReflectionClass, TokenReflection\ReflectionClass
Namespace: TokenReflection
Located at IReflectionClass.php
Methods summary
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
public boolean
# inNamespace( )

Returns if the class is defined within a namespace.

Returns if the class is defined within a namespace.

Returns

boolean
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\IReflectionExtension|null
# getExtension( )

Returns the PHP extension reflection.

Returns the PHP extension reflection.

Returns

TokenReflection\IReflectionExtension|null
public string|null
# getExtensionName( )

Returns the PHP extension name.

Returns the PHP extension name.

Returns

string|null
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 integer
# getStartLine( )

Returns the definition start line number in the file.

Returns the definition start line number in the file.

Returns

integer
public integer
# getEndLine( )

Returns the definition end line number in the file.

Returns the definition end line number in the file.

Returns

integer
public string|boolean
# getDocComment( )

Returns the appropriate docblock definition.

Returns the appropriate docblock definition.

Returns

string|boolean
public array
# getModifiers( )

Returns modifiers.

Returns modifiers.

Returns

array
public boolean
# isAbstract( )

Returns if the class is abstract.

Returns if the class is abstract.

Returns

boolean
public boolean
# isFinal( )

Returns if the class is final.

Returns if the class is final.

Returns

boolean
public boolean
# isInterface( )

Returns if the class is an interface.

Returns if the class is an interface.

Returns

boolean
public boolean
# isException( )

Returns if the class is an exception or its descendant.

Returns if the class is an exception or its descendant.

Returns

boolean
public boolean
# isCloneable( )

Returns if objects of this class are cloneable.

Returns if objects of this class are cloneable.

Introduced in PHP 5.4.

Returns

boolean

See

http://svn.php.net/viewvc/php/php-src/trunk/ext/reflection/php_reflection.c?revision=307971&view=markup#l4059
public boolean
# isIterateable( )

Returns if the class is iterateable.

Returns if the class is iterateable.

Returns true if the class implements the Traversable interface.

Returns

boolean
public boolean
# isSubclassOf( string|object $class )

Returns if the current class is a subclass of the given class.

Returns if the current class is a subclass of the given class.

Parameters

$class
string|object
$class Class name or reflection object

Returns

boolean
public TokenReflection\IReflectionClass|null
# getParentClass( )

Returns the parent class reflection.

Returns the parent class reflection.

Returns

TokenReflection\IReflectionClass|null
public string|null
# getParentClassName( )

Returns the parent class name.

Returns the parent class name.

Returns

string|null
public array
# getParentClasses( )

Returns the parent classes reflections.

Returns the parent classes reflections.

Returns

array
public array
# getParentClassNameList( )

Returns the parent classes names.

Returns the parent classes names.

Returns

array
public boolean
# implementsInterface( string|object $interface )

Returns if the class implements the given interface.

Returns if the class implements the given interface.

Parameters

$interface
string|object
$interface Interface name or reflection object

Returns

boolean

Throws

TokenReflection\Exception\RuntimeException
If an invalid object was provided as interface.
public array
# getInterfaces( )

Returns interface reflections.

Returns interface reflections.

Returns

array
public array
# getInterfaceNames( )

Returns interface names.

Returns interface names.

Returns

array
public array
# getOwnInterfaces( )

Returns interface reflections implemented by this class, not its parents.

Returns interface reflections implemented by this class, not its parents.

Returns

array
public array
# getOwnInterfaceNames( )

Returns names of interfaces implemented by this class, not its parents.

Returns names of interfaces implemented by this class, not its parents.

Returns

array
public TokenReflection\IReflectionMethod|null
# getConstructor( )

Returns the class constructor reflection.

Returns the class constructor reflection.

Returns

TokenReflection\IReflectionMethod|null
public TokenReflection\IReflectionMethod|null
# getDestructor( )

Returns the class desctructor reflection.

Returns the class desctructor reflection.

Returns

TokenReflection\IReflectionMethod|null
public boolean
# hasMethod( string $name )

Returns if the class implements the given method.

Returns if the class implements the given method.

Parameters

$name
string
$name Method name

Returns

boolean
public TokenReflection\IReflectionMethod
# getMethod( string $name )

Returns a method reflection.

Returns a method reflection.

Parameters

$name
string
$name Method name

Returns

TokenReflection\IReflectionMethod

Throws

TokenReflection\Exception\RuntimeException
If the requested method does not exist.
public array
# getMethods( integer $filter = null )

Returns method reflections.

Returns method reflections.

Parameters

$filter
integer
$filter Methods filter

Returns

array
public boolean
# hasOwnMethod( string $name )

Returns if the class implements (and not its parents) the given method.

Returns if the class implements (and not its parents) the given method.

Parameters

$name
string
$name Method name

Returns

boolean
public array
# getOwnMethods( integer $filter = null )

Returns method reflections declared by this class, not its parents.

Returns method reflections declared by this class, not its parents.

Parameters

$filter
integer
$filter Methods filter

Returns

array
public boolean
# hasTraitMethod( string $name )

Returns if the class imports the given method from traits.

Returns if the class imports the given method from traits.

Parameters

$name
string
$name Method name

Returns

boolean
public array
# getTraitMethods( integer $filter = null )

Returns method reflections imported from traits.

Returns method reflections imported from traits.

Parameters

$filter
integer
$filter Methods filter

Returns

array
public boolean
# hasConstant( string $name )

Returns if the class defines the given constant.

Returns if the class defines the given constant.

Parameters

$name
string
$name Constant name.

Returns

boolean
public mixed
# getConstant( string $name )

Returns a constant value.

Returns a constant value.

Parameters

$name
string
$name Constant name

Returns

mixed

Throws

TokenReflection\Exception\RuntimeException
If the requested constant does not exist.
public TokenReflection\IReflectionConstant
# getConstantReflection( string $name )

Returns a constant reflection.

Returns a constant reflection.

Parameters

$name
string
$name Constant name

Returns

TokenReflection\IReflectionConstant

Throws

TokenReflection\Exception\RuntimeException
If the requested constant does not exist.
public array
# getConstants( )

Returns an array of constant values.

Returns an array of constant values.

Returns

array
public array
# getConstantReflections( )

Returns constant reflections.

Returns constant reflections.

Returns

array
public boolean
# hasOwnConstant( string $name )

Returns if the class (and not its parents) defines the given constant.

Returns if the class (and not its parents) defines the given constant.

Parameters

$name
string
$name Constant name.

Returns

boolean
public array
# getOwnConstants( )

Returns values of constants declared by this class, not by its parents.

Returns values of constants declared by this class, not by its parents.

Returns

array
public array
# getOwnConstantReflections( )

Returns constant reflections declared by this class, not by its parents.

Returns constant reflections declared by this class, not by its parents.

Returns

array
public boolean
# hasProperty( string $name )

Returns if the class defines the given property.

Returns if the class defines the given property.

Parameters

$name
string
$name Property name

Returns

boolean
public TokenReflection\ReflectionProperty
# getProperty( string $name )

Return a property reflection.

Return a property reflection.

Parameters

$name
string
$name Property name

Returns

TokenReflection\ReflectionProperty

Throws

TokenReflection\Exception\RuntimeException
If the requested property does not exist.
public array
# getProperties( integer $filter = null )

Returns property reflections.

Returns property reflections.

Parameters

$filter
integer
$filter Properties filter

Returns

array
public boolean
# hasOwnProperty( string $name )

Returns if the class (and not its parents) defines the given property.

Returns if the class (and not its parents) defines the given property.

Parameters

$name
string
$name Property name

Returns

boolean
public array
# getOwnProperties( integer $filter = null )

Returns property reflections declared by this class, not its parents.

Returns property reflections declared by this class, not its parents.

Parameters

$filter
integer
$filter Properties filter

Returns

array
public boolean
# hasTraitProperty( string $name )

Returns if the class imports the given property from traits.

Returns if the class imports the given property from traits.

Parameters

$name
string
$name Property name

Returns

boolean
public array
# getTraitProperties( integer $filter = null )

Returns property reflections imported from traits.

Returns property reflections imported from traits.

Parameters

$filter
integer
$filter Properties filter

Returns

array
public array
# getDefaultProperties( )

Returns default properties.

Returns default properties.

Returns

array
public array
# getStaticProperties( )

Returns static properties reflections.

Returns static properties reflections.

Returns

array
public mixed
# getStaticPropertyValue( string $name, mixed $default = null )

Returns a value of a static property.

Returns a value of a static property.

Parameters

$name
string
$name Property name
$default
mixed
$default Default value

Returns

mixed

Throws

TokenReflection\Exception\RuntimeException
If the requested static property does not exist.
TokenReflection\Exception\RuntimeException
If the requested static property is not accessible.
public array
# getDirectSubclasses( )

Returns reflections of direct subclasses.

Returns reflections of direct subclasses.

Returns

array
public array
# getDirectSubclassNames( )

Returns names of direct subclasses.

Returns names of direct subclasses.

Returns

array
public array
# getIndirectSubclasses( )

Returns reflections of indirect subclasses.

Returns reflections of indirect subclasses.

Returns

array
public array
# getIndirectSubclassNames( )

Returns names of indirect subclasses.

Returns names of indirect subclasses.

Returns

array
public array
# getDirectImplementers( )

Returns reflections of classes directly implementing this interface.

Returns reflections of classes directly implementing this interface.

Returns

array
public array
# getDirectImplementerNames( )

Returns names of classes directly implementing this interface.

Returns names of classes directly implementing this interface.

Returns

array
public array
# getIndirectImplementers( )

Returns reflections of classes indirectly implementing this interface.

Returns reflections of classes indirectly implementing this interface.

Returns

array
public array
# getIndirectImplementerNames( )

Returns names of classes indirectly implementing this interface.

Returns names of classes indirectly implementing this interface.

Returns

array
public boolean
# isInstantiable( )

Returns if it is possible to create an instance of this class.

Returns if it is possible to create an instance of this class.

Returns

boolean
public array
# getTraits( )

Returns traits used by this class.

Returns traits used by this class.

Returns

array
public array
# getOwnTraits( )

Returns traits used by this class and not its parents.

Returns traits used by this class and not its parents.

Returns

array
public array
# getTraitNames( )

Returns names of used traits.

Returns names of used traits.

Returns

array
public array
# getOwnTraitNames( )

Returns names of traits used by this class an not its parents.

Returns names of traits used by this class an not its parents.

Returns

array
public array
# getTraitAliases( )

Returns method aliases from traits.

Returns method aliases from traits.

Returns

array
public boolean
# usesTrait( ReflectionClass|TokenReflection\IReflectionClass|string $trait )

Returns if the class uses a particular trait.

Returns if the class uses a particular trait.

Parameters

$trait
ReflectionClass|TokenReflection\IReflectionClass|string
$trait Trait reflection or name

Returns

boolean
public boolean
# isTrait( )

Returns if the class is a trait.

Returns if the class is a trait.

Returns

boolean
public boolean
# isInstance( object $object )

Returns if the given object is an instance of this class.

Returns if the given object is an instance of this class.

Parameters

$object
object
$object Instance

Returns

boolean

Throws

TokenReflection\Exception\RuntimeException
If the provided argument is not an object.
public object
# newInstanceWithoutConstructor( )

Creates a new class instance without using a constructor.

Creates a new class instance without using a constructor.

Returns

object

Throws

TokenReflection\Exception\RuntimeException
If the class inherits from an internal class.
public object
# newInstance( mixed $args )

Creates a new instance using variable number of parameters.

Creates a new instance using variable number of parameters.

Use any number of constructor parameters as function parameters.

Parameters

$args
mixed
$args

Returns

object
public object
# newInstanceArgs( array $args = array() )

Creates a new instance using an array of parameters.

Creates a new instance using an array of parameters.

Parameters

$args
array
$args Array of constructor parameters

Returns

object

Throws

TokenReflection\Exception\RuntimeException
If the required class does not exist.
public
# setStaticPropertyValue( string $name, mixed $value )

Sets a static property value.

Sets a static property value.

Parameters

$name
string
$name Property name
$value
mixed
$value Property value

Throws

TokenReflection\Exception\RuntimeException
If the requested static property does not exist.
TokenReflection\Exception\RuntimeException
If the requested static property is not accessible.
public string
# __toString( )

Returns the string representation of the reflection object.

Returns the string representation of the reflection object.

Returns

string
public boolean
# isComplete( )

Returns if the class definition is complete.

Returns if the class definition is complete.

That means if there are no dummy classes among parents and implemented interfaces.

Returns

boolean
public boolean
# isValid( )

Returns if the class definition is valid.

Returns if the class definition is valid.

That means that the source code is valid and the class name is unique within parsed files.

Returns

boolean
public boolean
# isDeprecated( )

Returns if the class is deprecated.

Returns if the class is deprecated.

Returns

boolean
Methods inherited from TokenReflection\IReflection
__get(), __isset(), getBroker(), getName(), getPrettyName(), isInternal(), isTokenized(), isUserDefined()
PHP Token Reflection API documentation generated by ApiGen 2.8.0