Finora su form c’era qualcosa qua e la, ma niente di concreto. Ora è iniziata con quattro capitoli la pubblicazione dello pseudo libro “the symfony Forms in Action“. Grande notizia! Utilizzando questa documentazione, più prendendo spunto da uno snippet all’interno della documentazione, ho creato un completo form di login per il mio forum con symfony.

Il form si poggia su tre file, all’interno della directory lib/: lib/myLoginValidator.class.php, lib/sfWidgetFormSchemaFormatterDiv e lib/form/LoginForm.class.php. Vediamoli:

LoginForm.class.php

[source:php]
<?php

/**
* Login form.
*
* @package form
* @subpackage login
* @version SVN: $Id: sfPropelFormTemplate.php 6174 2007-11-27 06:22:40Z fabien $
*/
class LoginForm extends sfForm
{

private function initValidators()
{
$this->usernameValidator = new sfValidatorAnd
(
array
(
new sfValidatorString
(
array
(
‘min_length’ => 4,
‘max_length’ => 50
),
array
(
‘min_length’ => ‘The username should be al least three characters long’,
‘max_length’ => ‘The username should be be fifty characters long al most’
)
),

new sfValidatorCallback
(
array
(
‘callback’ => array
(
‘myLoginValidator’, ‘execute’
),
‘arguments’ => array
(
)
),
array
(
‘invalid’ => ‘This username/password combination is unknown’
)
)
),

array
(
‘required’ => true
),

array
(
‘required’ => ‘The username is mandatory’
)
);

$this->passwordValidator = new sfValidatorString
(
array
(
‘required’ => true
),
array
(
‘required’ => ‘The password is mandatory’
)
);

$this->referrerValidator = new sfValidatorString
(
array
(
‘required’ => false
)
);

}

private function initWidgets()
{

$this->usernameWidget = new sfWidgetFormInput
(
array(),
array
(
‘id’ => ‘username’,
‘size’ => 25
)
);

$this->passwordWidget = new sfWidgetFormInputPassword
(
array(),
array
(
‘id’ => ‘password’,
‘size’ => 25
)
);

$this->referrerWidget = new sfWidgetFormInputHidden
(
array(),
array
(
‘id’ => ‘referrer’
)
);

}

public function configure()
{
$this->initValidators();
$this->initWidgets();

$this->setValidators
(
array
(
‘username’ => $this->usernameValidator,
‘password’ => $this->passwordValidator,
‘referrer’ => $this->referrerValidator
)
);

$this->setWidgets
(
array
(
‘username’ => $this->usernameWidget,
‘password’ => $this->passwordWidget,
‘referrer’ => $this->referrerWidget
)
);

$decorator = new sfWidgetFormSchemaFormatterDiv
(
$this->getWidgetSchema()
);

$this->getWidgetSchema()->addFormFormatter
(
‘div’, $decorator
);

$this->getWidgetSchema()->setFormFormatterName
(
‘div’
);

$this->getWidgetSchema()->setHelps
(
array
(
‘username’ => ‘Please enter your username’,
‘password’ => ‘Please enter your password’
)
);
}

}
[/source]

sfWidgetFormSchemaFormatterDiv
[source:php]
<?php

class sfWidgetFormSchemaFormatterDiv extends sfWidgetFormSchemaFormatter
{
protected
$rowFormat = ‘%field%
%error%
‘,
$helpFormat = ‘<span class=”help”>%help%</span>’,
$errorRowFormat = ‘<div>%errors%</div>’,
$errorListFormatInARow = ‘%errors%’,
$errorRowFormatInARow = ‘<div class=”clearer”></div><span class=”formError”>%error%</span><div class=”clearer”></div>’,
$namedErrorRowFormatInARow = ‘%name%: %error%<br />’,
$decoratorFormat = ‘<div id=”formContainer”>%content%</div>’;
}
[/source]

myLoginValidator
[source:php]
<?php

