PHP反射ReflectionClass、ReflectionMethod 學習筆記 （一）

標籤：

PHP5 具有完整的反射API，添加對類、介面、函數、方法和擴充進行反向工程的能力。

反射是什嗎？

它是指在PHP運行狀態中，擴充分析PHP程式，匯出或提取出關於類、方法、屬性、參數等的詳細資料，包括注釋。這種動態擷取的資訊以及動態調用對 象的方法的功能稱為反射API。反射是操縱物件導向範型中元模型的API，其功能十分強大，可協助我們構建複雜，可擴充的應用。

其用途如：自動載入外掛程式，自動產生文檔，甚至可用來擴充PHP語言。

PHP反射api由若干類組成，可協助我們用來訪問程式的中繼資料或者同相關的注釋互動。藉助反射我們可以擷取諸如類實現了那些方法，建立一個類的執行個體（不同於用new建立），調用一個方法（也不同於常規調用），傳遞參數，動態調用類的靜態方法。

反射api是PHP內建的OOP技術擴充，包括一些類，異常和介面，綜合使用他們可用來協助我們分析其它類，介面，方法，屬性，方法和擴充。這些OOP擴充被稱為反射。

 

平常我們用的比較多的是 ReflectionClass類 和 ReflectionMethod類，例如：

01    <?php02    class Person {03     04        /**05         * For the sake of demonstration, we"re setting this private06         */07        private $_allowDynamicAttributes = false;08     09        /**10         * type=primary_autoincrement11         */12        protected $id = 0;13     14        /**15         * type=varchar length=255 null16         */17        protected $name;18     19        /**20         * type=text null21         */22        protected $biography;23     24        public function getId() {25            return $this->id;26        }27     28        public function setId($v) {29            $this->id = $v;30        }31     32        public function getName() {33            return $this->name;34        }35     36        public function setName($v) {37            $this->name = $v;38        }39     40        public function getBiography() {41            return $this->biography;42        }43     44        public function setBiography($v) {45            $this->biography = $v;46        }47    }

一、通過ReflectionClass，我們可以得到Person類的以下資訊：

1. 常量 Contants
2. 屬性 Property Names
3. 方法 Method Names靜態
4. 屬性 Static Properties
5. 命名空間 Namespace
6. Person類是否為final或者abstract
7. Person類是否有某個方法

接下來反射它，只要把類名"Person"傳遞給ReflectionClass就可以了：

1    $class = new ReflectionClass(‘Person‘); // 建立 Person這個類的反射類 2    $instance  = $class->newInstanceArgs($args); // 相當於執行個體化Person 類

1）擷取屬性(Properties)：

1    $properties = $class->getProperties();2    foreach ($properties as $property) {3        echo $property->getName() . "\n";4    }5    // 輸出:6    // _allowDynamicAttributes7    // id8    // name9    // biography

預設情況下，ReflectionClass會擷取到所有的屬性，private 和 protected的也可以。如果只想擷取到private屬性，就要額外傳個參數：

1    $private_properties = $class->getProperties(ReflectionProperty::IS_PRIVATE);

可用參數列表：

• ReflectionProperty::IS_STATIC
• ReflectionProperty::IS_PUBLIC
• ReflectionProperty::IS_PROTECTED
• ReflectionProperty::IS_PRIVATE

通過$property->getName()可以得到屬性名稱。

 

2）擷取注釋：

通過getDocComment可以得到寫給property的注釋。 

01    foreach ($properties as $property) {02        if ($property->isProtected()) {03            $docblock = $property->getDocComment();04            preg_match(‘/ type\=([a-z_]*) /‘, $property->getDocComment(), $matches);05            echo $matches[1] . "\n";06        }07    }08    // Output:09    // primary_autoincrement10    // varchar11    // text

3）擷取類的方法

• getMethods()       來擷取到類的所有methods。
• hasMethod(string)  是否存在某個方法
• getMethod(string)  擷取方法

 

4）執行類的方法：

1    $instance->getName(); // 執行Person 裡的方法getName2    // 或者：3    $method = $class->getmethod(‘getName‘);  // 擷取Person 類中的getName方法4    $method->invoke($instance);              // 執行getName 方法5    // 或者：6    $method = $class->getmethod(‘setName‘);  // 擷取Person 類中的setName方法7    $method->invokeArgs($instance, array(‘snsgou.com‘));

二、通過ReflectionMethod，我們可以得到Person類的某個方法的資訊：

1. 是否“public”、“protected”、“private” 、“static”類型
2. 方法的參數列表
3. 方法的參數個數
4. 反調用類的方法

5. 1    // 執行detail方法2    $method = new ReflectionMethod(‘Person‘, ‘test‘);3     4    if ($method->isPublic() && !$method->isStatic()) {5        echo ‘Action is right‘;6    }7    echo $method->getNumberOfParameters(); // 參數個數8    echo $method->getParameters(); // 參數對象數組

    

PHP反射ReflectionClass、ReflectionMethod 學習筆記 （一）