Book/reflection-Phpdoc专题

反射

简介
安装／配置
- 需求
- 安装
- 运行时配置
- 资源类型
预定义常量
范例
扩展
Reflection — Reflection 类
- Reflection::export — Exports
- Reflection::getModifierNames — 获取修饰符的名称
ReflectionClass — ReflectionClass 类
- ReflectionClass::__construct — 初始化 ReflectionClass 类
- ReflectionClass::export — 导出一个类
- ReflectionClass::getConstant — 获取定义过的一个常量
- ReflectionClass::getConstants — 获取一组常量
- ReflectionClass::getConstructor — 获取类的构造函数
- ReflectionClass::getDefaultProperties — 获取默认属性
- ReflectionClass::getDocComment — 获取文档注释
- ReflectionClass::getEndLine — 获取最后一行的行数
- ReflectionClass::getExtension — 根据已定义的类获取所在扩展的 ReflectionExtension 对象
- ReflectionClass::getExtensionName — 获取定义的类所在的扩展的名称
- ReflectionClass::getFileName — 获取定义类的文件名
- ReflectionClass::getInterfaceNames — 获取接口（interface）名称
- ReflectionClass::getInterfaces — 获取接口
- ReflectionClass::getMethod — 获取一个类方法的 ReflectionMethod。
- ReflectionClass::getMethods — 获取方法的数组
- ReflectionClass::getModifiers — 获取类的修饰符
- ReflectionClass::getName — 获取类名
- ReflectionClass::getNamespaceName — 获取命名空间的名称
- ReflectionClass::getParentClass — 获取父类
- ReflectionClass::getProperties — 获取一组属性
- ReflectionClass::getProperty — 获取类的一个属性的 ReflectionProperty
- ReflectionClass::getReflectionConstant — Gets a ReflectionClassConstant for a class's constant
- ReflectionClass::getReflectionConstants — Gets class constants
- ReflectionClass::getShortName — 获取短名
- ReflectionClass::getStartLine — 获取起始行号
- ReflectionClass::getStaticProperties — 获取静态（static）属性
- ReflectionClass::getStaticPropertyValue — 获取静态（static）属性的值
- ReflectionClass::getTraitAliases — 返回 trait 别名的一个数组
- ReflectionClass::getTraitNames — 返回这个类所使用 traits 的名称的数组
- ReflectionClass::getTraits — 返回这个类所使用的 traits 数组
- ReflectionClass::hasConstant — 检查常量是否已经定义
- ReflectionClass::hasMethod — 检查方法是否已定义
- ReflectionClass::hasProperty — 检查属性是否已定义
- ReflectionClass::implementsInterface — 接口的实现
- ReflectionClass::inNamespace — 检查是否位于命名空间中
- ReflectionClass::isAbstract — 检查类是否是抽象类（abstract）
- ReflectionClass::isAnonymous — 检查类是否是匿名类
- ReflectionClass::isCloneable — 返回了一个类是否可复制
- ReflectionClass::isFinal — 检查类是否声明为 final
- ReflectionClass::isInstance — 检查类的实例
- ReflectionClass::isInstantiable — 检查类是否可实例化
- ReflectionClass::isInterface — 检查类是否是一个接口（interface）
- ReflectionClass::isInternal — 检查类是否由扩展或核心在内部定义
- ReflectionClass::isIterable — Check whether this class is iterable
- ReflectionClass::isIterateable — 检查是否可迭代（iterateable）
- ReflectionClass::isSubclassOf — 检查是否为一个子类
- ReflectionClass::isTrait — 返回了是否为一个 trait
- ReflectionClass::isUserDefined — 检查是否由用户定义的
- ReflectionClass::newInstance — 从指定的参数创建一个新的类实例
- ReflectionClass::newInstanceArgs — 从给出的参数创建一个新的类实例。
- ReflectionClass::newInstanceWithoutConstructor — 创建一个新的类实例而不调用它的构造函数
- ReflectionClass::setStaticPropertyValue — 设置静态属性的值
- ReflectionClass::__toString — 返回 ReflectionClass 对象字符串的表示形式。
ReflectionClassConstant — The ReflectionClassConstant class
- ReflectionClassConstant::__construct — Constructs a ReflectionClassConstant
- ReflectionClassConstant::export — Export
- ReflectionClassConstant::getDeclaringClass — Gets declaring class
- ReflectionClassConstant::getDocComment — Gets doc comments
- ReflectionClassConstant::getModifiers — Gets the class constant modifiers
- ReflectionClassConstant::getName — Get name of the constant
- ReflectionClassConstant::getValue — Gets value
- ReflectionClassConstant::isPrivate — Checks if class constant is private
- ReflectionClassConstant::isProtected — Checks if class constant is protected
- ReflectionClassConstant::isPublic — Checks if class constant is public
- ReflectionClassConstant::__toString — Returns the string representation of the ReflectionClassConstant object
ReflectionZendExtension — ReflectionZendExtension 类
- ReflectionZendExtension::__clone — Clone handler
- ReflectionZendExtension::__construct — Constructor
- ReflectionZendExtension::export — Export
- ReflectionZendExtension::getAuthor — Gets author
- ReflectionZendExtension::getCopyright — Gets copyright
- ReflectionZendExtension::getName — Gets name
- ReflectionZendExtension::getURL — Gets URL
- ReflectionZendExtension::getVersion — Gets version
- ReflectionZendExtension::__toString — To string handler
ReflectionExtension — ReflectionExtension 类
- ReflectionExtension::__clone — Clones
- ReflectionExtension::__construct — Constructs a ReflectionExtension
- ReflectionExtension::export — Export
- ReflectionExtension::getClasses — Gets classes
- ReflectionExtension::getClassNames — 获取类名称
- ReflectionExtension::getConstants — 获取常量
- ReflectionExtension::getDependencies — 获取依赖
- ReflectionExtension::getFunctions — 获取扩展中的函数
- ReflectionExtension::getINIEntries — 获取ini配置
- ReflectionExtension::getName — 获取扩展名称
- ReflectionExtension::getVersion — 获取扩展版本号
- ReflectionExtension::info — 输出扩展信息
- ReflectionExtension::isPersistent — 返回扩展是否持久化载入
- ReflectionExtension::isTemporary — 返回扩展是否是临时载入
- ReflectionExtension::__toString — To string
ReflectionFunction — ReflectionFunction 类
- ReflectionFunction::__construct — Constructs a ReflectionFunction object
- ReflectionFunction::export — Exports function
- ReflectionFunction::getClosure — Returns a dynamically created closure for the function
- ReflectionFunction::invoke — Invokes function
- ReflectionFunction::invokeArgs — Invokes function args
- ReflectionFunction::isDisabled — Checks if function is disabled
- ReflectionFunction::__toString — To string
ReflectionFunctionAbstract — ReflectionFunctionAbstract 类
- ReflectionFunctionAbstract::__clone — 复制函数
- ReflectionFunctionAbstract::getClosureScopeClass — Returns the scope associated to the closure
- ReflectionFunctionAbstract::getClosureThis — 返回本身的匿名函数
- ReflectionFunctionAbstract::getDocComment — 获取注释内容
- ReflectionFunctionAbstract::getEndLine — 获取结束行号
- ReflectionFunctionAbstract::getExtension — 获取扩展信息
- ReflectionFunctionAbstract::getExtensionName — 获取扩展名称
- ReflectionFunctionAbstract::getFileName — 获取文件名称
- ReflectionFunctionAbstract::getName — 获取函数名称
- ReflectionFunctionAbstract::getNamespaceName — 获取命名空间
- ReflectionFunctionAbstract::getNumberOfParameters — 获取参数数目
- ReflectionFunctionAbstract::getNumberOfRequiredParameters — 获取必须输入参数个数
- ReflectionFunctionAbstract::getParameters — 获取参数
- ReflectionFunctionAbstract::getReturnType — Gets the specified return type of a function
- ReflectionFunctionAbstract::getShortName — 获取函数短名称
- ReflectionFunctionAbstract::getStartLine — 获取开始行号
- ReflectionFunctionAbstract::getStaticVariables — 获取静态变量
- ReflectionFunctionAbstract::hasReturnType — Checks if the function has a specified return type
- ReflectionFunctionAbstract::inNamespace — 检查是否处于命名空间
- ReflectionFunctionAbstract::isClosure — 检查是否是匿名函数
- ReflectionFunctionAbstract::isDeprecated — 检查是否已经弃用
- ReflectionFunctionAbstract::isGenerator — 判断函数是否是一个生成器函数
- ReflectionFunctionAbstract::isInternal — 判断函数是否是内置函数
- ReflectionFunctionAbstract::isUserDefined — 检查是否是用户定义
- ReflectionFunctionAbstract::isVariadic — Checks if the function is variadic
- ReflectionFunctionAbstract::returnsReference — 检查是否返回参考信息
- ReflectionFunctionAbstract::__toString — 字符串化
ReflectionMethod — ReflectionMethod 类
- ReflectionMethod::__construct — ReflectionMethod 的构造函数
- ReflectionMethod::export — 输出一个回调方法
- ReflectionMethod::getClosure — 返回一个动态建立的方法调用接口，译者注：可以使用这个返回值直接调用非公开方法。
- ReflectionMethod::getDeclaringClass — 获取被反射的方法所在类的反射实例
- ReflectionMethod::getModifiers — 获取方法的修饰符
- ReflectionMethod::getPrototype — 返回方法原型 (如果存在)
- ReflectionMethod::invoke — Invoke
- ReflectionMethod::invokeArgs — 带参数执行
- ReflectionMethod::isAbstract — 判断方法是否是抽象方法
- ReflectionMethod::isConstructor — 判断方法是否是构造方法
- ReflectionMethod::isDestructor — 判断方法是否是析构方法
- ReflectionMethod::isFinal — 判断方法是否定义 final
- ReflectionMethod::isPrivate — 判断方法是否是私有方法
- ReflectionMethod::isProtected — 判断方法是否是保护方法 (protected)
- ReflectionMethod::isPublic — 判断方法是否是公开方法
- ReflectionMethod::isStatic — 判断方法是否是静态方法
- ReflectionMethod::setAccessible — 设置方法是否访问
- ReflectionMethod::__toString — 返回反射方法对象的字符串表达
ReflectionObject — ReflectionObject 类
- ReflectionObject::__construct — Constructs a ReflectionObject
- ReflectionObject::export — Export
ReflectionParameter — ReflectionParameter 类
- ReflectionParameter::allowsNull — Checks if null is allowed
- ReflectionParameter::canBePassedByValue — Returns whether this parameter can be passed by value
- ReflectionParameter::__clone — Clone
- ReflectionParameter::__construct — Construct
- ReflectionParameter::export — Exports
- ReflectionParameter::getClass — 获得类型提示类。
- ReflectionParameter::getDeclaringClass — Gets declaring class
- ReflectionParameter::getDeclaringFunction — Gets declaring function
- ReflectionParameter::getDefaultValue — Gets default parameter value
- ReflectionParameter::getDefaultValueConstantName — Returns the default value's constant name if default value is constant or null
- ReflectionParameter::getName — Gets parameter name
- ReflectionParameter::getPosition — Gets parameter position
- ReflectionParameter::getType — Gets a parameter's type
- ReflectionParameter::hasType — Checks if parameter has a type
- ReflectionParameter::isArray — Checks if parameter expects an array
- ReflectionParameter::isCallable — Returns whether parameter MUST be callable
- ReflectionParameter::isDefaultValueAvailable — 检查是否有默认值。
- ReflectionParameter::isDefaultValueConstant — Returns whether the default value of this parameter is a constant
- ReflectionParameter::isOptional — Checks if optional
- ReflectionParameter::isPassedByReference — Checks if passed by reference
- ReflectionParameter::isVariadic — Checks if the parameter is variadic
- ReflectionParameter::__toString — To string
ReflectionProperty — ReflectionProperty 类
- ReflectionProperty::__clone — Clone
- ReflectionProperty::__construct — Construct a ReflectionProperty object
- ReflectionProperty::export — Export
- ReflectionProperty::getDeclaringClass — Gets declaring class
- ReflectionProperty::getDefaultValue — Returns the default value declared for a property
- ReflectionProperty::getDocComment — Gets the property doc comment
- ReflectionProperty::getModifiers — Gets the property modifiers
- ReflectionProperty::getName — Gets property name
- ReflectionProperty::getType — Gets a property's type
- ReflectionProperty::getValue — Gets value
- ReflectionProperty::hasDefaultValue — Checks if property has a default value declared
- ReflectionProperty::hasType — Checks if property has a type
- ReflectionProperty::isDefault — Checks if property is a default property
- ReflectionProperty::isInitialized — Checks whether a property is initialized
- ReflectionProperty::isPrivate — Checks if property is private
- ReflectionProperty::isProtected — Checks if property is protected
- ReflectionProperty::isPublic — Checks if property is public
- ReflectionProperty::isStatic — Checks if property is static
- ReflectionProperty::setAccessible — Set property accessibility
- ReflectionProperty::setValue — Set property value
- ReflectionProperty::__toString — To string
ReflectionType — The ReflectionType class
- ReflectionType::allowsNull — Checks if null is allowed
- ReflectionType::__toString — To string
ReflectionGenerator — 生成器反射类
- ReflectionGenerator::__construct — Constructs a ReflectionGenerator object
- ReflectionGenerator::getExecutingFile — Gets the file name of the currently executing generator
- ReflectionGenerator::getExecutingGenerator — Gets the executing Generator object
- ReflectionGenerator::getExecutingLine — Gets the currently executing line of the generator
- ReflectionGenerator::getFunction — Gets the function name of the generator
- ReflectionGenerator::getThis — Gets the $this value of the generator
- ReflectionGenerator::getTrace — Gets the trace of the executing generator
Reflector — Reflector 接口
- Reflector::export — Exports
- Reflector::__toString — 转化成字符串
ReflectionException — ReflectionException 类