class myLoginValidator
{

public static function execute($validator, $value, $arguments)
{
$username = sfContext::getInstance()->getRequest()->getParameter(‘username’);
$password = sfContext::getInstance()->getRequest()->getParameter(‘password’);
$c = new Criteria();
$c->add(AuthorPeer::NAME, $username);
$c->add(AuthorPeer::PASSWORD, $password);
$user = AuthorPeer::doSelectOne($c);
if ($user)
{
sfContext::getInstance()->getUser()->setData(
$user->getID(),
$user->getGroupID(),
$user->getName()
);
}
else
{
throw new sfValidatorError($validator, ‘invalid’, array(‘value’ => $value, ‘invalid’ => $validator->getOption(‘invalid’)));
}
}

}
[/source]

L’uso è molto semplice, come vediamo ora nell’azione e nel template:
apps/frontend/modules/user/actions/actions.class.php
[source:php]
public function executeLogin($request)
{
$this->getUser()->clearData();
$this->getUser()->setLogged(false);

$this->form = new LoginForm();

if ($request->isMethod(‘post’))
{
$this->form->bind(
array (‘username’ => $request->getParameter(‘username’),
‘password’ => $request->getParameter(‘password’),
‘referrer’ => $request->getParameter(‘referrer’)
)
);

$this->form->setDefault(‘referrer’, $request->getParameter(‘referrer’));

if ($this->form->isValid())
{
$this->getUser()->setLogged(true);
$this->redirect($request->getParameter(‘referrer’));
}
else
{
$this->form->setDefault(‘referrer’, $request->getParameter(‘referrer’));
}
}
else
{
$this->form->setDefault(‘referrer’, $_SERVER['HTTP_REFERER']);
}
}
[/source]
apps/frontend/modules/user/templates/loginSuccess.php
[source:php]
<h1>Login</h1>
<div id=”formContainer”>
<?php if ($form->getErrorSchema()->getErrors()): ?>
<div id=”errors”>
<ul>
<?php foreach($form->getErrorSchema() as $error): ?>
<li><?php echo $error ?></li>
<?php endforeach; ?>
</ul>
</div>
<?php endif; ?>
<form action=”<?php echo url_for(‘@user_login’) ?>” method=”post”>
<div class=”formElement”>
<?php echo $form['username']->renderLabel($form['username']->renderLabelName()) ?>

<?php echo $form['username']->renderRow($form->getWidgetSchema()->getHelp(‘username’)) ?>
</div>
<div class=”clearer”></div>
<div class=”formElement”>
<?php echo $form['password']->renderLabel($form['password']->renderLabelName()) ?>

<?php echo $form['password']->renderRow($form->getWidgetSchema()->getHelp(‘password’)) ?>
</div>
<div class=”clearer”></div>
<div class=”formElement”>
<?php echo $form['referrer']->render(array(‘value’ => $form->getDefault(‘referrer’))) ?>
</div>
<div class=”clearer”></div>
<div class=”formElement”>
<button type=”submit”>Login</button>
</div>
</form>
</div>
[/source]
Per oggi ho intenzione di lasciarvi con questa vagonata di codice da studiare, ed un consiglio: date un’occhiata alla documentazione, che come sempre è per symfony di altissimo livello. Nel caso qualcosa non fosse chiaro non esitate a chiedere, nei commenti. A presto!

Ma prima di questo, voglio solo aggiornare il codice postato l’altro giorno. La funzione findData infatti non è ottimizzata, in quanto carica tutti i record indiscriminatamente. Per questo va modificata come segue:

private function findData($forumID)
{
$c = new Criteria();
$c->add(ForumPeer::PARENT_ID, $forumID);
$this->childs = ForumPeer::doSelect($c);
$c = new Criteria();
$c->add(ThreadPeer::FORUM_ID, $forumID);
$c->addDescendingOrderByColumn(ThreadPeer::UPDATED_ON);
$this->limit = ($this->getRequest()->getParameter('page', 1) * 10) - 1;
$this->offset = ($this->getRequest()->getParameter('page', 1) - 1) * 10;
$this->page = $this->getRequest()->getParameter('page', 1);
$c->setLimit($this->limit);
$c->setOffset($this->offset);
$this->threads = ThreadPeer::doSelect($c);
}

