"Objektumorientált" Drupal - A reflection osztályok haszna

Nem rég el kellett kezdenem drupalban fejleszteni. Számomra nagyon új és furcsa volt, hogy gyakorlatilag sehol egy igazi osztály, vagy az objektumorientáltság jele. Ez annyiban érdekes, hogy számomra egy jól strukturált OOP-re épülő forráskód sokkal érthetőbb, mint függvények sokasága, ahol ráadásul minden függvény ott lebeg a globális térben. Az is, ami kizárólag a modulnak kell. Ugyanez a változókkal. Na most kezdő drupalosként, hogy otthonosabban érezzem magam a forráskódban, megpróbáltam kierőszakolni az osztályok használatát úgy, hogy közben kigenerálom a függvényeket is, de csak azokat, amiket a drupalnak meg kell tudni hívni automatikusan. Hangsúlyozom, hogy a következő megoldást az ötlet és a megvalósítás miatt teszem közzé. Nem ajánlásként.

Megoldás

Modul írása általában

Drupalban, ha egy modult írunk, akkor lesz minimum egy modulneve.module nevű fájlunk. Ebben pedig olyan függvények, amik mind a modulneve_ prefix-szel kezdődnek. Azok a függvények pedig amik „privátok”, kapnak még egy aláhúzás jelet: _modulneve_. Ez után a prefix után pedig elég sok minden állhat. A rendszer pedig a bekapcsolt modulok függvényeit különböző helyeken meghívhatja. A függvények elnevezése persze kötött. Csak a prefix változik.

Ötlet

Az ötlet az volt, hogy valamilyen módon megkönnyítem a dolgom és osztályokat használok. Persze mivel példányra nincs szükség, csak statikusat. De már valami pluszt mégis kapok. Majd pedig megírom a szükséges függvényeket, és bennük egyetlen sor kódot írok. A hozzá tartozó metódus meghívását:

  1. function modulneve_init()
  2. {
  3.      Modulneve::init();
  4. }

Persze, ha vannak paraméterek, akkor azokat is ugyanúgy átadom. De akkor már jött a következő ötlet. Ezek a függvények így elég szépen automatizálhatók, hiszen ránézésre alig van különbség. Tehát rögtön megoldhatom, hogy már a függvényeket is az osztály automatikusan legenerálja.

A probléma

Egy részt valahogy mégsem árt jelölni, hogy ez az osztály egy modul osztálya. A modulnév elvileg lehet bármi. Akár php-ban foglalt szó is.

Illetve az szép, hogy emberi szemmel nagyon jól kivehető az elnevezések és paraméterezések hasonlósága, de a PHP-nak is meg kell tudni mondani, hogy hogyan adja át a paramétereket és egyáltalán a függvény paraméterlistáját hogyan építse fel. Referencia szerint kell-e átadni, elhagyható-e, mi az alapértelmezett értéke, stb. Ezt pedig neki automatikusan fel kell ismerni az osztályból, különben az egésznek semmi értelme.

Használható eszközök

Az előző cikkemben csak megemlítettem a Reflection osztályokat, de példát nem nagyon írtam. Na most ennél a feladatnál pont nagyon jó, hogy vannak.

A függvények generálásához pedig kell az eval is mindenképp.

A call_user_func_array függvény is kell, ami meghívja a generált függvényből a megfelelő metódust a paramétereivel.

És persze a jó öreg func_get_args(), hogy megtudjuk, milyen átadott argumentumai vannak a függvénynek.

Talán még a var_export() függvényt megemlítem, mert itt is jó szolgálatot tesz majd. A metódusok paramétereit le lehet kérdezni, de arról gondoskodni kell, hogy a függvényekben is megtartsák a típusukat. Lehetne ellenőrizni, hogy a paraméter default értéke string-e, vagy sem. És akkor idézőjelbe kell tenni. De ezzel egyszerűbb.

Megvalósítás

Először is úgy döntöttem, a modul osztályok neve a DrupalModules_Modulneve rendszert követi. Meg kell továbbá oldani azt, hogy csak a publikus metódusait generáljuk ki függvényalakba is. Ennek lekérdezését a

  1. $ref = new ReflectionClass($class);
  2. $methods = $ref->getMethods(ReflectionMethod::IS_PUBLIC);