简介

反射（reflection）类。

类摘要

Reflection

class Reflection {

/* 方法 */

public static string export ( Reflector $reflector [, bool $return = false ] )

public static array getModifierNames ( int $modifiers )

}

Reflection::export

Exports

说明

public static string Reflection::export ( Reflector $reflector [, bool $return = false ] )

导出一个反射（reflection）。

Warning

本函数还未编写文档，仅有参数列表。

参数

reflector
导出的反射。

return
设为 true 时返回导出结果，设为 false（默认值）则忽略返回。

返回值

如果参数 return 设为 true，导出结果将作为 string 返回，否则返回 null。

参见

Reflection::getModifierNames

Reflection::getModifierNames

获取修饰符的名称

说明

public static array Reflection::getModifierNames ( int $modifiers )

获取修饰符的名称。

参数

modifiers
根据标志位域获取修饰符。

返回值

修饰符名称的一个数组。

范例

示例 #1 Reflection::getModifierNames 例子

<?php
class Testing
{
    final public static function foo()
    {
        return;
    }

    public function bar()
    {
        return;
    }
}

$foo = new ReflectionMethod('Testing', 'foo');

echo "Modifiers for method foo():\n";
echo $foo->getModifiers() . "\n";
echo implode(' ', Reflection::getModifierNames($foo->getModifiers())) . "\n";

$bar = new ReflectionMethod('Testing', 'bar');

echo "Modifiers for method bar():\n";
echo $bar->getModifiers() . "\n";
echo implode(' ', Reflection::getModifierNames($bar->getModifiers()));

以上例程的输出类似于：

Modifiers for method foo():
261
final public static
Modifiers for method bar():
65792
public

参见

ReflectionClass::getModifiers
ReflectionClassConstant::getModifiers
ReflectionMethod::getModifiers
ReflectionProperty::getModifiers

简介

ReflectionClass 类报告了一个类的有关信息。

类摘要

ReflectionClass

class ReflectionClass implements Reflector {

/* 常量 */

const integer ReflectionClass::IS_IMPLICIT_ABSTRACT = 16 ;

const integer ReflectionClass::IS_EXPLICIT_ABSTRACT = 32 ;

const integer ReflectionClass::IS_FINAL = 64 ;

/* 属性 */

public $name ;

/* 方法 */

public __construct ( mixed $argument )

public static string export ( mixed $argument [, bool $return = false ] )

public mixed getConstant ( string $name )

public array getConstants ( void )

public ReflectionMethod getConstructor ( void )

public array getDefaultProperties ( void )

public string getDocComment ( void )

public int getEndLine ( void )

public ReflectionExtension getExtension ( void )

public string getExtensionName ( void )

public string getFileName ( void )

public array getInterfaceNames ( void )

public array getInterfaces ( void )

public ReflectionMethod getMethod ( string $name )

public array getMethods ([ int $filter ] )

public int getModifiers ( void )

public string getName ( void )

public string getNamespaceName ( void )

public ReflectionClass getParentClass ( void )

public array getProperties ([ int $filter ] )

public ReflectionProperty getProperty ( string $name )

public ReflectionClassConstantfalse getReflectionConstant ( string $name )

public array getReflectionConstants ( void )

public string getShortName ( void )

public int getStartLine ( void )

public array getStaticProperties ( void )

public mixed getStaticPropertyValue ( string $name [, mixed &$def_value ] )

public array getTraitAliases ( void )

public array getTraitNames ( void )

public array getTraits ( void )

public bool hasConstant ( string $name )

public bool hasMethod ( string $name )

public bool hasProperty ( string $name )

public bool implementsInterface ( string $interface )

public bool inNamespace ( void )

public bool isAbstract ( void )

public bool isAnonymous ( void )

public bool isCloneable ( void )

public bool isFinal ( void )

public bool isInstance ( object $object )

public bool isInstantiable ( void )

public bool isInterface ( void )

public bool isInternal ( void )

public bool isIterable ( void )

public bool isIterateable ( void )

public bool isSubclassOf ( string $class )

public bool isTrait ( void )

public bool isUserDefined ( void )

public object newInstance ( mixed $args [, mixed $... ] )

public object newInstanceArgs ([ array $args ] )

public object newInstanceWithoutConstructor ( void )

public void setStaticPropertyValue ( string $name , string $value )

public string __toString ( void )

}

属性

name
类的名称。只读，并在尝试赋值的时候会抛出 ReflectionException。

预定义常量

ReflectionClass 修饰符

ReflectionClass::IS_IMPLICIT_ABSTRACT
指示了类是一个抽象类（abstract），因为它有抽象（abstract）方法。

ReflectionClass::IS_EXPLICIT_ABSTRACT
指示了类是一个抽象类（abstract），因为它已明确定义。

ReflectionClass::IS_FINAL
指示这是一个 final 类。

ReflectionClass::__construct

初始化 ReflectionClass 类

说明

public ReflectionClass::__construct ( mixed $argument )

初始化新的 ReflectionClass 对象。

参数

argument
既可以是包含类名的字符串（string）也可以是对象（object）。

返回值

返回初始化完成后的 ReflectionClass 实例。

错误／异常

如果要反射的 Class 不存在，抛出异常 ReflectionException。

范例

示例 #1 ReflectionClass 的基本用法

<?php
Reflection::export(new ReflectionClass('Exception'));
?>

以上例程的输出类似于：

Class [ <internal:Core> class Exception ] {

  - Constants [0] {
  }

  - Static properties [0] {
  }

  - Static methods [0] {
  }

  - Properties [7] {
    Property [ <default> protected $message ]
    Property [ <default> private $string ]
    Property [ <default> protected $code ]
    Property [ <default> protected $file ]
    Property [ <default> protected $line ]
    Property [ <default> private $trace ]
    Property [ <default> private $previous ]
  }

  - Methods [10] {
    Method [ <internal:Core> final private method __clone ] {
    }

    Method [ <internal:Core, ctor> public method __construct ] {

      - Parameters [3] {
        Parameter #0 [ <optional> $message ]
        Parameter #1 [ <optional> $code ]
        Parameter #2 [ <optional> $previous ]
      }
    }

    Method [ <internal:Core> final public method getMessage ] {
    }

    Method [ <internal:Core> final public method getCode ] {
    }

    Method [ <internal:Core> final public method getFile ] {
    }

    Method [ <internal:Core> final public method getLine ] {
    }

    Method [ <internal:Core> final public method getTrace ] {
    }

    Method [ <internal:Core> final public method getPrevious ] {
    }

    Method [ <internal:Core> final public method getTraceAsString ] {
    }

    Method [ <internal:Core> public method __toString ] {
    }
  }
}

参见

ReflectionObject::__construct
Constructors

ReflectionClass::export

导出一个类

说明

public static string ReflectionClass::export ( mixed $argument [, bool $return = false ] )

导出一个反射后的类。

参数

argument
导出的反射。

return
设为 true 时返回导出结果，设为 false（默认值）则忽略返回。

返回值

如果参数 return 设为 true，导出结果将作为 string 返回，否则返回 null。

范例

示例 #1 ReflectionClass::export 的基本用法

<?php
class Apple {
    public $var1;
    public $var2 = 'Orange';

    public function type() {
        return 'Apple';
    }
}
ReflectionClass::export('Apple');
?>

以上例程的输出类似于：

Class [ <user> class Apple ] {
  @@ php shell code 1-8

  - Constants [0] {
  }

  - Static properties [0] {
  }

  - Static methods [0] {
  }

  - Properties [2] {
    Property [ <default> public $var1 ]
    Property [ <default> public $var2 ]
  }

  - Methods [1] {
    Method [ <user> public method type ] {
      @@ php shell code 5 - 7
    }
  }
}

参见

ReflectionClass::getName

ReflectionClass::getConstant

获取定义过的一个常量

说明

public mixed ReflectionClass::getConstant ( string $name )

获取定义过的一个常量。

Warning

本函数还未编写文档，仅有参数列表。

参数

name
常量的名称。

返回值

常量的值。

参见

ReflectionClass::getConstants

ReflectionClass::getConstants

获取一组常量

说明

public array ReflectionClass::getConstants ( void )

获取某个类的全部已定义的常量，不管可见性如何定义。

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

常量的数组，常量名是数组的键，常量的值是数组的值。

参见

ReflectionClass::getConstant

ReflectionClass::getConstructor

获取类的构造函数

说明

public ReflectionMethod ReflectionClass::getConstructor ( void )

获取已反射的类的构造函数。

参数

此函数没有参数。

返回值