Con questo codice aggiungo ai criteri di selezione un ordinamento discendente sulla colonna updated_on, ed aggiungo un limite ed un offset in base al parametro get <code>page</code>. Utilizzo la forma $this->limit e non semplicemente $limit (anche per offset e page) perché avrò bisogno di accedere ad essi nella vista..

..che vi presento ora (apps/frontend/modules/forum/templates/viewSuccess.php):

<?php foreach ($forum->getPath() as $path): ?>
<?php echo link_to($path->getTitle(),'@view_forum_by_title?title='.$path->getTitle()) ?> >>
<?php endforeach; ?>

<h1><?php echo $forum->getTitle() ?> Forum</h1>
<h3><?php echo $forum->getDescription() ?></h3>

<?php if (count($childs) > 0): ?>
<h2>Sub Forums:</h2>
<ul>

<?php foreach ($childs as $child): ?>
<li><?php echo link_to($child->getTitle(),'@view_forum_by_title?title='.$child->getTitle()) ?></li>
<?php endforeach; ?>

</ul>
<?php endif; ?>

<h2>Threads:</h2>
<?php if (count($threads) > 0): ?>
<ul>

<?php foreach ($threads as $thread): ?>
<li><?php echo link_to($thread->getTitle(),'@view_thread_by_title?id='.$thread->getID().'&title='.$thread->getTitle()) ?></li>
<?php endforeach; ?>

</ul>
<?php if ($page > 1): ?>
<?php echo link_to('< '.($page - 1).' <', '@view_forum_by_title?id='.$forum->getID().'&title='.$forum->getTitle().'&page='.($page - 1), array ('class' => 'pager')) ?>
<?php endif; ?>

<?php if ($forum->getThreadsNumber() > $limit): ?>
<?php echo link_to('> '.($page + 1).' >', '@view_forum_by_title?id='.$forum->getID().'&title='.$forum->getTitle().'&page='.($page + 1), array ('class' => 'pager')) ?>
<?php endif; ?>

<?php else: ?>

<h3>No threads in this forum</h3>
<?php endif; ?>

<?php if ($sf_user->can('create_thread')): ?>
<?php echo link_to('Create new Thread!','@new_thread_in_forum?id='.$forum->getID().'&title='.$forum->getTitle()) ?>
<?php endif; ?>

Ripeto che comunque è un work in progress, modifico il progetto ogni giorno quindi è soggetto a modifiche. Alla fine di questi post su symfony renderò disponibile la versione finale.

Da notare come le variabili che nel controller sono nella forma $this->variabile nella view sono semplicemente $variabile.
Per il resto faccio notare che i metodi $forum->getPath() e $user->can(‘create_thread’) sono definite da me rispettivamente in lib/model/Forum.php e apps/frontend/lib/myUser.class.php. Le vedremo meglio in seguito, per ora sappiate che servono per ottenere il percorso in cui è il forum, partendo la forum id#1, passando per i figli, mentre la seconda gestisce i permessi dell’utente corrente (o nessun utente, nel caso non sia loggato).

Questa è la vista legata alla singola azione, ma c’è altro. Ogni applicazione in symfony ha un layout definito in apps/*/config/view.yml. Apriamolo e si presenterà cosi:

default:
http_metas:
content-type: text/html

metas:
title:        Shiny!
#description:  symfony project
#keywords:     symfony, project
#language:     en
robots:       index, follow

stylesheets:    [main, default, my]

javascripts:    []

has_layout:     on
layout:         layout</pre>

has_layout specifica che l’applicazione ha un template generale, mentre la criptica riga seguente layout: layout dice a symfony che il layout dell’applicazione avrà nome layout.php, nella cartella apps/*/templates/.

