Интроспекция и отражение в PHP

Источник: ruseller

Сергей Фастунов

В данном уроке описывается использование функции интроспекции в PHP и Reflection API для получения информации о классах, интерфейсах, свойствах и методах. Такие действия нужны для составления полной картины о коде в момент выполнения и создания сложных приложений.

Интроспекция является общим свойством для любого языка программирования, который позволяет программисту манипулировать объектами классов. Она очень полезна в тех случаях, когда во время разработки неизвестно, какой класс или метод нужно использовать.

Интроспекция в PHP позволяет проверить классы, интерфейсы, методы и свойства. В PHP имеется большое количество функций, которые можно использовать для решения таких задач. Мы представим краткий обзор некоторых классов, методов и функций PHP с примерами их использования. Также в уроке будет представлен API, который имеет функционал очень близкий к интроспекции - Reflection API.

Функции интроспекции PHP

В первом примере демонстрируются полезные функции интроспекции PHP. Их можно использовать для получения основной информации о классе - имя, имя родительского класса и так далее.

class_exists() - проверяет определение класса
get_class() - возвращает имя класса объекта
get_parent_class() - возвращает имя родительского класса объекта
is_subclass_of() - проверяет, имеется ли в родителях объекта заданный класс

Пример кода PHP? который содержит определение для классов Introspection и Child, а также выводит информацию, полученную с помощью перечисленных выше функций:

01 <?php

`02`	`class` `Introspection`

03 {

`04`	`public` `function` `description() {`

`05`	`echo` `"Я супер класс для класса Child.\n";`

06 }

07 }

08

`09`	`class` `Child` `extends` `Introspection`

10 {

`11`	`public` `function` `description() {`

`12`	`echo` `"Я класс "` `. get_class($this) ,` `".\n";`

`13`	`echo` `"Я потомок класса "` `. get_parent_class($this) ,` `".\n";`

14 }

15 }

16

`17`	`if` `(class_exists("Introspection")) {`

`18`	`$introspection` `=` `new` `Introspection();`

`19`	`echo` `"Имя класса : "` `. get_class($introspection) .` `"\n";`

`20`	`$introspection->description();`

21 }

22

`23`	`if` `(class_exists("Child")) {`

`24`	`$child` `=` `new` `Child();`

`25`	`$child->description();`

26

`27`	`if` `(is_subclass_of($child,` `"Introspection")) {`

`28`	`echo` `"Да, "` `. get_class($child) .` `" является подклассом Introspection.\n";`

29 }

`30`	`else` `{`

`31`	`echo` `"Нет, "` `. get_class($child) .` `" не является подклассом Introspection.\n";`

32 }

33 }

Выше приведенный код выведет:

`1`	`Имя класса: Introspection`

`2`	`Я супер класс для класса Child.`

`3`	`Я класс Child.`

`4`	`Я потомок класса Introspection.`

`5`	`Да, Child является подклассом Introspection.`

Вы можете определить, будет или нет определяться класс с помощью метода class_exists(), который получает в качестве аргумента строку с именем проверяемого класса и опциональное логическое значение, которое определяет автоматическую загрузку.

Методы get_class() и get_parent_class() возвращают имя класса объекта или его родителя соответственно. Оба метода принимают в качестве аргумента объекты.

Метод is_subclass_of() получает объект и строку, в которой содержится имя родительского класса, а возвращает логическое значение результата проверки принадлежности объекта родительскому классу.

Во втором примере определяется интерфейс ICurrencyConverter и классGBPCurrencyConverter и выводится информация с помощью ниже перечисленных функций.

get_declared_classes() - возвращает список всех объявленных классов
get_class_methods() - возвращает имена методов класса
get_class_vars() - возвращает свойства класса
interface_exists() - проверяет, определен или нет интерфейс
method_exists() - проверяет, определен или нет метод

01 <?php

`02`	`interface` `ICurrencyConverter`

03 {

`04`	`public` `function` `convert($currency,` `$amount);`

05 }

06

`07`	`class` `GBPCurrencyConverter` `implements` `ICurrencyConverter`

08 {

`09`	`public` `$name` `=` `"GBPCurrencyConverter";`

`10`	`public` `$rates` `=` `array("USD"` `=> 0.622846,`

`11`	`"AUD"` `=> 0.643478);`

`12`	`protected` `$var1;`

`13`	`private` `$var2;`

14

`15`	`function` `__construct() {}`

16

`17`	`function` `convert($currency,` `$amount) {`

`18`	`return` `$rates[$currency] *` `$amount;`

19 }

20 }

21

`22`	`if` `(interface_exists("ICurrencyConverter")) {`

`23`	`echo` `"Интерфейс ICurrencyConverter определен.\n";`

24 }

25

`26`	`$classes` `= get_declared_classes();`

`27`	`echo` `"Доступны следующие классы:\n";`

`28`	`print_r($classes);`

29

`30`	`if` `(in_array("GBPCurrencyConverter",` `$classes)) {`

`31`	`print` `"Определен класс GBPCurrencyConverter.\n";`

32

`33`	`$gbpConverter` `=` `new` `GBPCurrencyConverter();`

34