一个 ReflectionMethod 对象，反射了类的构造函数，或者当类不存在构造函数时返回 null。

范例

示例 #1 ReflectionClass::getConstructor 的基本用法

<?php
$class = new ReflectionClass('ReflectionClass');
$constructor = $class->getConstructor();
var_dump($constructor);
?>

以上例程会输出：

object(ReflectionMethod)#2 (2) {
  ["name"]=>
  string(11) "__construct"
  ["class"]=>
  string(15) "ReflectionClass"
}

参见

ReflectionClass::getName

ReflectionClass::getDefaultProperties

获取默认属性

说明

public array ReflectionClass::getDefaultProperties ( void )

获取类的默认属性（包括了继承的属性）。

Note:

This method only works for static properties when used on internal classes. The default value of a static class property can not be tracked when using this method on user defined classes.

参数

此函数没有参数。

返回值

默认属性的数组，其键是属性的名称，其值是属性的默认值或者在属性没有默认值时是 null。这个函数不区分静态和非静态属性，也不考虑可见性修饰符。

范例

示例 #1 ReflectionClass::getDefaultProperties 例子

<?php
class Bar {
    protected $inheritedProperty = 'inheritedDefault';
}

class Foo extends Bar {
    public $property = 'propertyDefault';
    private $privateProperty = 'privatePropertyDefault';
    public static $staticProperty = 'staticProperty';
    public $defaultlessProperty;
}

$reflectionClass = new ReflectionClass('Foo');
var_dump($reflectionClass->getDefaultProperties());
?>

以上例程会输出：

array(5) {
   ["staticProperty"]=>
   string(14) "staticProperty"
   ["property"]=>
   string(15) "propertyDefault"
   ["privateProperty"]=>
   string(22) "privatePropertyDefault"
   ["defaultlessProperty"]=>
   NULL
   ["inheritedProperty"]=>
   string(16) "inheritedDefault"
}

参见

ReflectionClass::getProperties
ReflectionClass::getStaticProperties
ReflectionClass::getProperty

ReflectionClass::getDocComment

获取文档注释

说明

public string ReflectionClass::getDocComment ( void )

从一个类中获取文档注释。

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

如果存在则返回文档注释，否则返回 false。

范例

示例 #1 ReflectionClass::getDocComment 例子

<?php
/** 
* A test class
*
* @param  foo bar
* @return baz
*/
class TestClass { }

$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment())
?>

以上例程会输出：

string(55) "/** 
* A test class
*
* @param  foo bar
* @return baz
*/"

参见

ReflectionClass::getName

ReflectionClass::getEndLine

获取最后一行的行数

说明

public int ReflectionClass::getEndLine ( void )

从用户定义的类获取其最后一行的行数。

参数

此函数没有参数。

返回值

返回用户定义的类最后一行的行数，如果未知则返回 false。

范例

示例 #1 ReflectionClass::getEndLine 例子

<?php
// Test Class
class TestClass { }

$rc = new ReflectionClass('TestClass');

echo $rc->getEndLine();
?>

以上例程会输出：

参见

ReflectionClass::getStartLine

ReflectionClass::getExtension

根据已定义的类获取所在扩展的 ReflectionExtension 对象

说明

public ReflectionExtension ReflectionClass::getExtension ( void )

获取已定义类的扩展的 ReflectionExtension 对象。

参数

此函数没有参数。

返回值

类所处的扩展的 ReflectionExtension 对象的表示，如果是用户定义的类则返回 null。

范例

示例 #1 ReflectionClass::getExtension 的基本用法

<?php
$class = new ReflectionClass('ReflectionClass');
$extension = $class->getExtension();
var_dump($extension);
?>

以上例程会输出：

object(ReflectionExtension)#2 (1) {
  ["name"]=>
  string(10) "Reflection"
}

参见

ReflectionClass::getExtensionName

ReflectionClass::getExtensionName

获取定义的类所在的扩展的名称

说明

public string ReflectionClass::getExtensionName ( void )

获取定义的类所在的扩展的名称。

参数

此函数没有参数。

返回值

获取定义的类所在的扩展的名称，如果是用户定义的类，则返回 false。

范例

示例 #1 ReflectionClass::getExtensionName 的基本用法

<?php
$class = new ReflectionClass('ReflectionClass');
$extension = $class->getExtensionName();
var_dump($extension);
?>

以上例程会输出：

string(10) "Reflection"

参见

ReflectionClass::getExtension

ReflectionClass::getFileName

获取定义类的文件名

说明

public string ReflectionClass::getFileName ( void )

获取类被定义的文件的文件名。

参数

此函数没有参数。

返回值

返回类所定义的文件名。如果这个类是在 PHP 核心或 PHP 扩展中定义的，则返回 false。

参见

ReflectionClass::getExtensionName

ReflectionClass::getInterfaceNames

获取接口（interface）名称

说明

public array ReflectionClass::getInterfaceNames ( void )

获取接口（interface）名称。

参数

此函数没有参数。

返回值

一个数值数组，接口（interface）的名称是数组的值。

范例

示例 #1 ReflectionClass::getInterfaceNames 例子

<?php
interface Foo { }

interface Bar { }

class Baz implements Foo, Bar { }

$rc1 = new ReflectionClass("Baz");

print_r($rc1->getInterfaceNames());
?>

以上例程的输出类似于：

Array
(
    [0] => Foo
    [1] => Bar
)

参见

ReflectionClass::getInterfaces

ReflectionClass::getInterfaces

获取接口

说明

public array ReflectionClass::getInterfaces ( void )

获取接口。

参数

此函数没有参数。

返回值

接口的关联数组，数组键是接口（interface）的名称，数组的值是 ReflectionClass 对象。

范例

示例 #1 ReflectionClass::getInterfaces 例子

<?php
interface Foo { }

interface Bar { }

class Baz implements Foo, Bar { }

$rc1 = new ReflectionClass("Baz");

print_r($rc1->getInterfaces());
?>

以上例程的输出类似于：

Array
(
    [Foo] => ReflectionClass Object
        (
            [name] => Foo
        )

    [Bar] => ReflectionClass Object
        (
            [name] => Bar
        )

)

参见

ReflectionClass::getInterfaceNames

ReflectionClass::getMethod

获取一个类方法的 ReflectionMethod。

说明

public ReflectionMethod ReflectionClass::getMethod ( string $name )

获取一个类方法的 ReflectionMethod。

参数

name
要反射的方法名称。

返回值

一个 ReflectionMethod。

错误／异常

如果方法不存在则会抛出 ReflectionException 异常。

范例

示例 #1 ReflectionClass::getMethod 的基本用法

<?php
$class = new ReflectionClass('ReflectionClass');
$method = $class->getMethod('getMethod');
var_dump($method);
?>

以上例程会输出：

object(ReflectionMethod)#2 (2) {
  ["name"]=>
  string(9) "getMethod"
  ["class"]=>
  string(15) "ReflectionClass"
}

参见

ReflectionClass::getMethods

ReflectionClass::getMethods

获取方法的数组

说明

public array ReflectionClass::getMethods ([ int $filter ] )

获取类的方法的一个数组。

参数

filter
过滤结果为仅包含某些属性的方法。默认不过滤。

ReflectionMethod::IS_STATIC、 ReflectionMethod::IS_PUBLIC、 ReflectionMethod::IS_PROTECTED、 ReflectionMethod::IS_PRIVATE、 ReflectionMethod::IS_ABSTRACT、 ReflectionMethod::IS_FINAL 的按位或（OR），就会返回任意满足条件的属性。

Note: 请注意：其他位操作，例如 ~ 无法按预期运行。这个例子也就是说，无法获取所有的非静态方法。

返回值

包含每个方法 ReflectionMethod 对象的数组。

范例

示例 #1 ReflectionClass::getMethods 的基本用法

<?php
class Apple {
    public function firstMethod() { }
    final protected function secondMethod() { }
    private static function thirdMethod() { }
}

$class = new ReflectionClass('Apple');
$methods = $class->getMethods();
var_dump($methods);
?>

以上例程会输出：

array(3) {
  [0]=>
  &object(ReflectionMethod)#2 (2) {
    ["name"]=>
    string(11) "firstMethod"
    ["class"]=>
    string(5) "Apple"
  }
  [1]=>
  &object(ReflectionMethod)#3 (2) {
    ["name"]=>
    string(12) "secondMethod"
    ["class"]=>
    string(5) "Apple"
  }
  [2]=>
  &object(ReflectionMethod)#4 (2) {
    ["name"]=>
    string(11) "thirdMethod"
    ["class"]=>
    string(5) "Apple"
  }
}

示例 #2 从 ReflectionClass::getMethods 中过滤结果

<?php
class Apple {
    public function firstMethod() { }
    final protected function secondMethod() { }
    private static function thirdMethod() { }
}

$class = new ReflectionClass('Apple');
$methods = $class->getMethods(ReflectionMethod::IS_STATIC | ReflectionMethod::IS_FINAL);
var_dump($methods);
?>

以上例程会输出：

array(2) {
  [0]=>
  &object(ReflectionMethod)#2 (2) {
    ["name"]=>
    string(12) "secondMethod"
    ["class"]=>
    string(5) "Apple"
  }
  [1]=>
  &object(ReflectionMethod)#3 (2) {
    ["name"]=>
    string(11) "thirdMethod"
    ["class"]=>
    string(5) "Apple"
  }
}

参见

ReflectionClass::getMethod
get_class_methods

ReflectionClass::getModifiers

获取类的修饰符

说明

public int ReflectionClass::getModifiers ( void )

返回这个类访问修饰符的位字段。

参数

此函数没有参数。

返回值

返回修饰符常量的位掩码。

参见

ReflectionClass::getProperties
Reflection::getModifierNames

ReflectionClass::getName

获取类名

说明

public string ReflectionClass::getName ( void )

获取类的名称。

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

The class name.

范例

示例 #1 ReflectionClass::getName 例子

<?php
namespace A\B;

class Foo { }

$function = new \ReflectionClass('stdClass');

var_dump($function->inNamespace());
var_dump($function->getName());
var_dump($function->getNamespaceName());
var_dump($function->getShortName());

$function = new \ReflectionClass('A\\B\\Foo');

var_dump($function->inNamespace());
var_dump($function->getName());
var_dump($function->getNamespaceName());
var_dump($function->getShortName());
?>

以上例程会输出：

bool(false)
string(8) "stdClass"
string(0) ""
string(8) "stdClass"

bool(true)
string(7) "A\B\Foo"
string(3) "A\B"
string(3) "Foo"

参见

ReflectionClass::getNamespaceName

ReflectionClass::getNamespaceName

获取命名空间的名称

说明

public string ReflectionClass::getNamespaceName ( void )

获取命名空间（namespace）的名称。

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

命名空间的名称。

范例

示例 #1 ReflectionClass::getNamespaceName 例子

<?php
namespace A\B;

class Foo { }

$class = new \ReflectionClass('stdClass');

var_dump($class->inNamespace());
var_dump($class->getName());
var_dump($class->getNamespaceName());
var_dump($class->getShortName());

$class = new \ReflectionClass('A\\B\\Foo');

var_dump($class->inNamespace());
var_dump($class->getName());
var_dump($class->getNamespaceName());
var_dump($class->getShortName());
?>

