Design patterns

Un punct de reper pentru a descoperi un programator bun, indiferent de limbajul de programare pe care îl utilizează, este abilitatea acestuia de a aplica tehnici cunoscute de design al aplicaţiei. Design patterns(sau proiectarea modelelor) sunt un un set de soluţii ce pot fi aplicate la diverse probleme ce se întâlnesc frecvent în cadrul programării orientate pe obiect.

În teorie, aceste modele nu au legătură cu codul scris de un programator. Sunt niște soluţii de eficientizare a problemelor des întâlnite, nişte indicaţii pe care programatorul trebuie să le transpună în limbajul de programare pe care îl foloseşte. Ne vom referi în continuare la aceste modele legat de limbajul PHP, modele care deşi pot fi implementate folosind şi programarea procedurală, ele sunt evidenţiate mai bine cu ajutorul programării orientate pe obiect.

Singleton

Modelul Singleton este probabil cel mai simplu model. El este făcut pentru a permite accesul la o singură resursă care nu va fi niciodată duplicată, dar care trebuie făcută disponibilă în orice moment al execuţiei aplicaţiei. Implementarea unui Singleton trebuie să satisfacă cele două condiţii de acces global şi instanţiere singulară a resursei respective. Are nevoie de un mecanism de acces la class Singleton fără a instanţia un obiect şi un mecanism de a păstra informaţia asupra resursei ce urmează a fi folosită. Astfel acest model poate fi cel mai uşor implementat prin crearea unei clase ce va conţine o metodă care va crea o nouă instanţă a clasei, dacă aceasta nu exista deja, iar dacă există o va returna pe aceasta. Pentru a fi siguri că acea clasă nu va fi instanţiată în alt fel, constructorul este declarat protejat. Exemplul cel mai simplu este acela în care se pune problema existenţei unei singure conexiuni la baza de date:

class database
{
    private static $_singleton;
    private $_connection;
   
    protected function __construct()
    {
        $this->_connection = mysql_connect(SERVER, USER, PASSWORD);
    }
   
    public static function getInstance()
    {
        if (is_null(self::$_singleton))
        {
            self::$_singleton = new database();
        }
       
        return self::$_singleton;
    }
}

$cnx = database::getInstance();

Aşadar constructorul a fost declarat protejat pentru a controla accesul la el şi de a da posibilitatea apelării lui doar din interiorul clasei. Acest lucru este făcut cu ajutorul metodei statice getInstance, care verifică la fiecare apel al ei dacă există definit membrul static $_singleton, caz în care îl va returna, sau va încerca să creeze unul nou. Odată creat, metoda getInstance() nu va mai încerca să creeze unul nou ci-l va retuna pe cel creat tot timpul.

Factory

Modelul Factory se foloseşte în scenariile în care există o clasă generică (fabrica) care are posibilitatea de a crea o instanţă a una sau mai multe clase specializate în rezolvarea unei aceleaşi probleme dar în diferite moduri. Un astfel de exemplu îl reprezintă stocarea datelor de configurare într-o aplicaţie. Datele de configurare, precum credenţialele pentru conectarea la baza de date, sau căile de acces la diverse directoare, pot fi stocate în mai multe feluri: în fişiere XML, in fişiere INI sau chiar în baza de date. Astfel putem crea un mecanism care să returneze un obiect ce va şti să lucreze cu un anume mod de stocare a acestor date de configurare.

class configuration
{
    const STORE_IN_INI = 1;
    const STORE_IN_DB = 2;
    const STORE_IN_XML = 3;
   
    public static function factory($type = self::STORE_IN_INI)
    {
        switch ($type)
        {
            case self::STORE_IN_INI:
                return new configuration_ini();
            case self::STORE_IN_DB:
                return new configuration_db();
            case self::STORE_IN_XML:
                return new configuration_xml();
            default:
                throw new Exception(‘Tip de stocare necunoscut’);
        }
    }
}

Este evident faptul că toate cele 3 clase specializate de tratare a fișierelor de configurare (ini, xml, db) trebuiesc definite şi implementate, un avantaj fiind definirea lor conform unei clase abstracte. Apelarea “fabricii” se face după cum urmează:

