How to use php to reflect API to obtain class information

PHP has a complete reflection API that can reverse engineer classes, interfaces, functions, methods and extensions. Reflection API and provides methods to extract documentation comments in functions, classes and methods. This article will introduce the method of using PHP reflection API to obtain class information and provide complete demonstration code.

PHP reflection API document address: http://php.net/manual/zh/class.reflectionclass.php

UseReflectionClassGet the attributes, interfaces, methods and other information of the class

1. Get the basic information of the class

$ref = new ReflectionClass($classname);echo $ref->getName();echo $ref->getFileName();

2. Get the class attribute information

$ref = new ReflectionClass($classname);$properties = $ref->getProperties();foreach($properties as $property){    echo $property->getName();
}

3.Get Class method information

$ref = new ReflectionClass($classname);$methods = $ref->getMethods();foreach($methods as $method){    echo $method->getName();
}

4. Get class interface information

$ref = new ReflectionClass($classname);$interfaces = $ref->getInterfaces();foreach($interfaces as $interface){    echo $interface->getName();
}

Demo code

Create IUser interface, User class, Vip class for reading

User.class.php

<?php/** 用户接口 */interface IUser{    // 新增用户
    public function add($data);    // 读取用户数据
    public function get($id);

}/** 用户类 */class User implements IUser{    /** 
      * 用户数据
      */
    protected $user = array();    /**
     * 新增用户
     * @param  Array $data 用户数据
     * @return Int
     */
    public function add($data){
        $this->user[] = $data;
        $keys = array_keys($this->user);        return end($keys);
    }    /**
     * 读取用户数据
     * @param  Int    $id 用户id
     * @return Array
     */
    public function get($id){        if(isset($this->user[$id])){            return $this->user[$id];
        }else{            return array();
        }
    }

}/** VIP用户类 */class Vip extends User{    /**
     * 读取vip用户数据
     * @param  Int    $id 用户id
     * @return Array
     */
    public function getvip($id){
        $data = $this->get($id);        if($data){            return $this->format($data);
        }        return $data;
    }    /**
     * 修饰数据
     * @param  Array $data 用户数据
     * @return Array
     */
    private function format($data){
        $data[&#39;is_vip&#39;] = 1;        return $data;
    }
}
?>

Create a Ref class and call the PHP reflection class to obtain class information

##Ref.class .php

<?php/**
 * 调用PHP反射类获取类信息
 * Date:    2017-05-24
 * Author:  fdipzone
 * Ver:     1.0
 *
 * Func
 * public static setClass       设置反射类
 * public static getBase        读取类基本信息
 * public static getInterfaces  读取类接口
 * public static getProperties  读取类属性
 * public static getMethods     读取类方法
 */class Ref{

    private static $refclass = null;    // 设置反射类
    public static function setClass($classname){
        self::$refclass = new ReflectionClass($classname);
    }    // 读取类基本信息
    public static function getBase(){
        echo &#39;<strong>BASE INFO</strong>&#39;.PHP_EOL;        echo &#39;class name: &#39;.self::$refclass->getName().PHP_EOL;        echo &#39;class path: &#39;.dirname(self::$refclass->getFileName()).PHP_EOL;        echo &#39;class filename: &#39;.basename(self::$refclass->getFileName()).PHP_EOL.PHP_EOL;
    }    // 读取类接口
    public static function getInterfaces(){
        echo &#39;<strong>INTERFACES INFO</strong>&#39;.PHP_EOL;        $interfaces = self::$refclass->getInterfaces();        if($interfaces){            foreach($interfaces as $interface){                echo &#39;interface name: &#39;.$interface->getName().PHP_EOL;
            }
        }
    }    // 读取类属性
    public static function getProperties(){
        echo &#39;<strong>PROPERTIES INFO</strong>&#39;.PHP_EOL;        $properties = self::$refclass->getProperties();        if($properties){            foreach($properties as $property){                echo &#39;property name: &#39;.$property->getName().PHP_EOL;                echo &#39;property modifier: &#39;.self::getModifier($property).PHP_EOL;                echo &#39;property comments: &#39;.self::formatComment($property->getDocComment()).PHP_EOL.PHP_EOL;
            }
        }
    }    // 读取类方法
    public static function getMethods(){
        echo &#39;<strong>METHODS INFO</strong>&#39;.PHP_EOL;        $methods = self::$refclass->getMethods();        if($methods){            foreach($methods as $method){                echo &#39;method name: &#39;.$method->getName().PHP_EOL;                echo &#39;method modifier: &#39;.self::getModifier($method).PHP_EOL;                echo &#39;method params num: &#39;.$method->getNumberOfParameters().PHP_EOL;                $params = $method->getParameters();                if($params){                    foreach($params as $param){                        echo &#39;param name:&#39;.$param->getName().PHP_EOL;
                    }
                }                echo &#39;method comments: &#39;.self::formatComment($method->getDocComment()).PHP_EOL.PHP_EOL;
            }
        }
    }    // 获取修饰符
    private static function getModifier($o){
        // public
        if($o->isPublic()){            return &#39;public&#39;;
        }        // protected
        if($o->isProtected()){            return &#39;protected&#39;;
        }        // private
        if($o->isPrivate()){            return &#39;private&#39;;
        }        return &#39;&#39;;
    }    // 格式化注释内容
    private static function formatComment($comment){
        $doc = explode(PHP_EOL, $comment);        return isset($doc[1])? trim(str_replace(&#39;*&#39;,&#39;&#39;,$doc[1])) : &#39;&#39;;
    }

}?>

<?phprequire &#39;Ref.class.php&#39;;require &#39;User.class.php&#39;;

echo &#39;<pre class="brush:php;toolbar:false">&#39;;
Ref::setClass(&#39;Vip&#39;);
Ref::getBase();
Ref::getProperties();
Ref::getMethods();
Ref::getInterfaces();
echo &#39;

';?>

BASE INFOclass name: Vipclass path: /home/fdipzone/refclass filename: User.class.php

PROPERTIES INFOproperty name: userproperty modifier: protectedproperty comments: 用户数据

METHODS INFOmethod name: getvipmethod modifier: publicmethod params num: 1param name:idmethod comments: 读取vip用户数据method name: formatmethod modifier: privatemethod params num: 1param name:datamethod comments: 修饰数据method name: addmethod modifier: publicmethod params num: 1param name:datamethod comments: 新增用户method name: getmethod modifier: publicmethod params num: 1param name:idmethod comments: 读取用户数据

INTERFACES INFOinterface name: IUser

Detailed explanation of the reasons and optimization methods for excessive offset affecting performance when querying mysql

About using regular rules in PHP Methods to remove width and height styles

Detailed explanation of file content deduplication and sorting

The above is the detailed content of How to use php to reflect API to obtain class information. For more information, please follow other related articles on the PHP Chinese website!