以上例程会输出：

bool(false)
string(8) "stdClass"
string(0) ""
string(8) "stdClass"

bool(true)
string(7) "A\B\Foo"
string(3) "A\B"
string(3) "Foo"

参见

ReflectionClass::getParentClass
namespaces

ReflectionClass::getParentClass

获取父类

说明

public ReflectionClass ReflectionClass::getParentClass ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

一个 ReflectionClass。

参见

ReflectionClass::__construct

ReflectionClass::getProperties

获取一组属性

说明

public array ReflectionClass::getProperties ([ int $filter ] )

获取反射过的属性。

参数

filter
可选的过滤器，过滤为所需类型的属性。它使用 ReflectionProperty 常量来配置，默认获取所有类型的属性。

返回值

ReflectionProperty 对象的数组。

范例

示例 #1 ReflectionClass::getProperties 过滤例子

这个例子延时了可选 filter 参数的用法，例子里实际上忽略了私有属性。

<?php
class Foo {
    public    $foo  = 1;
    protected $bar  = 2;
    private   $baz  = 3;
}

$foo = new Foo();

$reflect = new ReflectionClass($foo);
$props   = $reflect->getProperties(ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED);

foreach ($props as $prop) {
    print $prop->getName() . "\n";
}

var_dump($props);

?>

以上例程的输出类似于：

foo
bar
array(2) {
  [0]=>
  object(ReflectionProperty)#3 (2) {
    ["name"]=>
    string(3) "foo"
    ["class"]=>
    string(3) "Foo"
  }
  [1]=>
  object(ReflectionProperty)#4 (2) {
    ["name"]=>
    string(3) "bar"
    ["class"]=>
    string(3) "Foo"
  }
}

参见

ReflectionClass::getProperty
ReflectionProperty
ReflectionProperty 修饰符常量

ReflectionClass::getProperty

获取类的一个属性的 ReflectionProperty

说明

public ReflectionProperty ReflectionClass::getProperty ( string $name )

获取类的一个属性的 ReflectionProperty。

参数

name
属性名。

返回值

一个 ReflectionProperty。

范例

示例 #1 ReflectionClass::getProperty 的基本用法

<?php
$class = new ReflectionClass('ReflectionClass');
$property = $class->getProperty('name');
var_dump($property);
?>

以上例程会输出：

object(ReflectionProperty)#2 (2) {
  ["name"]=>
  string(4) "name"
  ["class"]=>
  string(15) "ReflectionClass"
}

参见

ReflectionClass::getProperties

ReflectionClass::getReflectionConstant

Gets a ReflectionClassConstant for a class's constant

说明

public ReflectionClassConstantfalse ReflectionClass::getReflectionConstant ( string $name )

Gets a ReflectionClassConstant for a class's property.

参数

name
The class constant name.

返回值

A ReflectionClassConstant, 或者在失败时返回 false.

参见

ReflectionClass::getReflectionConstants
ReflectionClassConstant

ReflectionClass::getReflectionConstants

Gets class constants

说明

public array ReflectionClass::getReflectionConstants ( void )

Retrieves reflected constants.

参数

此函数没有参数。

返回值

An array of ReflectionClassConstant objects.

范例

示例 #1 Basic ReflectionClass::getReflectionConstants example

<?php
class Foo {
    public    const FOO  = 1;
    protected const BAR  = 2;
    private   const BAZ  = 3;
}

$foo = new Foo();

$reflect = new ReflectionClass($foo);
$consts  = $reflect->getReflectionConstants();

foreach ($consts as $const) {
    print $const->getName() . "\n";
}

var_dump($consts);

?>

以上例程的输出类似于：

FOO
BAR
BAZ
array(3) {
  [0]=>
  object(ReflectionClassConstant)#3 (2) {
    ["name"]=>
    string(3) "FOO"
    ["class"]=>
    string(3) "Foo"
  }
  [1]=>
  object(ReflectionClassConstant)#4 (2) {
    ["name"]=>
    string(3) "BAR"
    ["class"]=>
    string(3) "Foo"
  }
  [2]=>
  object(ReflectionClassConstant)#5 (2) {
    ["name"]=>
    string(3) "BAZ"
    ["class"]=>
    string(3) "Foo"
  }
}

参见

ReflectionClass::getReflectionConstant
ReflectionClassConstant

ReflectionClass::getShortName

获取短名

说明

public string ReflectionClass::getShortName ( void )

获取类的短名，就是不含命名空间（namespace）的那一部分。

参数

此函数没有参数。

返回值

类的短名。

范例

示例 #1 ReflectionClass::getShortName 例子

<?php
namespace A\B;

class Foo { }

$function = new \ReflectionClass('stdClass');

var_dump($function->inNamespace());
var_dump($function->getName());
var_dump($function->getNamespaceName());
var_dump($function->getShortName());

$function = new \ReflectionClass('A\\B\\Foo');

var_dump($function->inNamespace());
var_dump($function->getName());
var_dump($function->getNamespaceName());
var_dump($function->getShortName());
?>

以上例程会输出：

bool(false)
string(8) "stdClass"
string(0) ""
string(8) "stdClass"

bool(true)
string(7) "A\B\Foo"
string(3) "A\B"
string(3) "Foo"

参见

ReflectionClass::getName

ReflectionClass::getStartLine

获取起始行号

说明

public int ReflectionClass::getStartLine ( void )

获取起始的行号。

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

起始的行号，类型是 integer 的。

参见

ReflectionClass::getEndLine

ReflectionClass::getStaticProperties

获取静态（static）属性

说明

public array ReflectionClass::getStaticProperties ( void )

获取静态（static）属性。

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

静态（static）的属性，类型是 array。

参见

ReflectionClass::getStaticPropertyValue
ReflectionClass::setStaticPropertyValue

ReflectionClass::getStaticPropertyValue

获取静态（static）属性的值

说明

public mixed ReflectionClass::getStaticPropertyValue ( string $name [, mixed &$def_value ] )

获取这个类里静态（static）属性的值。

参数

name
静态属性的名称，来返回它的值。

def_value
假如类没有定义 name 的 static 属性，将返回一个默认值。如果属性不存在，并且省略了此参数，将会抛出 ReflectionException 。

返回值

静态属性的值。

范例

示例 #1 ReflectionClass::getStaticPropertyValue 的基本用法

<?php
class Apple {
    public static $color = 'Red';
}

$class = new ReflectionClass('Apple');
var_dump($class->getStaticPropertyValue('color'));
?>

以上例程会输出：

string(3) "Red"

参见

ReflectionClass::getStaticProperties
ReflectionClass::setStaticPropertyValue

ReflectionClass::getTraitAliases

返回 trait 别名的一个数组

说明

public array ReflectionClass::getTraitAliases ( void )

Warning

返回了一个数组，键是 trait 的名称，值是 trait 实例的 ReflectionClass。出现错误的情况下返回 null。

ReflectionClass::hasConstant

检查常量是否已经定义

说明

public bool ReflectionClass::hasConstant ( string $name )

检查类中是否已经定义了指定的常量。

参数

name
要被检查的常量名称。

返回值

如果已定义返回 true，否则返回 false。

范例

示例 #1 ReflectionClass::hasConstant 例子

<?php
class Foo {
    const c1 = 1;
}

$class = new ReflectionClass("Foo");

var_dump($class->hasConstant("c1"));
var_dump($class->hasConstant("c2"));
?>

以上例程的输出类似于：

bool(true)
bool(false)

参见

ReflectionClass::hasMethod
ReflectionClass::hasProperty

ReflectionClass::hasMethod

检查方法是否已定义

说明

public bool ReflectionClass::hasMethod ( string $name )

检查一个类中指定的方法是否已定义。

参数

name
要检查的方法的名称。

返回值

如果有这个方法返回 true，否则返回 false。

范例

示例 #1 ReflectionClass::hasMethod 例子

<?php
Class C {
    public function publicFoo() {
        return true;
    }

    protected function protectedFoo() {
        return true;
    }

    private function privateFoo() {
        return true;
    }

    static function staticFoo() {
        return true;
    }
}

$rc = new ReflectionClass("C");

var_dump($rc->hasMethod('publicFoo'));

var_dump($rc->hasMethod('protectedFoo'));

var_dump($rc->hasMethod('privateFoo'));

var_dump($rc->hasMethod('staticFoo'));

// C should not have method bar
var_dump($rc->hasMethod('bar'));

// Method names are case insensitive
var_dump($rc->hasMethod('PUBLICfOO'));
?>

以上例程会输出：

bool(true)
bool(true)
bool(true)
bool(true)
bool(false)
bool(true)

参见

ReflectionClass::hasConstant
ReflectionClass::hasProperty

ReflectionClass::hasProperty

检查属性是否已定义

说明

public bool ReflectionClass::hasProperty ( string $name )

检查指定的属性是否已定义。

参数

name
待检查的属性的名称。

返回值

如果有这个属性返回 true，否则返回 false。

范例

示例 #1 ReflectionClass::hasProperty 例子

<?php
class Foo {
    public    $p1;
    protected $p2;
    private   $p3;

}

$obj = new ReflectionObject(new Foo());

var_dump($obj->hasProperty("p1"));
var_dump($obj->hasProperty("p2"));
var_dump($obj->hasProperty("p3"));
var_dump($obj->hasProperty("p4"));
?>

以上例程的输出类似于：

bool(true)
bool(true)
bool(true)
bool(false)

参见

ReflectionClass::hasConstant
ReflectionClass::hasMethod

ReflectionClass::implementsInterface

接口的实现

说明

public bool ReflectionClass::implementsInterface ( string $interface )

检查它是否实现了一个接口（interface）。

参数

interface
接口（interface）的名称。

返回值

成功时返回 true，或者在失败时返回 false。

参见

ReflectionClass::isInterface
ReflectionClass::isSubclassOf
interface_exists
Object Interfaces

ReflectionClass::inNamespace

检查是否位于命名空间中

说明

public bool ReflectionClass::inNamespace ( void )

检查这个类是否定义于一个命名空间中里。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::inNamespace 例子

<?php
namespace A\B;

class Foo { }

$function = new \ReflectionClass('stdClass');

var_dump($function->inNamespace());
var_dump($function->getName());
var_dump($function->getNamespaceName());
var_dump($function->getShortName());

$function = new \ReflectionClass('A\\B\\Foo');

var_dump($function->inNamespace());
var_dump($function->getName());
var_dump($function->getNamespaceName());
var_dump($function->getShortName());
?>

以上例程会输出：

bool(false)
string(8) "stdClass"
string(0) ""
string(8) "stdClass"

bool(true)
string(7) "A\B\Foo"
string(3) "A\B"
string(3) "Foo"

参见

ReflectionClass::getNamespaceName
PHP Namespaces

ReflectionClass::isAbstract

检查类是否是抽象类（abstract）

说明

public bool ReflectionClass::isAbstract ( void )

检查这个类是否是抽象类（abstract）。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isAbstract 例子

<?php
class          TestClass { }
abstract class TestAbstractClass { }

$testClass     = new ReflectionClass('TestClass');
$abstractClass = new ReflectionClass('TestAbstractClass');

var_dump($testClass->isAbstract());
var_dump($abstractClass->isAbstract());
?>

以上例程会输出：

