PHP Reflection API详解


Posted in PHP onMay 12, 2015

PHP Reflection API是PHP5才有的新功能,它是用来导出或提取出关于类、方法、属性、参数等的详细信息,包括注释。

PHP Reflection API有:

class Reflection { }
interface Reflector { }
class ReflectionException extends Exception { }
class ReflectionFunction implements Reflector { }
class ReflectionParameter implements Reflector { }
class ReflectionMethod extends ReflectionFunction { }
class ReflectionClass implements Reflector { }
class ReflectionObject extends ReflectionClass { }
class ReflectionProperty implements Reflector { }
class ReflectionExtension implements Reflector { }

具体API说明:

①Reflection类

<?php
class Reflection
{
  public static mixed export(Reflector r [,bool return])
  //导出一个类或方法的详细信息
  public static array getModifierNames(int modifiers)
  //取得修饰符的名字
}
?>

②ReflectionException类

该类继承标准类,没特殊方法和属性。

③ReflectionFunction类

<?php
class ReflectionFunction implements Reflector
{
  final private __clone()
  public object __construct(string name)
  public string __toString()
  public static string export()
  //导出该函数的详细信息
  public string getName()
  //取得函数名
  public bool isInternal()
  //测试是否为系统内部函数
  public bool isUserDefined()
  //测试是否为用户自定义函数
  public string getFileName()
  //取得文件名,包括路径名
  public int getStartLine()
  //取得定义函数的起始行
  public int getEndLine()
  //取得定义函数的结束行
  public string getDocComment()
  //取得函数的注释
  public array getStaticVariables()
  //取得静态变量
  public mixed invoke(mixed* args)
  //调用该函数,通过参数列表传参数
  public mixed invokeArgs(array args)
  //调用该函数,通过数组传参数
  public bool returnsReference()
  //测试该函数是否返回引用
  public ReflectionParameter[] getParameters()
  //取得该方法所需的参数,返回值为对象数组
  public int getNumberOfParameters()
  //取得该方法所需的参数个数
  public int getNumberOfRequiredParameters()
  //取得该方法所需的参数个数
}
?>

④ReflectionParameter类:

<?php
class ReflectionParameter implements Reflector
{
  final private __clone()
  public object __construct(string name)
  public string __toString()
  public static string export()
  //导出该参数的详细信息
  public string getName()
  //取得参数名
  public bool isPassedByReference()
  //测试该参数是否通过引用传递参数
  public ReflectionClass getClass()
  //若该参数为对象,返回该对象的类名
  public bool isArray()
  //测试该参数是否为数组类型
  public bool allowsNull()
  //测试该参数是否允许为空
  public bool isOptional()
  //测试该参数是否为可选的,当有默认参数时可选
  public bool isDefaultValueAvailable()
  //测试该参数是否为默认参数
  public mixed getDefaultValue()
  //取得该参数的默认值
}
?>

⑤ReflectionClass类:

<?php
class ReflectionClass implements Reflector
{
  final private __clone()
  public object __construct(string name)
  public string __toString()
  public static string export()
  //导出该类的详细信息
  public string getName()
  //取得类名或接口名
  public bool isInternal()
  //测试该类是否为系统内部类
  public bool isUserDefined()
  //测试该类是否为用户自定义类
  public bool isInstantiable()
  //测试该类是否被实例化过
  public bool hasConstant(string name)
  //测试该类是否有特定的常量
  public bool hasMethod(string name)
  //测试该类是否有特定的方法
  public bool hasProperty(string name)
  //测试该类是否有特定的属性
  public string getFileName()
  //取得定义该类的文件名,包括路径名
  public int getStartLine()
  //取得定义该类的开始行
  public int getEndLine()
  //取得定义该类的结束行
  public string getDocComment()
  //取得该类的注释
  public ReflectionMethod getConstructor()
  //取得该类的构造函数信息
  public ReflectionMethod getMethod(string name)
  //取得该类的某个特定的方法信息
  public ReflectionMethod[] getMethods()
  //取得该类的所有的方法信息
  public ReflectionProperty getProperty(string name)
  //取得某个特定的属性信息
  public ReflectionProperty[] getProperties()
  //取得该类的所有属性信息
  public array getConstants()
  //取得该类所有常量信息
  public mixed getConstant(string name)
  //取得该类特定常量信息
  public ReflectionClass[] getInterfaces()
  //取得接口类信息
  public bool isInterface()
  //测试该类是否为接口
  public bool isAbstract()
  //测试该类是否为抽象类
  public bool isFinal()
  //测试该类是否声明为final
  public int getModifiers()
  //取得该类的修饰符,返回值类型可能是个资源类型
  //通过Reflection::getModifierNames($class->getModifiers())进一步读取
  public bool isInstance(stdclass object)
  //测试传入的对象是否为该类的一个实例
  public stdclass newInstance(mixed* args)
  //创建该类实例
  public ReflectionClass getParentClass()
  //取得父类
  public bool isSubclassOf(ReflectionClass class)
  //测试传入的类是否为该类的父类
  public array getStaticProperties()
  //取得该类的所有静态属性
  public mixed getStaticPropertyValue(string name [, mixed default])
  //取得该类的静态属性值,若private,则不可访问
  public void setStaticPropertyValue(string name, mixed value)
  //设置该类的静态属性值,若private,则不可访问,有悖封装原则
  public array getDefaultProperties()
  //取得该类的属性信息,不含静态属性
  public bool isIterateable()
  public bool implementsInterface(string name)
  //测试是否实现了某个特定接口
  public ReflectionExtension getExtension()
  public string getExtensionName()
}
?>