$storage = configuration::factory(configuration::STORE_IN_XML);

Registry

Modelul Registry este un model Singleton mai evoluat, în sensul că permite stocarea mai multor resurse, ca într-un registru. Un exemplu ar fi acela în care, deşi avem conexiunea stabilită către baza de date printr-un Singleton, şi prin această conexiune se fac toate interogările, există posibilitatea ca din aplicaţie să fie nevoie de conexiunea în paralel către o alta bază de date pentru a efectua şi acolo diverse operaţiuni. Cu un simplu Singleton nu s-ar fi putut realiza aşa ceva însă cu un Registry acest lucru este posibil. Un astfel de Registry va trebui să implementeze metode de adăugare, verificare a existenţei şi de returnare a informaţiilor cerute.

class registry
{
    private static $_register;
   
    public static function add(&$element, $name)
    {
        $name = strtolower($name);
        self::$_register[$name] = $element;
    }
   
    public static function exists($name)
    {
        $name = strtolower($name);
        if (array_key_exists($name, self::$_register))
        {
            return true;
        }
        return false;
    }
   
    public static function &get($name)
    {
        $name = strtolower($name);
        if (self::exists($name))
        {
            return self::$_register[$name];
        }
        else
        {
            throw new Exception(‘Elementeul cerut nu exista in registru.’);
        }
    }
   
}

O folosirea a cestul model este următorul cu precizarea ca în acest exemplu clasa database nu este un Singleton:

$db = new database();
registry::add($db, ‘dbCnx’);
/*
verificarea conexiunii
*/

if (registry::exists(‘dbCnx’))
{
    $db = registry::get(‘dbCnx’);
}

Model-View-Controller

Spre deosebire de celelate modele discutate anterior, Model-View-Controller(denumit şi MVC) este un model destul de complex. Scopul lui este de a oferi o metodă de separare dintre logica aplicaţiei (model), modului de afişare (view) şi structura decizională (controller), aplicaţiile MVC fiind astfel usor de modificat atunci când se doreşte modificarea doar a modului de afişare sau a modului în care este tratată o cerere.

Logica unei astfel de aplicaţii este următoare: o cerere este făcută către aplicaţie şi este apelat controller-ul care va decide cum va trata cererea. Controller-ul va chema o clasă din Model, care efectiv va efectua interogări către baza de date, prelucrările necesare ale datelor sau orice alte operaţiuni necesare. Rezultatul, de regulă un set de date, va fi întors către Controller care va transmite aceste date părţii vizuale a aplicaţiei(View) unde deja există o structură de afişare a datelor ce tocmai au fost primite. Avantajul enorm al acestui model este separarea clară între cele 3 compomente şi uşurinţa cu care se pot extinde aplicaţiile dezvoltate pe acest model.

Metode magice în PHP

PHP 5 aduce un nou model al programării orientate pe obiect cu o multitudine de îmbunatăţiri şi facilităţi, spre bucuria programatorilor deja obişnuiţi cu pseudo-modelul din PHP 4. O facilitate care poate ajuta în cazul unor proiecte cu module interconectabile, este cea numită metode magice. Acestea sunt un set de metode standard, rezervate în limbajul de programare, care au o aceeaşi semnificaţie şi o aceeşi funcţionalitate în cazul oricăror clase definite de utilizator. Aceşte metode sunt autoapelate în anumite condiţii sau în cazul unor acţiuni externe.

Constructor si destructor

Metodele __construct() şi __destruct(), deşi pot fi numite magice doar prin modul de scriere, ele făcând parte din teoria programării orientate pe obiect, sunt metodele care se vor apela automat la crearea (instanţierea) respectiv distrugerea unui obiect aparţinând unei clase. De regula, în constructor se crează conexiuni, se setează variabile, se preiau variabile externe sau orice altă acţiune de iniţializare a elementelor clasei, pe când în destructor se face curăţenie printre aceste elemente, se închid eventualele conexiuni sau se şterg fişiere.