bool(false)
bool(true)

参见

ReflectionClass::isInterface
类的抽象

ReflectionClass::isAnonymous

检查类是否是匿名类

说明

public bool ReflectionClass::isAnonymous ( void )

检查类是否是匿名类。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isAnonymous example

<?php
class TestClass {}
$anonClass = new class {};

$normalClass = new ReflectionClass('TestClass');
$anonClass  = new ReflectionClass($anonClass);

var_dump($normalClass->isAnonymous());
var_dump($anonClass->isAnonymous());

?>

以上例程会输出：

bool(false)
bool(true)

参见

ReflectionClass::isFinal

ReflectionClass::isCloneable

返回了一个类是否可复制

说明

public bool ReflectionClass::isCloneable ( void )

返回了这个类是否可复制。

参数

此函数没有参数。

返回值

如果这个类可以复制返回 true，否则返回 false。

范例

示例 #1 ReflectionClass::isCloneable 的基本用法

<?php
class NotCloneable {
    public $var1;

    private function __clone() {
    }
}

class Cloneable {
    public $var1;
}

$notCloneable = new ReflectionClass('NotCloneable');
$cloneable = new ReflectionClass('Cloneable');

var_dump($notCloneable->isCloneable());
var_dump($cloneable->isCloneable());
?>

以上例程会输出：

bool(false)
bool(true)

ReflectionClass::isFinal

检查类是否声明为 final

说明

public bool ReflectionClass::isFinal ( void )

检查类是否声明为 final。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isFinal 例子

<?php
class       TestClass { }
final class TestFinalClass { }

$normalClass = new ReflectionClass('TestClass');
$finalClass  = new ReflectionClass('TestFinalClass');

var_dump($normalClass->isFinal());
var_dump($finalClass->isFinal());

?>

以上例程会输出：

bool(false)
bool(true)

参见

ReflectionClass::isAbstract
Final 关键字

ReflectionClass::isInstance

检查类的实例

说明

public bool ReflectionClass::isInstance ( object $object )

检查对象是否为一个类的实例。

参数

object
待比较的对象。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isInstance 相关例子

<?php
// Example usage
$class = new ReflectionClass('Foo');

if ($class->isInstance($arg)) {
    echo "Yes";
}

// Equivalent to
if ($arg instanceof Foo) {
    echo "Yes";
}

// Equivalent to
if (is_a($arg, 'Foo')) {
    echo "Yes";
}
?>

以上例程的输出类似于：

Yes
Yes
Yes

参见

ReflectionClass::isInterface
类型运算符（instanceof）
对象接口
is_a

ReflectionClass::isInstantiable

检查类是否可实例化

说明

public bool ReflectionClass::isInstantiable ( void )

检查这个类是否可实例化。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isInstantiable 例子

<?php
class C { }

interface iface {
    function f1();
}

class ifaceImpl implements iface {
    function f1() {}
}

abstract class abstractClass {
    function f1() { }
    abstract function f2();
}

class D extends abstractClass {
    function f2() { }
}

class privateConstructor {
    private function __construct() { }
}

$classes = array(
    "C",
    "iface",
    "ifaceImpl",
    "abstractClass",
    "D",
    "privateConstructor",
);

foreach($classes  as $class ) {
    $reflectionClass = new ReflectionClass($class);
    echo "Is $class instantiable?  ";
    var_dump($reflectionClass->IsInstantiable()); 
}

?>

以上例程会输出：

Is C instantiable?  bool(true)
Is iface instantiable?  bool(false)
Is ifaceImpl instantiable?  bool(true)
Is abstractClass instantiable?  bool(false)
Is D instantiable?  bool(true)
Is privateConstructor instantiable?  bool(false)

参见

ReflectionClass::isInstance

ReflectionClass::isInterface

检查类是否是一个接口（interface）

说明

public bool ReflectionClass::isInterface ( void )

检查类是否是一个接口（interface）。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isInterface 基本用法

<?php
interface SomeInterface {
    public function interfaceMethod();
}

$class = new ReflectionClass('SomeInterface');
var_dump($class->isInterface());
?>

以上例程会输出：

bool(true)

参见

ReflectionClass::isInstance

ReflectionClass::isInternal

检查类是否由扩展或核心在内部定义

说明

public bool ReflectionClass::isInternal ( void )

检查类是否由扩展或核心在内部定义，与用户定义相反。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isInternal 的基本用法

<?php
$internalclass = new ReflectionClass('ReflectionClass');

class Apple {}
$userclass = new ReflectionClass('Apple');

var_dump($internalclass->isInternal());
var_dump($userclass->isInternal());
?>

以上例程会输出：

bool(true)
bool(false)

参见

ReflectionClass::isUserDefined

ReflectionClass::isIterable

Check whether this class is iterable

说明

public bool ReflectionClass::isIterable ( void )

Check whether this class is iterable (i.e. can be used inside foreach).

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 Basic ReflectionClass::isIterable Usage

<?php

class IteratorClass implements Iterator {
    public function __construct() { }
    public function key() { }
    public function current() { }
    function next() { }
    function valid() { }
    function rewind() { }
}
class DerivedClass extends IteratorClass { }
class NonIterator { }

function dump_iterable($class) {
    $reflection = new ReflectionClass($class);
    var_dump($reflection->isIterable());
}

$classes = array("ArrayObject", "IteratorClass", "DerivedClass", "NonIterator");

foreach ($classes as $class) {
    echo "Is $class iterable? ";
    dump_iterable($class);
}
?>

以上例程会输出：

Is ArrayObject iterable? bool(true)
Is IteratorClass iterable? bool(true)
Is DerivedClass iterable? bool(true)
Is NonIterator iterable? bool(false)

参见

ReflectionClass::__construct

ReflectionClass::isIterateable

检查是否可迭代（iterateable）

说明

public bool ReflectionClass::isIterateable ( void )

检查一个类是否可迭代（iterateable）。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 ReflectionClass::isIterateable 例子

<?php

class IteratorClass implements Iterator {
    public function __construct() { }
    public function key() { }
    public function current() { }
    function next() { }
    function valid() { }
    function rewind() { }
}
class DerivedClass extends IteratorClass { }
class NonIterator { }

function dump_iterateable($class) {
    $reflection = new ReflectionClass($class);
    var_dump($reflection->isIterateable());
}

$classes = array("ArrayObject", "IteratorClass", "DerivedClass", "NonIterator");

foreach ($classes as $class) {
    echo "Is $class iterateable? ";
    dump_iterateable($class);
}
?>

以上例程会输出：

Is ArrayObject iterateable? bool(true)
Is IteratorClass iterateable? bool(true)
Is DerivedClass iterateable? bool(true)
Is NonIterator iterateable? bool(false)

参见

ReflectionClass::__construct

ReflectionClass::isSubclassOf

检查是否为一个子类

说明

public bool ReflectionClass::isSubclassOf ( string $class )

检查一个类是否为指定类的子类，或者实现了指定的接口。

参数

class
被检查的类名。

返回值

成功时返回 true，或者在失败时返回 false。

参见

ReflectionClass::isInterface
ReflectionClass::implementsInterface
is_subclass_of
get_parent_class

ReflectionClass::isTrait

返回了是否为一个 trait

说明

public bool ReflectionClass::isTrait ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

如果是 trait 返回 true，否则返回 false。在出现错误的情况下，将会返回 null。

ReflectionClass::isUserDefined

检查是否由用户定义的

说明

public bool ReflectionClass::isUserDefined ( void )

检查一个类是否由用户定义，和内置相对。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

参见

ReflectionClass::isInternal

ReflectionClass::newInstance

从指定的参数创建一个新的类实例

说明

public object ReflectionClass::newInstance ( mixed $args [, mixed $... ] )

创建类的新的实例。给出的参数将会传递到类的构造函数。

参数

args
接受可变数目的参数，用于传递到类的构造函数，和 call_user_func 很相似。

返回值

错误／异常

如果类的构造函数不是 public 的将会导致一个 ReflectionException。

当 args 指定了一个或多个参数，而类不具有构造函数时,将导致一个 ReflectionException。

参见

ReflectionClass::newInstanceArgs
ReflectionClass::newInstanceWithoutConstructor

ReflectionClass::newInstanceArgs

从给出的参数创建一个新的类实例。

说明

public object ReflectionClass::newInstanceArgs ([ array $args ] )

创建一个类的新实例，给出的参数将传递到类的构造函数。

参数

args
这个参数以 array 形式传递到类的构造函数。

返回值

返回类的新实例。

范例

示例 #1 ReflectionClass::newInstanceArgs 的基本用法

<?php
$class = new ReflectionClass('ReflectionFunction');
$instance = $class->newInstanceArgs(array('substr'));
var_dump($instance);
?>

以上例程会输出：

object(ReflectionFunction)#2 (1) {
  ["name"]=>
  string(6) "substr"
}

错误／异常

如果类的构造函数不是 public 的将导致产生一个 ReflectionException。

当 args 指定了一个或多个参数，而类不具有构造函数时,将导致一个 ReflectionException。

参见

ReflectionClass::newInstance
ReflectionClass::newInstanceWithoutConstructor

ReflectionClass::newInstanceWithoutConstructor

创建一个新的类实例而不调用它的构造函数

说明

public object ReflectionClass::newInstanceWithoutConstructor ( void )

创建一个新的类的实例而不调用它的构造函数。

参数

返回值

更新日志

版本	说明
5.6.0	All internal classes can now be instantiated except for those declared final.

错误／异常

如果这个类是一个不能不调用构造函数来实例化的内置类，将导致一个 ReflectionException。在 PHP 5.6.0 及更高版本中，此异常仅限于 final 的内置类。

参见

ReflectionClass::newInstance
ReflectionClass::newInstanceArgs

ReflectionClass::setStaticPropertyValue

设置静态属性的值

说明

public void ReflectionClass::setStaticPropertyValue ( string $name , string $value )

设置静态属性的值。

Warning

本函数还未编写文档，仅有参数列表。

参数

name
属性的名称。

value
属性的值。

返回值

没有返回值。

参见

ReflectionClass::getStaticPropertyValue

ReflectionClass::__toString

返回 ReflectionClass 对象字符串的表示形式。

说明

public string ReflectionClass::__toString ( void )

返回 ReflectionClass 对象字符串的表示形式。

参数

此函数没有参数。

返回值

ReflectionClass 实例的一个字符串表示形式。

范例

示例 #1 ReflectionClass::__toString 例子

<?php
$reflectionClass = new ReflectionClass('Exception');
echo $reflectionClass->__toString();
?>

以上例程会输出：

Class [ <internal:Core> class Exception ] {

  - Constants [0] {
  }

  - Static properties [0] {
  }

  - Static methods [0] {
  }

  - Properties [7] {
    Property [ <default> protected $message ]
    Property [ <default> private $string ]
    Property [ <default> protected $code ]
    Property [ <default> protected $file ]
    Property [ <default> protected $line ]
    Property [ <default> private $trace ]
    Property [ <default> private $previous ]
  }

  - Methods [10] {
    Method [ <internal:Core> final private method __clone ] {
    }

    Method [ <internal:Core, ctor> public method __construct ] {

      - Parameters [3] {
        Parameter #0 [ <optional> $message ]
        Parameter #1 [ <optional> $code ]
        Parameter #2 [ <optional> $previous ]
      }
    }

    Method [ <internal:Core> final public method getMessage ] {
    }

    Method [ <internal:Core> final public method getCode ] {
    }

    Method [ <internal:Core> final public method getFile ] {
    }

    Method [ <internal:Core> final public method getLine ] {
    }

    Method [ <internal:Core> final public method getTrace ] {
    }

    Method [ <internal:Core> final public method getPrevious ] {
    }

    Method [ <internal:Core> final public method getTraceAsString ] {
    }

    Method [ <internal:Core> public method __toString ] {
    }
  }
}