`35`	`$methods` `= get_class_methods($gbpConverter);`

`36`	`echo` `"Доступны следующие методы:\n";`

`37`	`print_r($methods);`

38

`39`	`$vars` `= get_class_vars("GBPCurrencyConverter");`

`40`	`echo` `"Доступны следующие свойства:\n";`

`41`	`print_r($vars);`

42

`43`	`echo` `"Метод convert() есть в классе GBPCurrencyConverter: ";`

`44`	`var_dump(method_exists($gbpConverter,` `"convert"));`

45 }

Код выдаст результат:

`01`	`Интерфейс ICurrencyConverter определен.`

`02`	`Доступны следующие классы:`

03 Array

04 (

`05`	`[0] => stdClass`

`06`	`[1] => Exception`

`07`	`[2] => ErrorException`

`08`	`[3] => Closure`

`09`	`[4] => DateTime`

`10`	`[5] => DateTimeZone`

`11`	`[6] => DateInterval`

`12`	`[7] => DatePeriod`

13 ...

`14`	`[154] => GBPCurrencyConverter`

15 )

`16`	`Определен класс GBPCurrencyConverter.`

`17`	`Доступны следующие методы:`

18 Array

19 (

`20`	`[0] => __construct`

`21`	`[1] => convert`

22 )

`23`	`Доступны следующие свойства:`

24 Array

25 (

`26`	`[name] => GBPCurrencyConverter`

`27`	`[rates] => Array`

28 (

`29`	`[USD] => 0.622846`

`30`	`[AUD] => 0.643478`

31 )

32 )

`33`	`Метод convert() есть в классе GBPCurrencyConverter: bool(true)`

Метод interface_exists() очень похож на метод class_exists(), который обсуждался ранее. Он проверяет, определен или нет заданный интерфейс. В качестве параметров он получает имя интерфейса и логическую переменную для автозазгрузки (опционально).

Метод get_declared_classes() возвращает массив имен всех определенных классов. В зависимости от загруженных библиотек результат может быть разным.

Метод get_class_method() получает экземпляр объекта или строку с именем нужного класса в качестве аргумента, а возвращает массив имен методов, которые определены в классе.

Обратите внимание на различие определенных в классе ICurrencyConverter свойств и списком, возвращаемым методом get_class_vars() (вывелись только $name и $rates). Частные и защищенные свойства пропускаются.

Reflection API

PHP поддерживает отражение с помощью Reflection API. Reflection API предлагает существенно больше классов и методов для решения задач отражения. Класс ReflectionClassявляется основным классом API и используется для получения информации о классах, интерфейсах, методах и всех компонентов классов. Отражение очень легко применять в своем коде.

Ниже приводится пример использования отражения с определениями интерфейсаICurrencyConverter и классов Child и GBPCurrencyConverter:

01 <?php

`02`	`$child` `=` `new` `ReflectionClass("Child");`

`03`	`$parent` `=` `$child->getParentClass();`

`04`	`echo` `$child->getName() .` `" является подклассом "` `.` `$parent->getName() .` `".\n";`

05

`06`	`$reflection` `=` `new` `ReflectionClass("GBPCurrencyConverter");`

`07`	`$interfaceNames` `=` `$reflection->getInterfaceNames();`

`08`	`if` `(in_array("ICurrencyConverter",` `$interfaceNames)) {`

`09`	`echo` `"GBPCurrencyConverter реализует ICurrencyConverter.\n";`

10 }

11

`12`	`$methods` `=` `$reflection->getMethods();`

`13`	`echo` `"Доступны следующие мтоды:\n";`

`14`	`print_r($methods);`

15

`16`	`if` `($reflection->hasMethod("convert")) {`

`17`	`echo` `"Метод convert() есть в классе GBPCurrencyConverter.\n";`

18 }

Код выдаст следующий результат:

`01`	`Child является подклассом Introspection.`

`02`	`GBPCurrencyConverter реализует ICurrencyConverter.`

`03`	`Доступны следующие методы:`

04 Array

05 (

`06`	`[0] => ReflectionMethod Object`

07 (

`08`	`[name] => __construct`

`09`	`[class] => GBPCurrencyConverter`

10 )

11

`12`	`[1] => ReflectionMethod Object`

13 (

`14`	`[name] => convert`

`15`	`[class] => GBPCurrencyConverter`

16 )

17

18 )

`19`	`Метод convert() есть в классе GBPCurrencyConverter.`

Метод getInterfaceNames() возвращает массив с именами интерфейсов, которые реализует класс. Метод getParentClass() может вернуть объект ReflectionClass, представляющий родительский класс, или значение false, если родителя нет. Для получения имени объектаReflectionClass используется метод getName().

Метод getMethods() возвращает массив имен методов и может принимать опциональный аргумент - битовую маску из значений ReflectionMethod::IS_STATIC, IS_PUBLIC, IS_PROTECTED,IS_PRIVATE, IS_ABSTRACT, и IS_FINAL для фильтрации списка.

Reflection API предоставляет разработчику отличную реализацию отражения, с помощью которой можно создавать очень сложные приложения, такие как ApiGen.

Ссылки по теме