<?php
       
        class math
        {
                protected $a;
                protected $b;
               
                public function __construct($x, $y)
                {
                        $this->a = $x;
                        $this->b = $y;
                }
               
                public function add()
                {
                        return $this->a + $this->b;
                }
               
                public function multiply()
                {
                        return $this->a * $this->b;
                }
               
                public function __destruct()
                {
                        unset($this->a);
                        unset($this->b);
                }
        }
       
        $math = new math(3, 8);
        echo $math->add();
        unset($math);
?>

Constructorul va fi astfel apelat în momentul creării obiectului folosind operatorul new iar destructorul va fi apelat în la apelul lui unset() asupra obiectului în mod expicit sau în mod implicit la terminarea execuţiei scriptului, daca nu s-a făcut altfel.

Serializare şi deserializare

Serializarea este procesul de a liniariza o variabilă de orice tip într-una de tip string, cu scopul de a pastra informaţiile din interiorul ei(precum si tipul/tipurile de date) şi pentru a le transmite la distanţă fără pierdere de informaţii. Deserializarea este, evident, procesul invers. Daca în cazul unui vector rezultatul serializării este un string ce conţine în ordine şi pe nivele elementele acestuia, în cazul claselor se oferă posibilitatea de a alege ce date să se pastreze sau să se porteze. Pentru acest lucru au fost create două metode magice care vor fi apelate automat la apelul serializării sau a deserializării: __sleep() şi __wakeup().

<?php
       
        class math
        {
                protected $a;
                protected $b;
               
                public function __construct($x, $y)
                {
                        $this->a = $x;
                        $this->b = $y;
                }
               
                public function add()
                {
                        return $this->a + $this->b;
                }
               
                public function multiply()
                {
                        return $this->a * $this->b;
                }
               
                public function __sleep()
                {
                        return array(‘a’, ‘b’);
                }
               
                public function __wakeup()
                {
                        echo ‘a=’ . $this->a . ‘; b=’ . $this->b;
                }
               
                public function __destruct()
                {
                        unset($this->a);
                        unset($this->b);
                }
        }
       
        $mathAdd = new math(3, 8);
        echo $mathAdd->add(); /* va afisa 11 */
        $tmpData = serialize($mathAdd);
       
        $mathMultiply = new math(0, 0);
        $mathMultiply = unserialize($tmpData);
        echo $math->multiply(); /* va afisa 24 */
?>

De menţionat este că la apelul unserialize() şi implicit a lui math::__wakeup() scriptul va printa valorile primite de la prima instanţiere a clasei.

String

Există şi o metodă simplă, numită __toString() care va fi apelată la fiecare apel al lui echo, print sau încercare de folosire a obiectului ca un string.

<?php
       
        class hello
        {
                protected $foo;
               
                public function __construct($bar)
                {
                        $this->foo = $bar;
                }
               
                public function __toString()
                {
                        return "Hello " . $this->foo;
                }
        }
       
        $hi = new hello(‘george’);
        echo $hi; /* va tipari "Hello george" */
       
?>

O altă metodă de transmitere a datelor între obiecte, posibil mai convenabilă decât serializarea şi deserializarea, poate fi făcută cu ajutorul funcţiei var_export() şi a metodei magice __set_state(). var_export() va returna un string care va conţine, fie valoarea numerica (în cazul variabilelor scalare de tip numeric), fie o valoare de tip string (cazul variabilelor string), fie stringul care ar crea un vector în cazul acestora, fie valoarea returnată de metoda magica __set_state() în cazul obiectelor. Această metodă magică a fost introdusă odată cu versiunea 5.1.0 a PHP.

<?php

        class A
        {
                public $var1;
                public $var2;
               
                public static function __set_state($an_array)
                {
                        $obj = new A;
                        $obj->var1 = $an_array[‘var1′];
                        $obj->var2 = $an_array[‘var2′];
                        return $obj;
                }
        }
       
        $a = new A;
        $a->var1 = 5;
        $a->var2 = ‘foo’;
       
        eval(‘$b = ‘ . var_export($a, true) . ‘;’);
        // $b = A::__set_state(array(
        //    ‘var1′ => 5,
        //    ‘var2′ => ‘foo’,
        // ));

?>

Autoîncărcarea