参见

ReflectionClass::export
__toString()

简介

The ReflectionClassConstant class reports information about a class constant.

类摘要

ReflectionClassConstant

class ReflectionClassConstant implements Reflector {

/* 属性 */

public $name ;

public $class ;

/* 方法 */

public __construct ( mixed $class , string $name )

public static string export ( mixed $class , string $name [, bool $return ] )

public ReflectionClass getDeclaringClass ( void )

public string getDocComment ( void )

public int getModifiers ( void )

public string getName ( void )

public mixed getValue ( void )

public bool isPrivate ( void )

public bool isProtected ( void )

public bool isPublic ( void )

public string __toString ( void )

}

属性

name
Name of the class constant. Read-only, throws ReflectionException in attempt to write.

class
Name of the class where the class constant is defined. Read-only, throws ReflectionException in attempt to write.

ReflectionClassConstant::__construct

Constructs a ReflectionClassConstant

说明

public ReflectionClassConstant::__construct ( mixed $class , string $name )

Constructs a new ReflectionClassConstant object.

参数

class
Either a string containing the name of the class to reflect, or an object.

name
The name of the class constant.

返回值

Returns constructed ReflectionClassConstant instance.

错误／异常

Throws an Exception in case the given class constant does not exist.

参见

Constructors

ReflectionClassConstant::export

Export

Warning

本函数已自 PHP 7.4.0 起废弃。强烈建议不要使用本函数。

说明

public static string ReflectionClassConstant::export ( mixed $class , string $name [, bool $return ] )

Exports a reflection.

Warning

本函数还未编写文档，仅有参数列表。

参数

class
导出的反射。

name
The class constant name.

return
设为 true 时返回导出结果，设为 false（默认值）则忽略返回。

返回值

参见

ReflectionClassConstant::__toString

参见

Reflection::getModifierNames

ReflectionClassConstant::getName

Get name of the constant

说明

说明

public bool ReflectionClassConstant::isProtected ( void )

Checks if the class constant is protected.

参数

此函数没有参数。

返回值

true if the class constant is protected, otherwise false

参见

ReflectionClassConstant::isPublic
ReflectionClassConstant::isPrivate

ReflectionClassConstant::isPublic

Checks if class constant is public

说明

public bool ReflectionClassConstant::isPublic ( void )

Checks if the class constant is public.

参数

此函数没有参数。

返回值

true if the class constant is public, otherwise false

参见

ReflectionClassConstant::isPrivate
ReflectionClassConstant::isProtected

ReflectionClassConstant::__toString

Returns the string representation of the ReflectionClassConstant object

说明

public string ReflectionClassConstant::__toString ( void )

Returns the string representation of the ReflectionClassConstant object.

参数

此函数没有参数。

返回值

A string representation of this ReflectionClassConstant instance.

参见

ReflectionClassConstant::export
__toString()

简介

类摘要

ReflectionZendExtension

class ReflectionZendExtension implements Reflector {

/* 属性 */

public $name ;

/* 方法 */

final private void __clone ( void )

public __construct ( string $name )

public static string export ( string $name [, bool $return ] )

public string getAuthor ( void )

public string getCopyright ( void )

public string getName ( void )

public string getURL ( void )

public string getVersion ( void )

public string __toString ( void )

}

属性

name
扩展的名称。只读，并在尝试赋值的时候抛出 ReflectionException。

ReflectionZendExtension::__clone

Clone handler

说明

final private void ReflectionZendExtension::__clone ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

ReflectionZendExtension::__construct

Constructor

说明

public ReflectionZendExtension::__construct ( string $name )

Warning

本函数还未编写文档，仅有参数列表。

参数

name

返回值

ReflectionZendExtension::export

Export

Warning

本函数已自 PHP 7.4.0 起废弃。强烈建议不要使用本函数。

说明

public static string ReflectionZendExtension::export ( string $name [, bool $return ] )

Warning

本函数还未编写文档，仅有参数列表。

参数

name

return

返回值

参见

ReflectionClassConstant::__toString

简介

ReflectionExtension 报告了一个扩展（extension）的有关信息。

类摘要

ReflectionExtension

class ReflectionExtension implements Reflector {

/* 属性 */

public $name ;

/* 方法 */

final private void __clone ( void )

public __construct ( string $name )

public static string export ( string $name [, string $return = false ] )

public array getClasses ( void )

public array getClassNames ( void )

public array getConstants ( void )

public array getDependencies ( void )

public array getFunctions ( void )

public array getINIEntries ( void )

public string getName ( void )

public string getVersion ( void )

public void info ( void )

public void isPersistent ( void )

public void isTemporary ( void )

public string __toString ( void )

}

属性

name
扩展的名称，和 ReflectionExtension::getName 方法所返回的一样。

ReflectionExtension::__clone

Clones

说明

final private void ReflectionExtension::__clone ( void )

clone方法阻止实例克隆。反射类实例不允许被克隆。

参数

此函数没有参数。

返回值

没有返回值，如果被调用将产生fatal错误。

参见

ReflectionExtension::__construct
Object cloning

ReflectionExtension::__construct

Constructs a ReflectionExtension

说明

public ReflectionExtension::__construct ( string $name )

Construct a ReflectionExtension object.

参数

name
扩展的名称。

返回值

A ReflectionExtension object.

范例

示例 #1 ReflectionExtension example

<?php
$ext = new ReflectionExtension('Reflection');

printf('Extension: %s (version: %s)', $ext->getName(), $ext->getVersion());
?>

以上例程的输出类似于：

Extension: Reflection (version: $Revision: 338648 $)

参见

ReflectionExtension::info
Constructors

ReflectionExtension::export

Export

说明

public static string ReflectionExtension::export ( string $name [, string $return = false ] )

导出可以被反射的扩展。输出格式同CLI argument --re [extension].

参数

name
导出的反射。

return
设为 true 时返回导出结果，设为 false（默认值）则忽略返回。

返回值

如果参数 return 设为 true，导出结果将作为 string 返回，否则返回 null。

参见

ReflectionExtension::info

ReflectionExtension::getClasses

Gets classes

说明

public array ReflectionExtension::getClasses ( void )

从扩展中获取类列表。

参数

此函数没有参数。

返回值

返回一个ReflectionClass对象数组，包括扩展中所有类。如果扩展中没有类声明，将返回空数组。

范例

示例 #1 ReflectionExtension::getClasses example

<?php
$ext = new ReflectionExtension('XMLWriter');
var_dump($ext->getClasses());
?>

以上例程的输出类似于：

array(1) {
  ["XMLWriter"]=>
  &object(ReflectionClass)#2 (1) {
    ["name"]=>
    string(9) "XMLWriter"
  }
}

参见

ReflectionExtension::getClassNames

ReflectionExtension::getClassNames

获取类名称

说明

public array ReflectionExtension::getClassNames ( void )

获取扩展中的类名称列表。

参数

此函数没有参数。

返回值

返回类名称数组。如果扩展中没有类声明，将返回空数组。

范例

示例 #1 ReflectionExtension::getClassNames example

<?php
$ext = new ReflectionExtension('XMLWriter');
var_dump($ext->getClassNames());
?>

以上例程的输出类似于：

array(1) {
  [0]=>
  string(9) "XMLWriter"
}

参见

ReflectionExtension::getClasses
ReflectionExtension::getName

ReflectionExtension::getConstants

获取常量

说明

public array ReflectionExtension::getConstants ( void )

获取扩展中定义的常量。

参数

此函数没有参数。

返回值

返回一个以常量名称为索引的数组。

范例

示例 #1 ReflectionExtension::getConstants example

<?php
$ext = new ReflectionExtension('DOM');

print_r($ext->getConstants());
?>

以上例程的输出类似于：

Array
(
    [XML_ELEMENT_NODE] => 1
    [XML_ATTRIBUTE_NODE] => 2
    [XML_TEXT_NODE] => 3
    [XML_CDATA_SECTION_NODE] => 4
    [XML_ENTITY_REF_NODE] => 5
    [XML_ENTITY_NODE] => 6
    [XML_PI_NODE] => 7
    [XML_COMMENT_NODE] => 8
    [XML_DOCUMENT_NODE] => 9
    [XML_DOCUMENT_TYPE_NODE] => 10
    [XML_DOCUMENT_FRAG_NODE] => 11
    [XML_NOTATION_NODE] => 12
    [XML_HTML_DOCUMENT_NODE] => 13
    [XML_DTD_NODE] => 14
    [XML_ELEMENT_DECL_NODE] => 15
    [XML_ATTRIBUTE_DECL_NODE] => 16
    [XML_ENTITY_DECL_NODE] => 17
    [XML_NAMESPACE_DECL_NODE] => 18
    [XML_LOCAL_NAMESPACE] => 18
    [XML_ATTRIBUTE_CDATA] => 1
    [XML_ATTRIBUTE_ID] => 2
    [XML_ATTRIBUTE_IDREF] => 3
    [XML_ATTRIBUTE_IDREFS] => 4
    [XML_ATTRIBUTE_ENTITY] => 6
    [XML_ATTRIBUTE_NMTOKEN] => 7
    [XML_ATTRIBUTE_NMTOKENS] => 8
    [XML_ATTRIBUTE_ENUMERATION] => 9
    [XML_ATTRIBUTE_NOTATION] => 10
    [DOM_PHP_ERR] => 0
    [DOM_INDEX_SIZE_ERR] => 1
    [DOMSTRING_SIZE_ERR] => 2
    [DOM_HIERARCHY_REQUEST_ERR] => 3
    [DOM_WRONG_DOCUMENT_ERR] => 4
    [DOM_INVALID_CHARACTER_ERR] => 5
    [DOM_NO_DATA_ALLOWED_ERR] => 6
    [DOM_NO_MODIFICATION_ALLOWED_ERR] => 7
    [DOM_NOT_FOUND_ERR] => 8
    [DOM_NOT_SUPPORTED_ERR] => 9
    [DOM_INUSE_ATTRIBUTE_ERR] => 10
    [DOM_INVALID_STATE_ERR] => 11
    [DOM_SYNTAX_ERR] => 12
    [DOM_INVALID_MODIFICATION_ERR] => 13
    [DOM_NAMESPACE_ERR] => 14
    [DOM_INVALID_ACCESS_ERR] => 15
    [DOM_VALIDATION_ERR] => 16
)

参见

ReflectionExtension::getINIEntries

ReflectionExtension::getDependencies

获取依赖

说明

public array ReflectionExtension::getDependencies ( void )

获取依赖，包括必需的、冲突的、可选的。 Gets dependencies, by listing both required and conflicting dependencies.

参数

此函数没有参数。

返回值