megoldással el is érem. Kell viszont a függvény argumentumainak listája. Ráadásul olyan formában, ahogy azt eredetileg definiáltam. Ez egy összetettebb feladat, mert előbb le kell kérdezni a metódus paramétereit. Majd a paraméterek tulajdonságait. Majd ahhoz string formában legenerálni a paraméterlistát. Ezért ezt külön metódusba tettem.

A megoldás lelke: A ReflectionParameter osztály isPassedByReference metódusa megadja, hogy a változót referenciaként kell-e átadni. Az isDefaultValueAvailable és getDefaultValue metódusok pedig az alapértelmezett értékek lekérésben segítenek.

Ezzel így már két olyan metódusom lett, amit nem kellene függvényként legenerálni, de ebből az egyik mindenképpen publikus kell legyen. Amelyik elindítja az egész játékot. Ezért kitettem egy ősosztályba. Amit a modul osztálya örököl. Így a saját metódusainak és az átadott modulnévhez tartozó osztályok különbségét veheti. És csak azokat generálja le a publikusak közül. A megoldás tehát a következő:

  1. class DrupalModules
  2. {
  3.        
  4.         public static function generateFunctions($module)
  5.         {
  6.                 $dm_methods = get_class_methods(__CLASS__);
  7.                 $class = 'DrupalModules_'.$module;
  8.                 $ref = new ReflectionClass($class);
  9.                 foreach ($ref->getMethods(ReflectionMethod::IS_PUBLIC) as $method)
  10.                 {
  11.                         if (in_array($method->name, $dm_methods)) continue;
  12.                         $argumentList = self::getMethodArgumentList($class, $method->name);
  13.                         $callback = array($class, $method->name);
  14.                         $eval = 'function '.$module.'_'.$method->name.'('.$argumentList.') {
  15.                                 $args = func_get_args();
  16.                                 call_user_func_array('.var_export($callback,true).', $args);
  17.                         }';
  18.                         eval($eval);
  19.                 }
  20.         }
  21.        
  22.         public static function getMethodArgumentList($class, $method)
  23.         {
  24.                 $methodref = new ReflectionMethod($class, $method);
  25.                 $arguments = $methodref->getParameters();
  26.  
  27.                 $list = array();
  28.                
  29.                 foreach ($arguments as $argument)
  30.                 {
  31.                         $argref = new ReflectionParameter(array($class, $method), $argument->name);
  32.                         $argdef = '';
  33.                         if ($argref->isPassedByReference()) {
  34.                                 $argdef .= '&';
  35.                         }
  36.                        
  37.                         $argdef .= '$'.$argref->getName();
  38.                        
  39.                         if ($argref->isDefaultValueAvailable()) {
  40.                                 $defv = $argref->getDefaultValue();
  41.                                 $argdef .= ' = '.  var_export($defv, true);
  42.                         }
  43.                        
  44.                         $list[] = $argdef;
  45.                 }              
  46.                 return implode(', ',$list);
  47.         }
  48. }
  49.  
  50. class DrupalModules_Modulneve extends DrupalModules
  51. {
  52.          public static  function init() {
  53.               //modul inicializálás
  54.          }
  55.  
  56.          public static function menu() {
  57.                //modulhoz tartozó menük
  58.          }
  59.  
  60.          //stb....
  61. }
  62.  
  63. DrupalModules::generateFunctions('modulneve');

Értékelés

Elég sok Reflection példány jön létre, amik persze nem sokáig élnek, de sok metódusnál azért számíthat. Viszont kényelmes és szerintem jól szemlélteti a Reflection osztályok értelmét.

Osztályokkal kódolhatunk, de ettől még nem lesz objektumorientált a program. Ezért is tettem a címben idézőjelbe a kifejezést. A függvények továbbra is létezni fognak, de pluszban még a metódusokat is meg kell hívni, majd pedig eval-lal dinamikusan generálni őket.

Valahol olvastam egy olyan megjegyzést, hogy: „eval is evil”. Azaz az eval gonosz. Lehetőség szerint kerülni is kell a használatát, de ha kell, akkor kell.

Összességében tehát főleg az ötlet tetszik. És arra jó volt, hogy a kezdeti nehézségeken annyit könnyítsek, hogy barátságosabb forráskódom lesz, amiben otthon érzem magam. De ha az ember megérti és megszokja a drupal megoldásait, akkor talán jobb azt betartani. Ahol szükséges persze, ott lehet még belecsempészni egy kis OOP-t. De az automatikus generálgatás megspórolható.

Kategóriák: 
Megosztás/Mentés

Új hozzászólás