Deşi nu este o metodă, funcţia __autoload() poate fi de mare ajutor atunci când aplicaţia dispune de un numar considerabil de clase care nu sunt folosite toate în acelaşi timp. Astfel, aceasă funcţie se va apela şi va include, dacă este nevoie, un fişier care va conţine definiţia clasei, în momentul instanţierii unui obiect. În scenariul de faţă, este de preferat ca toate definiţiile clasei să fie situate într-un acelaşi director, iar fiecare clasă situată într-un fişier separat al cărui nume sa fie identic cu al clasei.

function __autoload($className)
{
        if (!class_exists($className)) 
        {
                include("includes/classes/" . $className . ".php");
        }
}

Se evită in acest fel încărcarea tuturor claselor existente în aplicaţie şi îngreunarea acesteia luând în considerare presupunerea ca nu toate clasele vor fi folosite în oricare acţiune a aplicaţiei, prin faptul ca o clasa va fi încarcată doar dacă este nevoie si doar atunci când este nevoie.

Paginare datelor este un mijloc eficient de a reduce datele raportate unui utilizator la o secţiune de interes local în ideea de a economisi timp de execuţie, spaţiu de afişare şi se a crea nişte raportări prietenoase. Exemplul cel mai simplu în reprezintă afişarea unor produse dintr-un magazin online pe … pagini, lucru care are avantajul că pe de partea clientului nu încarcă excesiv pagina utilizatorului (un magazin poate avea câteva sute de produse, poate chiar mii) iar pe partea serverului nu solicită nici baza de date dar nici procesările făcute după ce un set de date a fost returnat aplicaţiei, toate acestea făcându-se asupra unui set restrans de date.

Introdus in versiunea 1.6 a Zend Framework, modulul Zend_Paginator, aşteptat încă din versiunea 0.9, se vrea a fi o componentă flexibilă pentru paginarea colecţiilor de date şi prezentarea lor către utilizatori. Principalele avantaje ale acestui modul sunt posibilitatea de a pagina orice set de date, nu doar cele provenite din baza de date, aduce si prelucreaza doar setul de date care urmează a fi afişat nu asupra tuturor datelor, plus că fiind felxibil nu limitează programatorii doar la folosirea lui şi într-un anume mod, dar oferă totodată posibilitatea de folosirea a lui din alte componente ale framework-ului precum Zend_View sau Zend_Db.

Folosirea paginatorului este relativ simplă, şi se foloseşte de ideea că pentru a putea pagina un set de date, în orice format ar fi el, este nevoie de un adaptro specific pentru a putea interacţiona cu acele date. Astfel, pentru a putea pagina un vector, se poate folosi un array simplu din PHP, pentru a pagina un set de date returnate în urma unei interogări a bazei de date se foloseşte o instanţă a Zend_Db_Select, iar pentru a pagina un iterator se va folosi o instanşă a acestei clase din SPL. Pentru a începe folosirea paginatorului se poate instanţia acesta folosind adaptorul dorit, sau se poate folosi metoda statică factory():

$array = array(‘Luni’, ‘Marti’, ‘Miercuri’, ‘Joi’, ‘Vineri’, ‘Sambata’, ‘Duminica’);
$paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array($array));
$paginator = Zend_Paginator::factory($array);

În acest moment paginatorul are nevoie de o referinţă pentru a putea determnia şi prelucra secţiunea care va fi afişată utilizatorului, şi anume pagina, informaţie care de regula se stochează într-un parametru al URL-ului(implicit va fi considerată pagina 1). Totodată se poate specifica şi numărul de elemente care vor apărea intr-o pagină, acest număr este implicit 10.

$paginator->setCurrentPageNumber($this->_request->getParam(‘page’));
$paginator->setItemCountPerPage(20);

În final paginatorul se atribuie unei variabile din partea vizuală a aplicaţiei …

$this->view->paginator = $paginator;

iar apoi va fi afişată

<?php foreach ($this->paginator as $element): ?> 
<p><?php echo $element; ?></p>
<?php endforeach; ?>

Daca dorim paginarea unor date provenite din baza de date, cu siguranţă că va fi mai eficient ca interogarea făcută către baza de date să returneze doar acele date din pagina care ne interesează. Pentru acest lucru vom instanţia paginatorul folosind un obiect de tipul Zend_Db_Select, care va conţine o instrucţiune select personalizată pentru nevoile noastre.