⑥ReflectionMethod类:

<?php
class ReflectionMethod extends ReflectionFunction
{
  public __construct(mixed class, string name)
  public string __toString()
  public static string export()
  //导出该方法的信息
  public mixed invoke(stdclass object, mixed* args)
  //调用该方法
  public mixed invokeArgs(stdclass object, array args)
  //调用该方法,传多参数
  public bool isFinal()
  //测试该方法是否为final
  public bool isAbstract()
  //测试该方法是否为abstract
  public bool isPublic()
  //测试该方法是否为public
  public bool isPrivate()
  //测试该方法是否为private
  public bool isProtected()
  //测试该方法是否为protected
  public bool isStatic()
  //测试该方法是否为static
  public bool isConstructor()
  //测试该方法是否为构造函数
  public bool isDestructor()
  //测试该方法是否为析构函数
  public int getModifiers()
  //取得该方法的修饰符
  public ReflectionClass getDeclaringClass()
  //取得该方法所属的类
  // Inherited from ReflectionFunction
  final private __clone()
  public string getName()
  public bool isInternal()
  public bool isUserDefined()
  public string getFileName()
  public int getStartLine()
  public int getEndLine()
  public string getDocComment()
  public array getStaticVariables()
  public bool returnsReference()
  public ReflectionParameter[] getParameters()
  public int getNumberOfParameters()
  public int getNumberOfRequiredParameters()
}
?>

⑦ReflectionProperty类:

<?php
class ReflectionProperty implements Reflector
{
  final private __clone()
  public __construct(mixed class, string name)
  public string __toString()
  public static string export()
  //导出该属性的详细信息
  public string getName()
  //取得该属性名
  public bool isPublic()
  //测试该属性名是否为public
  public bool isPrivate()
  //测试该属性名是否为private
  public bool isProtected()
  //测试该属性名是否为protected
  public bool isStatic()
  //测试该属性名是否为static
  public bool isDefault()
  public int getModifiers()
  //取得修饰符
  public mixed getValue(stdclass object)
  //取得该属性值
  public void setValue(stdclass object, mixed value)
  //设置该属性值
  public ReflectionClass getDeclaringClass()
  //取得定义该属性的类
  public string getDocComment()
  //取得该属性的注释
}
?>

⑧ReflectionExtension类

<?php
class ReflectionExtension implements Reflector {
  final private __clone()
  public __construct(string name)
  public string __toString()
  public static string export()
  //导出该扩展的所有信息
  public string getName()
  //取得该扩展的名字
  public string getVersion()
  //取得该扩展的版本
  public ReflectionFunction[] getFunctions()
  //取得该扩展的所有函数
  public array getConstants()
  //取得该扩展的所有常量
  public array getINIEntries()
  //取得与该扩展相关的,在php.ini中的指令信息
  public ReflectionClass[] getClasses()
  public array getClassNames()
}

?>

使用例子:

<?php
class Person{
 private $_name;
 
 public $age;
 
 public function __construct(){
 $this->sex = "male";
 }
 
 public function action(){
 echo "来自https://3water.com的测试";
 }
}
 
$class = new ReflectionClass('Person');
//获取属性
foreach($class->getProperties() as $property) {
  echo $property->getName()."\n";
}
//获取方法
print_r($class->getMethods());
 
$p1 = new Person();
$obj = new ReflectionObject($p1);
 
//获取对象和类的属性
print_r($obj->getProperties());