Ed ora vediamolo, il nostro layout.php:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<?php include_http_metas() ?>
<?php include_metas() ?>
<?php include_title() ?>
</head>
<body>
<!-- start header -->
<div id="header">
<div id="logo">
<h1><?php echo link_to('Shiny!','@homepage') ?></h1>
<p>Built with <?php echo link_to('symfony 1.1','http://www.symfony-project.org') ?></p>
</div>
<div id="search">
<form method="post" action="<?php echo url_for('forum/search') ?>">
<fieldset>
<input id="s" type="text" name="s" value="" class="text" />
<input id="x" type="submit" value="Search" class="button" />
</fieldset>
</form>
</div>
</div>
<!-- end header -->
<!-- start page -->
<div id="page">
<!-- start content -->
<div id="content">
<?php echo $sf_content ?>
</div>
<!-- end content -->
<!-- start sidebar -->
<div id="sidebar">
<ul>
<li>
<h2><?php echo (($sf_user->isLogged()) ? $sf_user->getName() : 'User') ?> Menu</h2>
<ul>
<?php if($sf_user->isLogged()): ?><li><?php echo link_to('Control Panel','@user_control_panel') ?></li>
<li><?php echo link_to('Logout','@user_logout') ?></li>
<?php else: ?><li><?php echo link_to('Login','@user_login') ?></li>
<li><?php echo link_to('Register','@user_registration') ?></li>
<?php endif; ?></ul>
</li>
<li>
<h2>Misc</h2>
<ul>
<li><?php echo link_to('Advanced search','@advanced_search') ?></li>
</ul>
</li>
</ul>
</div>
<!-- end sidebar -->
<div class="clearer"> </div>
</div>
<!-- end page -->
<!-- start footer -->
<div id="footer">
<p>©2008 All Rights Reserved.  • </a></p>
</div>
<!-- end footer -->
</body>
</html>

Tralasciando la struttura fatta di div per l’aspetto grafico per l’applicazione, sottolineo come $sf_content contenga il risultato dell’elaborazione del template per il resto sono altre funzioni semplici come quelle definite su $sf_user, che come detto tratterò in seguito.

Ora spiego la funzione link_to(), utilizzata più volte: il primo parametro è il testo che apparirà nel link, il secondo è la destinazione del link. Se è una stringa come quelle utilizzate da me, preceduta dal simbolo @, allora symfony cercherà la regola con quel nome definita nel file di routing, altrimenti accetterà un valore del tipo “modulo/azione”, con eventuali parametri nella classica forma “?parametro=valore&parametro2=valore2″. Inoltre link_to ha un terzo parametro facoltativo, che è un array associativo dove possiamo definire ad esempio classe, id ed altre proprietà del link. Funziona cosi:

<?php echo link_to('Questo è un link', 'modulo/azione?parametro1=valore1&parametro2=valore2', array('class' => 'classe1', 'id' => 'id1')) ?>

Per oggi è tutto, alla prossima!

Iniziamo generando tre moduli per la nostra applicazione frontend:

php symfony generate:module frontend forum
php symfony generate:module frontend thread
php symfony generate:module frontend user

Questo creerà tre directory all’interno di apps/frontend/modules/, contenenti a loro volta le cartelle template e actions.

Ora apriamo il file apps/frontend/config/routing.yml e modifichiamolo per renderlo come segue:

homepage:
  url:   /
  param: { module: forum, action: index }

view_forum_by_id:
  url:   /view-forum/:id
  param: { module: forum, action: viewById }
  requirements: { id: \d+ }

view_forum_by_title:
  url:   /view-forum/:title
  param: { module: forum, action: viewByTitle }

Questo file spiega le regole di routing che la nostra applicazione dovrà seguire. Ad ogni regola corrisponde un nome (hompage, view_forum_by_id, e view_forum_by_title) seguita da un pattern per l’url a cui la regola dovrà sottostare, dai parametri della regola, ed eventualmente da dei requisiti a cui i parametri devono corrispondere.
Prendiamo per esempio la regola view_forum_by_id: deve avere un url che “matchi” il pattern /view-forum/:id, ovvero deve iniziare con uno slash, la stringa view-forum, un altro slash e una variabile id (distinta dai due punti :). Nella sezione param indichiamo che nel caso l’url corrisponda a questa regola, symfony deve richiamare il modulo forum e l’azione viewById.
Con requirements poi, restringiamo il valore di id ai soli interi, tramite la notazione \d+ (vedasi espressioni regolari).

Le regole sono in ordine di priorità, quindi la prima che combacia con l’url richiesto sarà quella applicata.
Per questo è opportuno lasciare alla fine del file le regole predefinite

