Introduzione Cos'è Smarty? Smarty è un motore di template per PHP. Più specificatamente, fornisce un modo semplice di separare la logica e il contenuto dell'applicazione dalla sua presentazione. Questo concetto si può comprendere meglio in una situazione in cui il programmatore ed il progettista dei template hanno ruoli diversi, o nella maggior parte dei casi non sono la stessa persona. Per esempio, diciamo che dovete creare una pagina web che mostra un articolo di giornale. Il titolo, il sommario, l'autore e il corpo dell'articolo sono gli elementi del contenuto: non contengono informazioni su come saranno presentati. Vengono passati a Smarty dall'applicazione, dopodiché il grafico modifica i template e usa una combinazione di tag HTML e tag di template per formattare la presentazione di questi elementi (tabelle HTML, colori di sfondo, dimensione dei caratteri, fogli di stile ecc.). Un giorno il programmatore ha bisogno di cambiare il sistema in cui viene ottenuto il contenuto dell'articolo (si tratta di una modifica alla logica dell'applicazione). Questa modifica non influisce sul lavoro del grafico, infatti il contenuto arriverà al template esattamente uguale a prima. Allo stesso modo, se il grafico vuole ridisegnare completamente il template, questo non richiederà modifica alla logica applicativa. Quindi, il programmatore può fare modifice alla logica senza bisogno di ristrutturare i template, e il grafico può modificare i template senza rovinare la logica dell'applicazione. Uno degli obiettivi progettuali di Smarty è la separazione della logica di business dalla logica di presentazione. Questo significa che i template possono contenere logica, a condizione che tale logica sia esclusivamente relativa alla presentazione. Cose come includere un altro template, alternare i colori delle righe di tabella, mostrare un dato in maiuscolo, ciclare su un array di dati per visualizzarli, ecc., sono tutti esempi di logica di presentazione. Questo non significa che Smarty forza una separazione fra la logica di business e quella di presentazione. Smarty non può sapere che cosa è una cosa e cosa è l'altra, per cui se mettete logica di business nel template sono affari vostri. Inoltre, se non volete alcuna logica nei template, potete sicuramente ottenere ciò riducendo il contenuto a solo testo e variabili. Uno degli aspetti caratteristici di Smarty è la compilazione dei template. Questo significa che Smarty legge i file dei template e crea script PHP a partire da questi. Una volta creati, questi script vengono eseguiti da quel momento in poi: di conseguenza si evita una costosa analisi dei template ad ogni richiesta, e ogni template può avvantaggiarsi pienamente di strumenti per velocizzare l'esecuzione come Zend Accelerator (&url.zend;) o PHP Accelerator (&url.php-accelerator;). Ecco alcune delle funzionalità di Smarty: E' estremamente veloce. E' efficiente, perché è l'analizzatore di PHP a fare il "lavoro sporco". Non c'è sovraccarico per l'analisi del template, che viene compilato una sola volta. E' abbastanza furbo da saper ricompilare solo i template che sono stati modificati. Potete creare funzioni personalizzate e modificatori di variabili personalizzati, il che rende il linguaggio dei template estremamente estensibile. La sintassi dei tag di delimitazione dei template è configurabile: potete usare {}, {{}}, <!--{}-->, ecc. I costrutti if/elseif/else/endif vengono passati al PHP, quindi la sintassi delle espressioni condizionali può essere semplice o complicata a vostro piacimento. E' consentito nidificare in maniera illimitata sezioni, test, ecc. E' possibile incorporare direttamente codice PHP nei file di template, sebbene non dovrebbe essercene bisogno (e nemmeno è raccomandato), essendo il motore così personalizzabile. Supporto nativo al caching Scelta arbitraria dei sorgenti dei template Funzioni personalizzate di gestione della cache Architettura a plugin Installazione Requisiti Smarty necessita di un web server su cui gira PHP 4.0.6 o successivo. Installazione di base Installate i file delle librerie di Smarty che si trovano nella directory /libs/ della distribuzione. Questi sono i file PHP che NON DOVETE modificare. Sono condivisi da tutte le applicazioni e vengono modificati solo quando passate ad una nuova versione di Smarty. File delle librerie di Smarty Smarty usa una costante PHP chiamata SMARTY_DIR che contiene il path di sistema della directory delle librerie di Smarty. Fondamentalmente, se la vostra applicazione è in grado di trovare il file Smarty.class.php, non avete bisogno di impostare SMARTY_DIR, in quanto Smarty la troverà da solo. Tuttavia, se Smarty.class.php non si trova nel vostro include_path, o se non fornite alla vostra applicazione un percorso assoluto per questo file, allora dovete definire manualmente SMARTY_DIR. La costante SMARTY_DIR deve contenere uno slash (/) finale. Ecco come creerete un'istanza di Smarty nei vostri script PHP: Creazione di un'istanza di Smarty ]]> Provate a lanciare lo script qui sopra. Se ricevete un errore che dice che il file Smarty.class.php non si trova, dovete fare una delle cose seguenti: Fornire un percorso assoluto al file delle librerie ]]> Aggiungere la directory della libreria all'include_path di PHP ]]> Impostare manualmente la costante SMARTY_DIR ]]> Ora che i file delle librerie sono al loro posto, è ora di impostare le directory di Smarty per la vostra applicazione. Smarty necessita di quattro directory chiamate (per default) templates, templates_c, configs e cache. Ciascuna di queste è definibile dalle proprietà della classe Smarty $template_dir, $compile_dir, $config_dir, e $cache_dir rispettivamente. E' altamente raccomandato impostare un insieme separato di queste directory per ogni applicazione che userà Smarty. Assicuratevi di conoscere il percorso della document root del vostro web server. Nel nostro esempio, la document root è /web/www.mydomain.com/docs/. Le directory di Smarty vengono accedute solo dalle librerie di Smarty e mai direttamente dal browser. Tuttavia, per evitare problemi di sicurezza, si raccomanda di mettere queste directory al di fuori della document root. Per la nostra installazione di esempio, imposteremo l'ambiente di Smarty per una applicazione di guest book. Abbiamo scelto un'applicazione al solo scopo di avere una convenzione per il nome delle directory. Potete usare lo stesso ambiente per qualsiasi applicazione, soltanto sostituendo "guestbook" con il nome della vostra applicazione. Metteremo le nostre directory di Smarty sotto /web/www.mydomain.com/smarty/guestbook/. Avrete bisogno di almeno un file sotto la document root, e quello sarà lo script a cui può accedere ilbrowser. Lo chiameremo index.php, e lo metteremo in una sottodirectory della document root chiamata /guestbook/. Nota tecnica Conviene impostare il web server in modo che "index.php" possa essere identificato come indice di default della directory, così se provate a richiedere "http://www.example.com/guestbook/", lo script index.php verrà eseguito senza "index.php" nell'URL. In Apache questo può essere impostato aggiungendo "index.php" alla fine dell'impostazione DirectoryIndex (le voci vanno separate con uno spazio l'una dall'altra). Diamo un'occhiata alla struttura dei file fino ad ora: Esempio di struttura dei file Smarty necessita del diritto di scrittura su $compile_dir e su $cache_dir, quindi assicuratevi che l'utente del web server possa scriverci sopra. Di solito si tratta dell'utente "nobody" e gruppo "nobody". Per utenti di OS X, il default è utente "www" e gruppo "www". Se usate Apache, potete guardare nel file httpd.conf (di solito in "/usr/local/apache/conf/") per vedere quale utente e gruppo vengono usati. Impostazione dei permessi sui file Nota tecnica chmod 770 vi garantisce una notevole sicurezza, in quanto consente solo all'utente e al gruppo "nobody" l'accesso in lettura/scrittura alle directory. Se volete consentire la lettura a chiunque (soprattutto per vostra comodità, se volete guardare questi file), potete impostare invece 775. Ora dobbiamo creare il file index.tpl che Smarty caricherà. Si troverà nella directory $template_dir. Edit di /web/www.example.com/smarty/guestbook/templates/index.tpl Nota tecnica {* Smarty *} è un commento del template. Non è obbligatorio, ma è buona pratica iniziare tutti i file di template con questo commento. Rende semplice riconoscere il file, indipendentemente dalla sua estensione. Ad esempio, un editor di testo potrebbe riconoscere il file ed attivare una particolare evidenziazione della sintassi. Ora editiamo index.php. Creeremo un'istanza di Smarty, valorizzeremo una variabile del template e faremo il display del file index.tpl. Nel nostro ambiente di esempio, "/usr/local/lib/php/Smarty" si trova nell'include_path. Assicuratevi che sia così anche per voi, oppure usate percorsi assoluti. Edit di /web/www.example.com/docs/guestbook/index.php template_dir = '/web/www.example.com/smarty/guestbook/templates/'; $smarty->compile_dir = '/web/www.example.com/smarty/guestbook/templates_c/'; $smarty->config_dir = '/web/www.example.com/smarty/guestbook/configs/'; $smarty->cache_dir = '/web/www.example.com/smarty/guestbook/cache/'; $smarty->assign('name','Ned'); $smarty->display('index.tpl'); ?> ]]> Nota tecnica Nell'esempio stiamo usando percorsi assoluti per tutte le directory di Smarty. Se /web/www.example.com/smarty/guestbook/ fa parte dell'include_path di PHP, questo non è necessario. Comunque, è più efficiente e (per esperienza) meno soggetto ad errori usare percorsi assoluti. Questo vi garantisce che Smarty prenda i file dalle directory giuste. Ora richiamate il file index.php dal browser. Dovreste vedere "Hello, Ned!" Avete completato l'installazione base di Smarty! Installazione avanzata Questo è il seguito della installazione di base, siete pregati di leggerla prima! Un modo leggermente più flessibile di installare Smarty è di estendere la classe e inizializzare il vostro ambiente di Smarty. Così, invece di impostare ripetutamente i percorsi delle directory, riassegnare le stesse variabili ecc., possiamo farlo in un unico punto. Creiamo una nuova directory "/php/includes/guestbook/" e un file chiamato setup.php. Nel nostro ambiente di esempio, "/php/includes" fa parte dell'include_path. Assicuratevi che sia così anche per voi, oppure usate percorsi assoluti. Edit di /php/includes/guestbook/setup.php Smarty(); $this->template_dir = '/web/www.example.com/smarty/guestbook/templates/'; $this->compile_dir = '/web/www.example.com/smarty/guestbook/templates_c/'; $this->config_dir = '/web/www.example.com/smarty/guestbook/configs/'; $this->cache_dir = '/web/www.example.com/smarty/guestbook/cache/'; $this->caching = true; $this->assign('app_name', 'Guest Book'); } } ?> ]]> Ora modifichiamo il file index.php per usare setup.php: Edit di /web/www.example.com/docs/guestbook/index.php assign('name','Ned'); $smarty->display('index.tpl'); ?> ]]> Come potete vedere, è molto semplice creare un'istanza di Smarty, basta usare Smarty_GuestBook che inizializza automaticamente tutto ciò che serve alla nostra applicazione.