返回一个以依赖的扩展名称为索引的数组，每一项的取值为 Required、Optional 或者 Conflicts。

范例

示例 #1 ReflectionExtension::getDependencies example

<?php
$dom = new ReflectionExtension('dom');

print_r($dom->getDependencies());
?>

以上例程的输出类似于：

Array
(
    [libxml] => Required
    [domxml] => Conflicts
)

参见

ReflectionClass::getVersion

ReflectionExtension::getFunctions

获取扩展中的函数

说明

public array ReflectionExtension::getFunctions ( void )

获取扩展中定义的函数。

参数

此函数没有参数。

返回值

返回一个ReflectionFunction对象数组，数组索引为函数名。如果扩展中没有定义函数，将返回空数组。

范例

示例 #1 ReflectionExtension::getFunctions example

<?php
$dom = new ReflectionExtension('SimpleXML');

print_r($dom->getFunctions());
?>

以上例程的输出类似于：

Array
(
    [simplexml_load_file] => ReflectionFunction Object
        (
            [name] => simplexml_load_file
        )

    [simplexml_load_string] => ReflectionFunction Object
        (
            [name] => simplexml_load_string
        )

    [simplexml_import_dom] => ReflectionFunction Object
        (
            [name] => simplexml_import_dom
        )

)

参见

ReflectionExtension::getClasses
get_extension_funcs

ReflectionExtension::getINIEntries

获取ini配置

说明

public array ReflectionExtension::getINIEntries ( void )

获取扩展在ini配置文件中的配置。

参数

此函数没有参数。

返回值

返回一个数组，数组索引是配置名称，值是配置值。

范例

示例 #1 ReflectionExtension::getINIEntries example

<?php
$ext = new ReflectionExtension('mysql');

print_r($ext->getINIEntries());
?>

以上例程的输出类似于：

Array
(
    [mysql.allow_persistent] => 1
    [mysql.max_persistent] => -1
    [mysql.max_links] => -1
    [mysql.default_host] => 
    [mysql.default_user] => 
    [mysql.default_password] => 
    [mysql.default_port] => 
    [mysql.default_socket] => 
    [mysql.connect_timeout] => 60
    [mysql.trace_mode] => 
    [mysql.allow_local_infile] => 1
    [mysql.cache_size] => 2000
)

参见

ini_get_all
ReflectionExtension::getConstants

ReflectionExtension::getName

获取扩展名称

说明

public string ReflectionExtension::getName ( void )

获取扩展名称。

参数

此函数没有参数。

返回值

扩展名称。

范例

示例 #1 ReflectionExtension::getName example

<?php
$ext = new ReflectionExtension('mysqli');
var_dump($ext->getName());
?>

以上例程的输出类似于：

string(6) "mysqli"

参见

ReflectionExtension::getClassNames

ReflectionExtension::getVersion

获取扩展版本号

说明

public string ReflectionExtension::getVersion ( void )

获取扩展的版本号。

参数

此函数没有参数。

返回值

扩展的版本号。

范例

示例 #1 ReflectionExtension::getVersion example

<?php
$ext = new ReflectionExtension('mysqli');
var_dump($ext->getVersion());
?>

以上例程的输出类似于：

string(3) "0.1"

参见

ReflectionExtension::info

ReflectionExtension::info

输出扩展信息

说明

public void ReflectionExtension::info ( void )

输出“phpinfo”信息中的扩展信息。

参数

此函数没有参数。

返回值

扩展信息。

范例

示例 #1 ReflectionExtension::info example

<?php
$ext = new ReflectionExtension('mysqli');
$ext->info();
?>

以上例程的输出类似于：

mysqli

MysqlI Support => enabled
Client API library version => mysqlnd 5.0.5-dev - 081106 - $Revision: 339009 $
Active Persistent Links => 0
Inactive Persistent Links => 0
Active Links => 0
Persistent cache => enabled
put_hits => 0
put_misses => 0
get_hits => 0
get_misses => 0
size => 2000
free_items => 2000
references => 2

Directive => Local Value => Master Value
mysqli.max_links => Unlimited => Unlimited
mysqli.max_persistent => Unlimited => Unlimited
mysqli.allow_persistent => On => On
mysqli.default_host => no value => no value
mysqli.default_user => no value => no value
mysqli.default_pw => no value => no value
mysqli.default_port => 3306 => 3306
mysqli.default_socket => no value => no value
mysqli.reconnect => Off => Off
mysqli.allow_local_infile => On => On
mysqli.cache_size => 2000 => 2000

参见

ReflectionExtension::getName
phpinfo

ReflectionExtension::isPersistent

返回扩展是否持久化载入

说明

public void ReflectionExtension::isPersistent ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

扩展在extension配置中被载入返回true ，否则返回 false。

参见

ReflectionExtension::isTemporary

ReflectionExtension::isTemporary

返回扩展是否是临时载入

说明

public void ReflectionExtension::isTemporary ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

如果扩展被dl载入则返回true ，否则返回 false 。

参见

ReflectionExtension::isPersistent

ReflectionExtension::__toString

To string

说明

public string ReflectionExtension::__toString ( void )

以string形式返回扩展的反射信息。同 ReflectionExtension::exportreturn参数设置为true。

参数

此函数没有参数。

返回值

返回扩展的反射信息，同 ReflectionExtension::export。

参见

ReflectionExtension::__construct
ReflectionExtension::export
__toString()

简介

ReflectionFunction 类报告了一个函数的有关信息。

类摘要

ReflectionFunction

class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector {

/* 常量 */

const integer ReflectionFunction::IS_DEPRECATED = 262144 ;

/* 属性 */

public $name ;

/* 方法 */

public __construct ( mixed $name )

public static string export ( string $name [, string $return ] )

public Closure getClosure ( void )

public mixed invoke ( mixed $args )

public mixed invokeArgs ( array $args )

public bool isDisabled ( void )

public string __toString ( void )

/* 继承的方法 */

final private void ReflectionFunctionAbstract::__clone ( void )

public ReflectionClass ReflectionFunctionAbstract::getClosureScopeClass ( void )

public object ReflectionFunctionAbstract::getClosureThis ( void )

public string ReflectionFunctionAbstract::getDocComment ( void )

public int ReflectionFunctionAbstract::getEndLine ( void )

public ReflectionExtension ReflectionFunctionAbstract::getExtension ( void )

public string ReflectionFunctionAbstract::getExtensionName ( void )

public string ReflectionFunctionAbstract::getFileName ( void )

public string ReflectionFunctionAbstract::getName ( void )

public string ReflectionFunctionAbstract::getNamespaceName ( void )

public int ReflectionFunctionAbstract::getNumberOfParameters ( void )

public int ReflectionFunctionAbstract::getNumberOfRequiredParameters ( void )

public array ReflectionFunctionAbstract::getParameters ( void )

public ReflectionType ReflectionFunctionAbstract::getReturnType ( void )

public string ReflectionFunctionAbstract::getShortName ( void )

public int ReflectionFunctionAbstract::getStartLine ( void )

public array ReflectionFunctionAbstract::getStaticVariables ( void )

public bool ReflectionFunctionAbstract::hasReturnType ( void )

public bool ReflectionFunctionAbstract::inNamespace ( void )

public bool ReflectionFunctionAbstract::isClosure ( void )

public bool ReflectionFunctionAbstract::isDeprecated ( void )

public bool ReflectionFunctionAbstract::isGenerator ( void )

public bool ReflectionFunctionAbstract::isInternal ( void )

public bool ReflectionFunctionAbstract::isUserDefined ( void )

public bool ReflectionFunctionAbstract::isVariadic ( void )

public bool ReflectionFunctionAbstract::returnsReference ( void )

abstract public void ReflectionFunctionAbstract::__toString ( void )

}

属性

name
函数的名称。只读，并在尝试赋值的时候会抛出 ReflectionException。

预定义常量

ReflectionFunction 修饰符

ReflectionFunction::IS_DEPRECATED
指示了不建议使用的函数。

ReflectionFunction::__construct

Constructs a ReflectionFunction object

说明

public ReflectionFunction::__construct ( mixed $name )

Constructs a ReflectionFunction object.

参数

name
The name of the function to reflect or a closure.

返回值

没有返回值。

错误／异常

A ReflectionException if the name parameter does not contain a valid function.

范例

示例 #1 ReflectionFunction::__construct example

<?php
/**
 * A simple counter
 *
 * @return    int
 */
function counter1()
{
    static $c = 0;
    return ++$c;
}

/**
 * Another simple counter
 *
 * @return    int
 */
$counter2 = function()
{
    static $d = 0;
    return ++$d;

};

function dumpReflectionFunction($func)
{
    // Print out basic information
    printf(
        "\n\n===> The %s function '%s'\n".
        "     declared in %s\n".
        "     lines %d to %d\n",
        $func->isInternal() ? 'internal' : 'user-defined',
        $func->getName(),
        $func->getFileName(),
        $func->getStartLine(),
        $func->getEndline()
    );

    // Print documentation comment
    printf("---> Documentation:\n %s\n", var_export($func->getDocComment(), 1));

    // Print static variables if existant
    if ($statics = $func->getStaticVariables())
    {
        printf("---> Static variables: %s\n", var_export($statics, 1));
    }
}

// Create an instance of the ReflectionFunction class
dumpReflectionFunction(new ReflectionFunction('counter1'));
dumpReflectionFunction(new ReflectionFunction($counter2));
?>

以上例程的输出类似于：

===> The user-defined function 'counter1'
     declared in Z:\reflectcounter.php
     lines 7 to 11
---> Documentation:
 '/**
 * A simple counter
 *
 * @return    int
 */'
---> Static variables: array (
  'c' => 0,
)


===> The user-defined function '{closure}'
     declared in Z:\reflectcounter.php
     lines 18 to 23
---> Documentation:
 '/**
 * Another simple counter
 *
 * @return    int
 */'
---> Static variables: array (
  'd' => 0,
)

参见

ReflectionMethod::__construct
Constructors

ReflectionFunction::export

Exports function

Warning

本函数已自 PHP 7.4.0 起废弃。强烈建议不要使用本函数。

说明

public static string ReflectionFunction::export ( string $name [, string $return ] )

Exports a Reflected function.

参数

name
导出的反射。

return
设为 true 时返回导出结果，设为 false（默认值）则忽略返回。

返回值

如果参数 return 设为 true，导出结果将作为 string 返回，否则返回 null。

参见

ReflectionFunction::invoke
ReflectionFunction::__toString

ReflectionFunction::getClosure

Returns a dynamically created closure for the function

说明

public Closure ReflectionFunction::getClosure ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

Returns Closure. Returns null in case of an error.

ReflectionFunction::invoke

Invokes function

说明

public mixed ReflectionFunction::invoke ( mixed $args )

Invokes a reflected function.

参数

args
The passed in argument list. It accepts a variable number of arguments which are passed to the function much like call_user_func is.

返回值

Returns the result of the invoked function call.

范例

示例 #1 ReflectionFunction::invoke example

<?php
function title($title, $name)
{
    return sprintf("%s. %s\r\n", $title, $name);
}

$function = new ReflectionFunction('title');

echo $function->invoke('Dr', 'Phil');
?>

以上例程会输出：

Dr. Phil

注释

Note:

