Zend_Controller_Router_Route_Regex
En plus des routes par défaut, et statique, les routes exprimées par expression
régulière sont acceptées. Ces routes sont plus puissantes que les autres, mais aussi plus
complexes à mettre en oeuvre et un peu plus lentes en matière d'analyse.
Comme les routes standards, cette route doit être initialisée avec une définition et
des valeurs par défaut. Créons par exemple avec une route "archive" en utilisant les routes
par expressions régulières :
'archive',
'action' => 'show'
)
);
$router->addRoute('archive', $route);
]]>
Chaque motif d'expression régulière sera injecté dans l'objet de requête. Avec
l'exemple ci-dessus, en utilisant http://domain.com/archive/2006, la tableau
résultat devrait ressembler à :
'2006',
'controller' => 'archive',
'action' => 'show'
);
]]>
Les slashs de début et de fin sont supprimés de l'URL dans le routeur (avant
l'intervention de la route).Ainsi, pour faire correspondre l'URL
http://domain.com/foo/bar/, il faudra une expression du style
foo/bar, et non pas /foo/bar.
Les caractères de spécification de début et fin d'expression sont automatiquement
rajoutés au motif ('^' et '$', respectivement). De ce fait, vous ne devriez pas les
utiliser manuellement.
Cette classe de route utilise le séparateur # comme délimiteur de
motif. Vous devrez donc échapper ce caractère si vous l'utilisez, et non pas le slash
(par défaut pour un motif d'expression régulière). Le caractère "#" est cependant
rarement utilisé dans une URL.
Vous pouvez retourner le contenu des sous-masques :
getRequest();
$year = $request->getParam(1); // $year = '2006';
}
]]>
Attention, la clé est un entier (1), et non une chaîne ('1').
Cette route ne fonctionnera pas encore tout à fait comme la route standard, car la
valeur par défaut pour "year" n'est pas indiquée. Attention par contre, vous
risquez d'avoir un problème avec les slashs finaux même si nous déclarons une valeur par
défaut pour "year" et que celui-ci est facultatif. La solution consiste à
traiter ce slash, mais sans le capturer :
'2006',
'controller' => 'archive',
'action' => 'show'
)
);
$router->addRoute('archive', $route);
]]>
Nous voyons apparaître tout de même un problème : gérer des chiffres, comme clés pour
les paramètres n'est pas très intuitif. C'est là qu'entre en jeu le troisième paramètre du
constructeur de Zend_Controller_Router_Route_Regex. Il accepte un
tableau faisant correspondre les numéros des paramètres et leur nom respectif :
'archive',
'action' => 'show'
),
array(
1 => 'year'
)
);
$router->addRoute('archive', $route);
]]>
Les valeurs suivantes seront injectées dans l'objet de requête :
'2006',
'controller' => 'archive',
'action' => 'show'
);
]]>
Il est aussi possible d'inverser les clé et valeurs du tableau :
'year')
);
// OU
$route = new Zend_Controller_Router_Route_Regex(
'archive/(\d+)',
array( ... ),
array('year' => 1)
);
]]>
Attention de toujours manipuler des entiers (1 et non "1")
Si vous inversez comme dans le deuxième cas de l'exemple ci-dessus, la clé alors
reçue par l'objet de requête ne représente plus un chiffre, mais le nom du paramètre. Vous
pouvez évidemment mixer les comportements :
1)
);
]]>
Si nous appelons l'URL http://domain.com/archive/2006/page/10 avec la
route définie ci-dessus, les paramètres trouvés seront :
'2006',
2 => 10,
'controller' => 'archive',
'action' => 'show'
);
]]>
Étant donné que les route par expression régulière ne sont pas facilement réversible,
vous devrez préparer le motif vous-même dans le but d'utiliser l'aide de vue "url". Ce
chemin inverse doit être défini comme une chaîne traitable par la fonction
sprintf() de PHP, et définie en quatrième paramètre du constructeur de la
route Regex :
1),
'archive/%s'
);
]]>
Quels sont donc les avantages des routes par expressions régulières (Regex) ? C'est
que vous pouvez décrire n'importe quelle URL avec. Imaginez un blog, vous voulez créer des
URLs du type http://domain.com/blog/archive/01-Using_the_Regex_Router.html,
afin de décomposer la dernière partie de l'URL en un ID d'article, et un cours texte
descriptif (01-Using_the_Regex_Router.html). Ceci n'est pas possible avec la
route standard. En revanche, avec la route Regex, vous pouvez écrire :
'blog',
'action' => 'view'
),
array(
1 => 'id',
2 => 'description'
),
'blog/archive/%d-%s.html'
);
$router->addRoute('blogArchive', $route);
]]>
Comme vous le voyez, ce type de route ajoute une solution flexible concernant la
gestion des URLs et leur routage.