default_symfony:
  url:   /symfony/:action/*
  param: { module: default }

default_index:
  url:   /:module
  param: { action: index }

default:
  url:   /:module/:action/*

In modo che in ogni caso di trovi qualche corrispondenza.

Ora modifichiamo il file apps/frontend/modules/forum/actions/actions.class.php, cerchiamo il metodo executeIndex e al posto del forward pre-inserito scriviamo noi questo:

  $this->redirect('@view_forum_by_id?id=1');

In questo modo effettuiamo un redirect, con destinazione la regola view_forum_by_id (specificata dalla presenza della @ prima del nome), assegnando ad id il valore 1. Il forum con id 1 è quello pre-definito, che è padre di tutti i sotto-forum.

Andiamo ora oltre, e aggiungiamo i seguenti metodi:

public function executeViewByID()
{
    // Retrieves data using the forum id
    $forumID = $this->getRequest()->hasParameter('id') ? $this->getRequest()->getParameter('id') : 1;
    $this->forum = ForumPeer::retrieveByPk($forumID);
    $this->forward404Unless($this->forum);

    $this->findData($forumID);

    // Set a common template
    $this->setTemplate('view');
}
public function executeViewByTitle()
{
    // Retrieves data using the forum title
    $forumTitle = $this->getRequest()->hasParameter('title') ? $this->getRequest()->getParameter('title') : 'Main';
    $c = new Criteria();
    $c->add(ForumPeer::TITLE, $forumTitle);
    $this->forum = ForumPeer::doSelectOne($c);
    $this->forward404Unless($this->forum);
    $forumID = $this->forum->getId();

    // Executes a common function for addictional infos
    $this->findData($forumID);

    // Set a common template
    $this->setTemplate('view');
}
private function findData($forumID)
{
    $c = new Criteria();
    $c->add(ForumPeer::PARENT_ID, $forumID);
    $this->childs = ForumPeer::doSelect($c);
    $c = new Criteria();
    $c->add(ThreadPeer::FORUM_ID, $forumID);
    $this->threads = ThreadPeer::doSelect($c);
}

In symfony i metodi che iniziano con execute, e sono seguiti da un nome (la cui prima lettera maiuscola) sono delle azioni richiamabili dal browser. In questo caso executeViewByID ed executeViewByTitle sono due azioni valide, mentre findData è un metodo richiamato dai due per eseguire del codice in comune, quindi non è un azione, e lo si dichiara privato e senza la keyword execute.

Ora andiamo a vedere nel dettaglio ciò che accade nelle azioni:

1    $forumID = $this->getRequest()->hasParameter('id') ? $this->getRequest()->getParameter('id') : 1;
2    $this->forum = ForumPeer::retrieveByPk($forumID);
3    $this->forward404Unless($this->forum);

4    $this->findData($forumID);

5    $this->setTemplate('view');

Riga 1
Espressione ternaria: se l’oggetto request ha il parametro id, allora assegniamo a $forumID quel valore, altrimenti assegniamo 1 (il valore di default).
Riga 2
A $this->forum assegniamo il risultato della ricerca tramite chiave primaria (metodo statico retrieveByPk, ovvero Primary Key) con valore $forumID sull’oggetto ForumPeer, ovvero la rappresentazione della tabella (l’oggetto Forum, a cui appartiene $this->forum è la rappresentazione della singola tupla).
Riga 3
Redirezioniamo l’elaborazione ad una pagina di 404 a meno che $this->forum non abbia un valore valido.
Riga 4
Richiamiamo il metodo findData, che esegue un’elaborazione in comune ai due viewBy*.
Riga 5
I due viewBy* utilizzando lo stesso template, quindi tramite questa istruzione assegno a quest’azione il template view.

Ora nel metodo privato findData

1    $c = new Criteria();
2    $c->add(ForumPeer::PARENT_ID, $forumID);
3    $this->childs = ForumPeer::doSelect($c);
4    $c = new Criteria();
5    $c->add(ThreadPeer::FORUM_ID, $forumID);
6    $this->threads = ThreadPeer::doSelect($c);

Riga 1
Creiamo una nuova istanza della classe Criteria, ovvero la classe utilizzata per realizzare le query.
Riga 2
Specifichiamo che il valore di forums.parent_id (rappresentato dalla costante ForumPeer::PARENT_ID) deve valere $forumID
Riga 3
All’array $this->childs assegniamo tutte le corrispondenze della query preparata
Riga 4,5,6
Stesso significato delle precedenti, solo che al posto di ottenere i forum “figli” ottengo i thread appartenenti a quel forum

Oggi abbiamo visto le azioni di base, la prossima volta (per non appesantire troppo il post) vedremo il template associato a queste azioni, più alcune cose sulla gestione dell’utente.
Per eventuali dubbi ci sono i commenti, sarò felice di rispondere, quindi non siate timidi. Alla prossima!

Finalmente! Dopo le prime puntate dove ci siamo occupati più che altro di teoria, ora è giunto il momento di vedere davvero del codice PHP.

Anzi, prima di fare ciò dobbiamo dedicarci un attimo al database. Come ho accennato, questo nostro progetto ci porterà alla realizzazione di un forum, che ho affettuosamente chiamato “shiny!“. Ora, abbiamo bisogno di definire concretamente questo forum, per poterci lavorare sopra. Per poter utilizzare un database in symfony, è necessario descrivere la struttura delle tabelle attraverso il file config/schema.yml. Ecco quello che utilizzo io:

propel:
  groups:
    _attributes: { phpName: Group }
    id:          ~
    name:        varchar(50)
  authors:
    _attributes: { phpName: Author }
    id:          ~
    group_id:    { foreignTable: groups, foreignReference: id }
    name:        varchar(50)
    password:    varchar(50)
    image:       varchar(255)
    signature:   varchar(255)
    advises:     integer
    created_on:  timestamp
  forums:
    _attributes: { phpName: Forum }
    id:          ~
    title:       varchar(50)
    description: varchar(255)
    parent_id:   { foreignTable: forums, foreignReference: id }
  threads:
    _attributes: { phpName: Thread }
    id:          ~
    forum_id:    { foreignTable: forums, foreignReference: id }
    author_id:   { foreignTable: authors, foreignReference: id }
    created_on:  timestamp
    title:       varchar(50)
  posts:
    _attributes: { phpName: Post }
    id:          ~
    author_id:   { foreignTable: authors, foreignReference: id }
    thread_id:   { foreignTable: threads, foreignReference: id }
    created_on:  timestamp
    updated_on: timestamp
    text:        longvarchar

Chiarimento rapido. YAML è un linguaggio di markup dalla sintassi più coincisa rispetto ad XML, che si basa sull’indentazione con gli spazi (niente tab quindi). Per ulteriori informazioni potete visitare la pagina ufficiale del progetto.

Ora analizziamo per bene ciò che ho appena scritto: L’elemento “propel:” è il padre di tutti gli altri, e deve esserci forzatamente su utilizzate questo ORM (che è il default plugin di symfony). Ogni figlio di propel è il nome con cui la tabella è salvata nel DBMS, seguita dall’elemento _attributes; Tra le parentesi graffe l’elemento phpName indica il nome che avrà la classe generata in PHP (per convenzione singolare con la prima lettera maiuscola). Di seguito poi ogni elemento delle tabelle, dove id: ~ significa chiave primaria. Gli altri elementi credo che siano comprensibili, per cui non mi dilungo tanto nella spiegazione. In caso di dubbi scriveteli pure nei commenti.

Ora da linea di comando date questi comandi:

php symfony propel:build-model
php symfony propel:build-forms

Seguiti da:

php symfony propel:build-sql

E troverete il file sql generato per la creazione del nostro database all’interno della directory data/sql sotto il nome di lib.model.schema.sql.
Siccome probabilmente questo file non sarà al 100% corretto e pronto all’inserimento, vi consiglio di aprilo e correggerlo a mano, usandolo solo come base.
Ultima cosa prima di partire sarà modificare il file config/databases.yml e trasformarlo nel seguente:

all:
  propel:
  class:  sfPropelDatabase
  param:
  dsn: mysql://user:password@localhost/database

Ovviamente adattando user, password e database alla vostra situazione.
Con la configurazione abbiamo finito, la prossima volta realizzeremo i controller della nostra applicazione. Alla prossima!