很明显上面代码中对象和类获取的属性是不同的,这是因为对象进行了contruct实例化,因此多了sex属性,PHP Reflection确实能够获取很多有用的信息。

PHP 相关文章推荐
PHP 编写的 25个游戏脚本
May 11 PHP
深入探讨:Nginx 502 Bad Gateway错误的解决方法
Jun 03 PHP
php+ajax实现图片文件上传功能实例
Jun 17 PHP
可以保证单词完整性的PHP英文字符串截取代码分享
Jul 15 PHP
学习php设计模式 php实现策略模式(strategy)
Dec 07 PHP
前端必学之PHP语法基础
Jan 01 PHP
PHP Yaf框架的简单安装使用教程(推荐)
Jun 08 PHP
PHP图形计数器程序显示网站用户浏览量
Jul 20 PHP
php、java、android、ios通用的3des方法(推荐)
Sep 09 PHP
thinkPHP商城公告功能开发问题分析
Dec 01 PHP
php使用PDO执行SQL语句的方法分析
Feb 16 PHP
ThinkPHP5与单元测试PHPUnit使用详解
Feb 23 PHP
php通过curl模拟登陆DZ论坛
May 11 #PHP
PHP中的魔术方法总结和使用实例
May 11 #PHP
php基于curl扩展制作跨平台的restfule 接口
May 11 #PHP
PHP SPL标准库中的常用函数介绍
May 11 #PHP
PHP中的类型约束介绍
May 11 #PHP
PHP SPL标准库之接口(Interface)详解
May 11 #PHP
PHP SPL标准库之文件操作(SplFileInfo和SplFileObject)实例
May 11 #PHP
You might like
玩转虚拟域名◎+ .
2006/10/09 PHP
Dedecms V3.1 生成HTML速度的优化办法
2007/03/18 PHP
Zend的Registry机制的使用说明
2013/05/02 PHP
PHP的preg_match匹配字符串长度问题解决方法
2014/05/03 PHP
完整删除ecshop中获取店铺信息的API
2014/12/24 PHP
php中注册器模式类用法实例分析
2015/11/03 PHP
PHP使用星号替代用户名手机和邮箱的实现代码
2018/02/07 PHP
php+Ajax处理xml与json格式数据的方法示例
2019/03/04 PHP
Yii框架的redis命令使用方法简单示例
2019/10/15 PHP
SUN的《AJAX与J2EE》全文译了
2007/02/23 Javascript
防止xss和sql注入:JS特殊字符过滤正则
2013/04/18 Javascript
js获取GridView中行数据的两种方法 分享
2013/07/13 Javascript
浅谈javascript 函数属性和方法
2015/01/21 Javascript
jQuery Form 表单提交插件之formSerialize,fieldSerialize,fieldValue,resetForm,clearForm,clearFields的应用
2016/01/23 Javascript
JS和jQuery使用submit方法无法提交表单的原因分析及解决办法
2016/05/17 Javascript
AngularJS中一般函数参数传递用法分析
2016/11/22 Javascript
微信小程序canvas拖拽、截图组件功能
2018/09/04 Javascript
M2实现Nodejs项目自动部署的方法步骤
2019/05/05 NodeJs
关于JavaScript中异步/等待的用法与理解
2020/11/18 Javascript
React中使用Vditor自定义图片详解
2020/12/25 Javascript
[01:10:49]Secret vs VGJ.S 2018国际邀请赛淘汰赛BO3 第二场 8.24
2018/08/25 DOTA
Python3基础之输入和输出实例分析
2014/08/18 Python
Django中数据库的数据关系:一对一,一对多,多对多
2018/10/21 Python
python爬取抖音视频的实例分析
2021/01/19 Python
HTML5制作酷炫音频播放器插件图文教程
2014/12/30 HTML / CSS
Uber Eats台湾:寻找附近提供送餐服务的餐厅
2018/05/07 全球购物
英国儿童鞋和靴子:Start-Rite
2019/05/06 全球购物
统计每一学生的平均成绩
2014/06/06 面试题
座谈会主持词
2014/03/20 职场文书
村干部培训班主持词
2014/03/28 职场文书
企业宣传工作方案
2014/06/02 职场文书
承诺函范文
2015/01/21 职场文书
博物馆观后感
2015/06/05 职场文书
2015年终个人政治思想工作总结
2015/11/24 职场文书
再见,2019我们不负使命;你好,2020我们砥砺前行
2020/01/03 职场文书
php解析非标准json、非规范json的方式实例
2022/05/10 PHP