Pré-requis: Zend_Controller_RewriteRouter.
Nous allons voir aujourd'hui comment générer automagiquement des URLs à partir des routes définies dans le RewriteRouter, ainsi que les avantages que cela présente. Le Helper que nous allons utiliser nécessite le stockage du routeur dans le registre:
Zend::register('router', $router);
Avant de voir le Helper lui même, un petit Use Case. Admettons que vous développiez une application de gestion de petites annonces, vous aurez à un moment ou un autre à créer un lien quelconque pour, par exemple, créer une annonce, et en voir les détails. Disons que vous ayez des routes route du genre (je zappe les defaults):
announceCreate.route = /announce/create
announceDetails.route = /announce/:id/details
L'objectif est de pouvoir créer les liens grâce au code suivant (à partir de la view):
<a href="<?php echo $this->href('announceCreate'); ?>">Créer une annonce</a>
<a href="<?php echo $this->href('announceDetails', array('id' => $announce->id)); ?>">Voir l'annonce</a>
Et comme le Zend Framework est bien fait, c'est très simple à réaliser sous forme de ViewHelper:
class Zend_View_Helper_Href {
/**
* Returns the href to a given route
*
* @param string $routeName
* @param array $args
* @return string
*/
public function href($routeName, $args = array()) {
try {
return Zend::registry('router')->getRoute($routeName)->assemble($args);
} catch (Zend_Controller_Router_Exception $e) {
return '#404';
}
}
}
Tellement simple que pour combler un peu je vous offre le docblock qui va avec ;-)
Là où ça devient très pratique, c'est quand on souhaite localiser les URLs. Par exemple, imaginons que vous souhaitiez françiser les URLs pour, par exemple, améliorer votre référencement. Vous n'avez qu'a définir un jeu de routes fr_FR, par exemple ainsi:
announceCreate.route = /annonce/creer
announceDetails.route = /annonce/:id/details
[routes_en_UK]
announceCreate.route = /announce/create
announceDetails.route = /announce/:id/details
[routes:route_fr_FR]
announceCreate.defaults.controller = announce
announceCreate.defaults.action = create
announceDetails.defaults.controller = announce
announceDetails.defaults.action = details
L'utilisation de l'héritage géré par Zend_Config nous permet ici d'éviter la redondance des defaults.
Elle est pas belle la vie ?
Note: cette fonctionnalitée est prévue pour être builtin plus tard.