如果函数有参数需为引用，那么它们必须以引用方式传入。

参见

ReflectionFunction::export
__invoke()
call_user_func

ReflectionFunction::invokeArgs

Invokes function args

说明

public mixed ReflectionFunction::invokeArgs ( array $args )

Invokes the function and pass its arguments as array.

参数

args
The passed arguments to the function as an array, much like call_user_func_array works.

返回值

Returns the result of the invoked function

范例

示例 #1 ReflectionFunction::invokeArgs example

<?php
function title($title, $name)
{
    return sprintf("%s. %s\r\n", $title, $name);
}

$function = new ReflectionFunction('title');

echo $function->invokeArgs(array('Dr', 'Phil'));
?>

以上例程会输出：

Dr. Phil

示例 #2 ReflectionFunction::invokeArgs with references example

<?php
function get_false_conditions(array $conditions, array &$false_conditions)
{
    foreach ($conditions as $condition) {
        if (!$condition) {
            $false_conditions[] = $condition;
        }
    }
}

$function_ref     = new ReflectionFunction('get_false_conditions');

$conditions       = array(true, false, -1, 0, 1);
$false_conditions = array();

$function_ref->invokeArgs(array($conditions, &$false_conditions));

var_dump($false_conditions);
?>

以上例程会输出：

array(2) {
  [0]=>
  bool(false)
  [1]=>
  int(0)
}

注释

Note:

如果函数有参数需为引用，那么它们必须以引用方式传入。

参见

ReflectionFunction::invoke
ReflectionFunctionAbstract::getNumberOfParameters
__invoke()
call_user_func_array

ReflectionFunction::isDisabled

Checks if function is disabled

说明

public bool ReflectionFunction::isDisabled ( void )

Checks if the function is disabled, via the disable_functions directive.

参数

此函数没有参数。

返回值

true if it's disable, otherwise false

参见

ReflectionFunctionAbstract::isUserDefined
disable_functions directive

ReflectionFunction::__toString

To string

说明

public string ReflectionFunction::__toString ( void )

To string.

参数

此函数没有参数。

返回值

Returns ReflectionFunction::export-like output for the function.

范例

示例 #1 ReflectionFunction::__toString example

<?php
function title($title, $name)
{
    return sprintf("%s. %s\r\n", $title, $name);
}

echo new ReflectionFunction('title');
?>

以上例程的输出类似于：

Function [ <user> function title ] {
  @@ Command line code 1 - 1

  - Parameters [2] {
    Parameter #0 [ <required> $title ]
    Parameter #1 [ <required> $name ]
  }
}

参见

ReflectionFunction::export
ReflectionClass::clone
__toString()

简介

ReflectionFunction 的父类，详情请阅读它的描述。

类摘要

ReflectionFunctionAbstract

class ReflectionFunctionAbstract implements Reflector {

/* 属性 */

public $name ;

/* 方法 */

final private void __clone ( void )

public ReflectionClass getClosureScopeClass ( void )

public object getClosureThis ( void )

public string getDocComment ( void )

public int getEndLine ( void )

public ReflectionExtension getExtension ( void )

public string getExtensionName ( void )

public string getFileName ( void )

public string getName ( void )

public string getNamespaceName ( void )

public int getNumberOfParameters ( void )

public int getNumberOfRequiredParameters ( void )

public array getParameters ( void )

public ReflectionType getReturnType ( void )

public string getShortName ( void )

public int getStartLine ( void )

public array getStaticVariables ( void )

public bool hasReturnType ( void )

public bool inNamespace ( void )

public bool isClosure ( void )

public bool isDeprecated ( void )

public bool isGenerator ( void )

public bool isInternal ( void )

public bool isUserDefined ( void )

public bool isVariadic ( void )

public bool returnsReference ( void )

abstract public void __toString ( void )

}

属性

name
函数的名称。只读，尝试赋值的时候将会抛出 ReflectionException。

ReflectionFunctionAbstract::__clone

复制函数

说明

final private void ReflectionFunctionAbstract::__clone ( void )

复制函数

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

参见

Object cloning

ReflectionFunctionAbstract::getClosureScopeClass

Returns the scope associated to the closure

说明

public ReflectionClass ReflectionFunctionAbstract::getClosureScopeClass ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

Returns the class on success or null on failure.

ReflectionFunctionAbstract::getClosureThis

返回本身的匿名函数

说明

public object ReflectionFunctionAbstract::getClosureThis ( void )

Warning

此函数没有参数。

返回值

一组 ReflectionParameter 对象表示每一参数

参见

ReflectionFunctionAbstract::getNumberOfParameters
func_get_args

ReflectionFunctionAbstract::getReturnType

Gets the specified return type of a function

说明

public ReflectionType ReflectionFunctionAbstract::getReturnType ( void )

Gets the specified return type of a reflected function.

参数

此函数没有参数。

返回值

Returns a ReflectionType object if a return type is specified, null otherwise.

范例

示例 #1 ReflectionFunctionAbstract::getReturnType example

<?php

function to_int($param) : int {
    return (int) $param;
}

$reflection1 = new ReflectionFunction('to_int');
echo $reflection1->getReturnType();

以上例程会输出：

int

示例 #2 Usage on built-in functions

<?php

$reflection2 = new ReflectionFunction('array_merge');

var_dump($reflection2->getReturnType());

以上例程会输出：

null

This is because many internal functions do not have types specified for their parameters or return values. It is therefore best to avoid using this method on built-in functions.

参见

ReflectionFunctionAbstract::hasReturnType
ReflectionType::__toString

ReflectionFunctionAbstract::getShortName

获取函数短名称

说明

public string ReflectionFunctionAbstract::getShortName ( void )

获取函数的段名称 (没有命名空间定义)

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

函数短名称

参见

ReflectionFunctionAbstract::getNamespaceName
namespaces

ReflectionFunctionAbstract::getStartLine

获取开始行号

说明

public int ReflectionFunctionAbstract::getStartLine ( void )

获取函数定义的开始行号

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

开始行号

参见

ReflectionFunctionAbstract::getEndLine

ReflectionFunctionAbstract::getStaticVariables

获取静态变量

说明

public array ReflectionFunctionAbstract::getStaticVariables ( void )

获取静态变量

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

返回一个静态变量的 array

参见

ReflectionFunctionAbstract::getParameters

ReflectionFunctionAbstract::hasReturnType

Checks if the function has a specified return type

说明

public bool ReflectionFunctionAbstract::hasReturnType ( void )

Checks whether the reflected function has a return type specified.

参数

此函数没有参数。

返回值

Returns true if the function is a specified return type, otherwise false.

范例

示例 #1 ReflectionFunctionAbstract::hasReturnType example

<?php

function to_int($param) : int {
    return (int) $param;
}

$reflection1 = new ReflectionFunction('to_int');
var_dump($reflection1->hasReturnType());

以上例程会输出：

bool(true)

示例 #2 Usage on built-in functions

<?php

$reflection2 = new ReflectionFunction('array_merge');

var_dump($reflection2->hasReturnType());

以上例程会输出：

bool(false)

This is because many internal functions do not have types specified for their parameters or return values. It is therefore best to avoid using this method on built-in functions.

参见

ReflectionFunctionAbstract::getReturnType

ReflectionFunctionAbstract::inNamespace

检查是否处于命名空间

说明

public bool ReflectionFunctionAbstract::inNamespace ( void )

检查函数是否在命名空间内定义

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

在命名空间内返回 true，否则返回 false

参见

ReflectionFunctionAbstract::getNamespaceName
namespaces

ReflectionFunctionAbstract::isClosure

检查是否是匿名函数

说明

public bool ReflectionFunctionAbstract::isClosure ( void )

检查是否是匿名函数

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

匿名函数返回 true，否则返回 false

参见

ReflectionFunctionAbstract::

ReflectionFunctionAbstract::isDeprecated

检查是否已经弃用

说明

public bool ReflectionFunctionAbstract::isDeprecated ( void )

检查函数是否已经被弃用

参数

此函数没有参数。

返回值

弃用返回 true，否则返回 false

范例

示例 #1 ReflectionFunctionAbstract::isDeprecated example

<?php
$rf = new ReflectionFunction('ereg');
var_dump($rf->isDeprecated());
?>

以上例程会输出：

bool(true)

参见

ReflectionFunctionAbstract::getDocComment

ReflectionFunctionAbstract::isGenerator

判断函数是否是一个生成器函数

说明

public bool ReflectionFunctionAbstract::isGenerator ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

生成器函数返回 true，否则返回 false on failure.

ReflectionFunctionAbstract::isInternal

判断函数是否是内置函数

说明

public bool ReflectionFunctionAbstract::isInternal ( void )

判断函数是否是内置函数，与用户自定义函数相反

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

内置函数返回 true，否则返回 false

参见

ReflectionFunctionAbstract::isUserDefined

ReflectionFunctionAbstract::isUserDefined

检查是否是用户定义

说明

public bool ReflectionFunctionAbstract::isUserDefined ( void )

检查函数是否是用户自定义，也就是说不是 PHP 自己内置函数

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

用户自定义函数返回 true，否则返回 false

参见

ReflectionFunctionAbstract::isInternal

ReflectionFunctionAbstract::isVariadic

Checks if the function is variadic

说明

public bool ReflectionFunctionAbstract::isVariadic ( void )

Checks if the function is variadic.

参数

此函数没有参数。

返回值

Returns true if the function is variadic, otherwise false.

ReflectionFunctionAbstract::returnsReference

检查是否返回参考信息

说明

public bool ReflectionFunctionAbstract::returnsReference ( void )

检查是否返回参考信息

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

返回参考信息返回 true，否则返回 false

参见

ReflectionFunctionAbstract::isClosure

ReflectionFunctionAbstract::__toString

字符串化

说明

abstract public void ReflectionFunctionAbstract::__toString ( void )

To string.

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

The string.

参见

ReflectionClass::clone
__toString()

简介

ReflectionMethod 类报告了一个方法的有关信息。

类摘要

ReflectionMethod

class ReflectionMethod extends ReflectionFunctionAbstract implements Reflector {

/* 常量 */

const integer ReflectionMethod::IS_STATIC = 1 ;

const integer ReflectionMethod::IS_PUBLIC = 256 ;

const integer ReflectionMethod::IS_PROTECTED = 512 ;

const integer ReflectionMethod::IS_PRIVATE = 1024 ;

const integer ReflectionMethod::IS_ABSTRACT = 2 ;

const integer ReflectionMethod::IS_FINAL = 4 ;

/* 属性 */

public $name ;

public $class ;

/* 方法 */

public __construct ( mixed $class , string $name )

public static string export ( string $class , string $name [, bool $return = false ] )

public Closure getClosure ( object $object )

public ReflectionClass getDeclaringClass ( void )

public int getModifiers ( void )

public ReflectionMethod getPrototype ( void )

public mixed invoke ( object $object [, mixed $parameter [, mixed $... ]] )

public mixed invokeArgs ( object $object , array $args )

public bool isAbstract ( void )

public bool isConstructor ( void )

public bool isDestructor ( void )

public bool isFinal ( void )

public bool isPrivate ( void )

public bool isProtected ( void )

public bool isPublic ( void )

public bool isStatic ( void )

public void setAccessible ( bool $accessible )