class My_Model
{
    public static function getCategoryList($category_id, $page = 1)
    {
        $databaseAdaptor = Zend_Registry::get(‘db’);
        try
        {
            $select = new Zend_Db_Select($databaseAdaptor);
            /*$select = $databaseAdaptor->select();*/
            $select->from(‘products’, array(‘id’, ‘name’, ‘price’))
                    ->where(‘category_id = ?’, $category_id)
                    ->order(‘name asc’)
                    ;
                   
            $paginator = Zend_Paginator::factory($select);
            $paginator->setCurrentPageNumber($page);
            $paginator->setItemCountPerPage(10);
   
            return $paginator;
           
        }
        catch (Zend_Exception $ex)
        {
            Zend_Debug::dump($ex);
            return null;
        }
    }
}

Am creat asadar un model care va returna din baza de date toate produsele dintr-o anumită categorie, sortate după nume, folosind un obiect Zend_Db_Select instanţiat folosind un adaptor pentru baza de date, care a fost preluat din registru. Rezultatul unei astefel de abordări poate fi procesat într-un controller după cum urmează:

class IndexController extends Zend_Controller_Action
{
    public function indexAction()
    {
        Zend_Loader::loadClass(‘My_Model’);
        $this->view->paginator = My_Model::getNewsletterList($this->_request->getParam(‘category_id’), $this->_request->getParam(‘page’));
    }
}

Un alt aspect important al paginării este capacitatea acestei componente de a genera un nagivator printre “paginile” astfel determinate ale paginării, deci în ultimă instanţă posibilitatea de a avea acces secvenţial la tot setul de informaţii. Zend_Paginator furnizeată unul chiar interesant, datorită facilităţilor ce le oferă.

echo $this->paginationControl($this->paginator, ‘Sliding’, ‘pagination_control.phtml’);

Deşi ultimii doi parametri sunt opţionali, iar controlul ar putea funcţiona perfect fără aceste două informaţii, aceştia pot influenţa foarte mult modul în care acest index al navigării este construit. Ele se referă la, şi influenţează modul în care navigatorul generat va arăta şi comporta. Vom considera, pentru exemplificare, că navigatorul generat de Google la o căutare ar fi generat chiar de către Zend_Paginator.

Google Slider

Cel de-al doilea parametru controlează ce se întamplă daca acţionăm linkul “Precedentă” sau “Următoarele” şi poate avea urmatoarele valori

  • All caz în care va afişa toate paginile existente, lucru util pentru momentele când numărul paginilor rezultate este relativ scăzut
  • Elastic caz în care paginile se lărgesc şi se contractă în funcţie de poziţia în paginare şi numărul de pagini - gen Google
  • Jumping caz în care pe măsură ce utilizatorul trece de la o pagină la alta, pagina curentă se muta catre finalul unui interval de pagini, la finalul caruia va continua cu un interval nou
  • Sliding caz în care pagina curentă va fi afişată în centrul intervalului de pagini afişat, sau cel mai aproape posibil (gen Yahoo!); acesta este valoarea implicită

Cu toate acestea însă programatorul nu este restricţionat la acest set de posibilităţi, oferindui-se posibilitatea de a-si crea singur porpiul paginator. Pentru acest lucru sunt disponibile o serie de metode predefinite:

  1. first() — numărul primei pagini
  2. firstItemNumber() — numărul primei înregistrari din pagină în setul general de date
  3. firstPageInRange() — numărul primei pagini din setul curent
  4. current() — numărul paginii curente
  5. currentItemCount() — numărul de elemente afişate pe pagina curentă
  6. last() — numărul ultimei pagini
  7. lastItemNumber() — numărul ultimei înregistrari din pagină în setul general de date
  8. lastPageInRange() — numărul ultimei pagini din setul curent
  9. next() — numărul paginii următoare
  10. pageCount() — numărul total de pagini
  11. pagesInRange() — paginile aflate în setul de pagini
  12. previous() — numărul paginii precedente
  13. totalItemCount() — numărul total de elemente

Prin setul curent de pagini, ne-am referit la paginile vizibile la o afişare.