Capitolo 4 - Le basi per la creazione delle pagine
Curiosamente, il primo tutorial che i programmatori seguono quando devono imparare una nuovo linguaggio o un framework è quello che permette di visualizzare "Buongiorno, mondo!" sullo schermo. È strano pensare al computer come un qualcosa che può salutare il mondo intero, dal momento che ogni tentativo nel campo dell'intelligenza artificiale ha finora ottenuto scarse capacità di conversazione. Ma symfony non è più stupido di qualsiasi altro programma e la prova è che è possibile creare una pagina che dice "Buongiorno, <Il Tuo Nome>".
Questo capitolo spiegherà come creare un modulo, che è un elemento strutturale che raggruppa le pagine. Si potrà anche imparare a creare una pagina, che è divisa in una azione e un template, a causa dell'utilizzo del pattern MVC. Collegamenti e form sono le interazioni web di base; si vedrà come inserirli in un template e gestirli in un'azione.
Creare lo scheletro di un modulo
Come spiegato nel capitolo 2, symfony raggroppa le pagine in moduli. Prima di creare una pagina, bisogna creare un modulo, che inizialmente è una struttura vuota di file che symfony può riconoscere.
La riga di comando di symfony automatizza la creazione di moduli. Basta eseguire il task generate:module con il nome dell'applicazione e il nome del modulo come parametri. Nel precedente capitolo, è stata creata l'applicazione frontend. Per aggiungere un modulo contenuto a questa applicazione, digitare i seguenti comandi:
$ cd ~/mioprogetto $ php symfony generate:module frontend contenuto >> dir+ ~/mioprogetto/apps/frontend/modules/contenuto/actions >> file+ ~/mioprogetto/apps/frontend/modules/contenuto/actions/actions.class.php >> dir+ ~/mioprogetto/apps/frontend/modules/contenuto/templates >> file+ ~/mioprogetto/apps/frontend/modules/contenuto/templates/indexSuccess.php >> file+ ~/mioprogetto/test/functional/frontend/contenutoActionsTest.php >> tokens ~/mioprogetto/test/functional/frontend/contenutoActionsTest.php >> tokens ~/mioprogetto/apps/frontend/modules/contenuto/actions/actions.class.php >> tokens ~/mioprogetto/apps/frontend/modules/contenuto/templates/indexSuccess.php
A parte le cartelle actions/ e templates/, questo comando crea solo tre file. Il primo si trova nella cartella test/, riguarda i test funzionali e non si ha bisogno di farci caso fino al capitolo 15. actions.class.php (mostrato nel listato 4-1) esegue il forward al modulo predefinito con la pagina di congratulazioni. Il file templates/indexSuccess.php è vuoto.
Listato 4-1 - L'azione predefinita generata in actions/actions.class.php
<?php class contenutoActions extends sfActions { public function executeIndex() { $this->forward('default', 'module'); } }
note
Se si guarda nel file actions.class.php, si troveranno altre righe, compresi molti commenti. Questo perché symfony consiglia l'uso dei commenti PHP per documentare i progetti e predispone ciascun file con classi a essere compatibile con lo strumento phpDocumentor.
Per ogni nuovo modulo, symfony crea una azione index predefinita. Questa si compone di un metodo azione chiamato executeIndex e un file template chiamato indexSuccess.php. Il significato del prefisso execute e del suffisso Success verrà spiegato rispettivamente nei Capitoli 6 e 7. Nel frattempo, si può considerare che questa nomenclatura è una convenzione. Si può vedere la pagina corrispondente (riprodotta in figura 4-1) aprendo il seguente URL:
http://localhost/frontend_dev.php/contenuto/index
L'azione predefinita index non verrà usata in questo capitolo, quindi si può rimuovere il metodo executeIndex() dal file actions.class.php e cancellare il file indexSuccess.php dalla cartella templates/.
note
Symfony mette a disposizione altri modi per creare un modulo oltre che da riga di comando. Uno di questi è quello di creare le cartelle e i file manualmente. In molti casi, le azioni e i template di un modulo hanno lo scopo di manipolare i dati di una determinata tabella. Essendo il codice necessario per creare, recuperare, aggiornare ed eliminare record da una tabella spesso lo stesso, symfony fornisce un meccanismo per generare tale codice.
Figura 4-1 - La pagina index creata in modo predefinito
Aggiungere una pagina
In symfony, la logica che sta dietro alle pagine è memorizzata nell'azione, mentre la presentazione è nei template. Le pagine senza logica richiedono (ancora) una azione vuota.
Aggiungere un'azione
La pagina "Buongiorno, mondo!" sarà accessibile attraverso un'azione show. Per crearla, è sufficiente aggiungere un metodo executeShow alla classe contenutoActions, come mostrato nel listato 4-2.
Listato 4-2 - Aggiungere un'azione vuol dire aggiungere un metodo Execute alla classe Action
<?php class contenutoActions extends sfActions { public function executeShow() { } }
Il nome del metodo dell'azione è sempre executeXxx(), dove la seconda parte del nome è il nome dell'azione con la prima lettera in maiuscolo.
Ora, se si accede al seguente URL:
http://localhost/frontend_dev.php/contenuto/show
symfony si lamenterà per il fatto che manca il template showSuccess.php. È normale; in symfony, una pagina è sempre costituita da un'azione e da un template.
caution
Gli URL (non i nomi dominio) sono case-sensitive e quindi lo sono anche in symfony (anche se i nomi del metodi in PHP sono case-insensitive). Questo significa che symfony restituirà un errore 404 se si prova a visualizzare sHow con il browser.
Aggiungere un template
L'azione si attende un template per visualizzare se stessa. Un template è un file localizzato nella cartella templates/ di un modulo, nominato in base all'azione e alla azione di terminazione. L'azione di terminazione predefinita è "success", quindi il file del template che deve essere creato per l'azione show deve essere chiamato showSuccess.php.
I template devono contenere solo codice di presentazione, quindi al loro interno bisogna utilizzare meno codice PHP possibile. Una pagina che mostra la scritta "Buongiorno, mondo!" può avere un template tanto semplice quanto quello mostrato nel listato 4-3.
Listato 4-3 - Il template contenuto/templates/showSuccess.php
<p>Buongiorno, mondo!</p>
Se è necessario eseguire del codice PHP nel template, bisogna evitare di utilizzare la normale sintassi PHP, come mostrato nel listato 4-4. Per i template è meglio utilizzare la sintassi PHP alternativa, come mostrato nel listato 4-5, in modo da rendere il codice più comprensibile anche per chi non è un programmatore PHP. Non solo il codice finale sarà perfettamente indentato, ma aiuterà anche a tenere il codice PHP complesso nell'azione, in quanto solo le istruzioni di controllo (if, foreach, while e così via) hanno una sintassi alternativa.
Listato 4-4 - L'suale sintassi PHP, buona per le azioni, ma cattiva per i template
<p>Buongiorno, mondo!</p> <?php if ($test) { echo "<p>".time()."</p>"; } ?>
Listato 4-5 - La sintassi alternativa PHP, buona per i template
<p>Buongiorno, mondo!</p> <?php if ($test): ?> <p><?php echo time(); ?></p> <?php endif; ?>
tip
Una buona regola per controllare se la sintassi del template è sufficientemente leggibile è quella che il file non deve contenere codice HTML stampato dall'echo di PHP o parentesi graffe. La maggior parte delle volte, quando si apre un <?php, verrà chiuso con ?> nella stessa riga.
Passare informazioni dall'azione al template
Il compito dell'azione è quello di fare tutte le elaborazioni complicate, il recupero dei dati, i controlli e assegnare variabili per il template che verranno visualizzate o verificate con istruzioni di controllo. Symfony rende gli attributi delle classi di azioni (accessibili attraverso $this->nomeVariabile nell'azione) direttamente accessibili al template nello spazio dei nomi globali (attraverso $nomeVariabile). I listati 4-6 e 4-7 mostrano come passare informazioni dall'azione al template.
Listato 4-6 - Impostare l'attributo di una azione nell'azione per renderlo disponibile nel template
<?php class contenutoActions extends sfActions { public function executeShow() { $today = getdate(); $this->hour = $today['hours']; } }
Listato 4-7 - Il template ha accesso diretto agli attributi dell'azione
<p>Buongiorno, mondo!</p> <?php if ($hour >= 18): ?> <p>O dovrei dire buona sera? Sono già le <?php echo $hour ?>.</p> <?php endif; ?>
Notare che l'utilizzo del tag breve di apertura (<?=, equivalente a <?php echo) non è raccomandato per applicazioni web professionali, perché il server web in produzione potrebbe essere in grado di interpretare più di un linguaggio di script e conseguentemente confondersi. Inoltre il tag di apertura breve non funziona con la configurazione PHP predefinita e necessita di modifiche sul server per essere attivata. In ultimo, quando si ha a che fare con l'XML e la validazione, si vengono a creare dei problemi, perché <? in XML ha un significato speciale.
note
Il template ha già accesso ad alcuni frammenti di dati senza la necessità di assegnare ogni singola variabile nell'azione. Ogni template può chiamare metodi degli oggetti $sf_request, $sf_params, $sf_response e $sf_user. Contengono dati relativi alla richiesta corrente, ai parametri della richiesta, risposta e sessione. Presto verrà spiegato come utilizzarli in modo efficiente.
Link a un'altra azione
Sappiamo già che c'è un disaccoppiamento totale tra il nome di una azione e l'URL utilizzata per chiamarla. Quindi se in un template si crea un link a update come nel listato 4-8, funzionerà solo con le rotte in modalità predefinita. Se successivamente si decide di cambiare il modo in cui gli URL devono apparire, sarà necessario rivedere tutti i template per modificare i collegamenti ipertestuali.
Listato 4-8 - Collegamenti ipertestuali, il modo classico
<a href="/frontend_dev.php/contenuto/update?name=anonymous"> Non dirò mai il mio nome </a>
Per evitare questo problema, nel creare collegamenti ipertestuali con le azioni dell'applicazione si dovrebbe sempre usare l'helper link_to(). Quando si vuole generare unicamente la parte dell'URL senza l'HTML, allora si può utilizzare l'helper url_for().
Un helper è una funzione PHP definita da symfony con lo scopo di essere usata all'interno dei template. Restituisce del codice HTML ed è più veloce da usare rispetto a scrivere il codice HTML a mano. Il listato 4-9 mostra l'uso degli helper per i collegamenti ipertestuali.
Listato 4-9 - Gli helper link_to() e url_for()
<p>Buongiorno, mondo!</p> <?php if ($hour >= 18): ?> <p>O dovrei dire buona sera? Sono già le <?php echo $hour ?>.</p> <?php endif; ?> <form method="post" action="<?php echo url_for('contenuto/update') ?>"> <label for="name">Qual è il tuo nome?</label> <input type="text" name="name" id="nome" value="" /> <input type="submit" value="Ok" /> <?php echo link_to('Non dirò mai il mio nome', 'contenuto/update?nome=anonymous') ?> </form>
L'HTML risultante sarà lo stesso del precedente, eccetto che quando si cambiano le regole delle rotte, tutti i template si comporteranno correttamente e riformatteranno gli URL di conseguenza.
L'utilizzo dei form merita un capitolo a sé stante, dato che symfony fornisce molti strumenti per renderli ancora più facili. Si imparerà di più su questi helper nel capitolo 10.
L'helper link_to(), così come altri helper, accetta un altro parametro per opzioni speciali e addizionali attributi per i tag. Il listato 4-10 mostra un esempio di opzioni passate come parametro e dell'HTML risultante. Le opzioni possono essere sia un array associativo che una semplice stringa con coppie chiave=valore separate da spazi.
Listato 4-10 - Molti helper accettano opzioni come parametri
// Opzioni come array associativo <?php echo link_to('Non dirò mai il mio nome', 'contenuto/update?nome=anonymous', array( 'class' => 'special_link', 'confirm' => 'Sei sicuro?', 'absolute' => true )) ?> // Opzioni come stringa <?php echo link_to('Non dirò mai il mio nome', 'contenuto/update?nome=anonymous', 'class=special_link confirm=Sei sicuro? absolute=true') ?> // Entrambi i modi hanno generano lo stesso risultato => <a class="special_link" onclick="return confirm('Sei sicuro?');" href="http://localhost/frontend_dev.php/contenuto/update/nome/anonymous"> Non dirò mai il mio nome</a>
Ogni volta che si utilizza un helper di symfony che genera un tag HTML, è possibile inserire ulteriori attributi al tag (come l'attributo class nell'esempio del listato 4-10) nelle opzioni. Questi attributi si possono anche scrivere nel modo "sporco e veloce" dell'HTML 4.0 (senza i doppi apici) e symfony li mostrerà con una formattazione XHTML. Questa è un'altra ragione per cui gli helper sono più veloci da scrivere rispetto all'HTML.
note
Essendo necessaria una ulteriore analisi e trasformazione, la sintassi con stringa è un po' più lenta della sintassi con gli array.
Come tutti gli helper di symfony, gli helper per i link sono numerosi e hanno molte opzioni. Il capitolo 9 li descrive in dettaglio.
Ottenere informazioni dalla Request
Se l'utente invia informazioni tramite un form (di solito in una richiesta POST) o tramite l'URL (richiesta GET), è possibile recuperare i dati relativi dall'azione con il metodo getParameter() dell'oggetto sfRequest. Il listato 4-11 mostra come in update, si recupera il valore del parametro nome.
Listato 4-11 - Recuperari i dati dal parametro Request dell'azione
<?php class contenutoActions extends sfActions { // ... public function executeUpdate($request) { $this->nome = $request->getParameter('nome'); } }
Per convenienza, tutti i metodi executeXxx() prendono come primo parametro l'oggetto corrente sfRequest.
Se l'elaborazione dei dati è semplice, non si avrà nemmeno bisogno di usare l'azione per recuperare i parametri della richiesta. Il template ha accesso a un oggetto chiamato $sf_params, che offre un metodo ``get() per recuperare i parametri di richiesta, proprio come il getParameter() nell'azione.
Se executeUpdate() fossero vuoti, il listato 4-12 mostra come il template updateSuccess.php dovrebbe recuperare lo stesso parametro nome.
Listato 4-12 - Recuperare i dati dei parametri della Request direttamente nel template
<p>Ciao, <?php echo $sf_params->get('nome') ?>!</p>
note
Perché non usare invece le variabili $_POST, $_GET, o $_REQUEST? Perché allora l'URL verrà formattato in modo diverso (come in http://localhost/articles/europe/france/finance.html, senza ? nè =), le normali variabili PHP non funzionano più e solo il sistema delle rotte sarà in grado di recuperare i parametri di richiesta. E si potrebbe voler aggiungere un filtro in ingresso per impedire l'iniezione di codice maligno, che è possibile solo se si mantengono tutti i parametri di richiesta in un solo contenitore di parametri.
L'oggetto $sf_paramsè più potente di un semplice getter equivalente a un array. Ad esempio, se si vuole fare il test dell'esistenza di un parametro di richiesta, si può semplicemente usare il metodo $sf_params->has() invece di verificare l'effettivo valore con get(), come nel listato 4-13.
Listato 4-13 - Fare il test dell'esistenza di un parametro richiesta nel template
<?php if ($sf_params->has('nome')): ?> <p>Buongiorno, <?php echo $sf_params->get('nome') ?>!</p> <?php else: ?> <p>Buongiorno, John Doe!</p> <?php endif; ?>
Si potrebbe avere già capito che questo può essere scritto in una sola riga. Come con la maggior parte dei metodi get di symfony, sia il metodo $request->getParameter() nella azione che il metodo $sf_params->get() nel template (che, di fatto, chiama lo stesso metodo sull'oggetto stesso) accettano un secondo parametro: il valore predefinito da utilizzare se il parametro richiesta non è presente.
<p>Buongiorno, <?php echo $sf_params->get('nome', 'John Doe') ?>!</p>
Riepilogo
In symfony, le pagine sono formate da una azione (un metodo nel file actions/actions.class.php file prefissato con execute) e un template (un file nella cartella templates/, che generalmente termina con Success.php). Queste sono raggruppate in moduli, in base alla loro funzione nell'applicazione. La scrittura dei template è facilitata dagli helper: sono funzioni fornite da symfony che restituiscono codice HTML. Ed è necessario pensare all'URL come a una parte della risposta, che può essere formattata in base alle proprie necessità, proprio per questo si dovrebbe evitare di utilizzare qualsiasi riferimento diretto all'URL nei nomi delle azioni o nel recupero dei parametri della richiesta.
Una volta che questi principi di base vengono compresi, si può già procedere con la scrittura di una completa applicazione web con symfony. Ma sarebbe un lavoro più lungo di quanto dovrebbe, dal momento che quasi tutte le attività che si dovranno realizzare nel corso dello sviluppo dell'applicazione vengono facilitate in un modo o nell'altro da qualche caratteristica peculiare di symfony ... ed è per questo che il libro non si ferma qua.
This work is licensed under the GFDL license.