Zend_Controller_Router_Route_Regex
Zusätzlich zu den standard statischen Routetypen, ist ein Regular Expression Routetyp
vorhanden. Diese Route bietet mehr Power und Flexibilität als die anderen, aber auf leichten
Kosten von Komplexität. Wärend der selben Zeit, sollte Sie schneller als die Standardroute
sein.
Wie die Standardroute, muß diese Route mit einer Routendefinition und einigen Standardwerten
initialisiert werden. Lasst uns eine Archivroute als Beispiel erstellen, ähnlich der zuletzt
definierten, nur das dieses Mal die Regex Route verwendet wird:
'archive',
'action' => 'show'
)
);
$router->addRoute('archive', $route);
]]>
Jedes definierte Regex Subpattern wird in das Anfrageobjekt injiziiert. Mit dem obigen
Beispiel, nachdem http://domain.com/archive/2006 erfolgreich geprüft
wurde, kann das resultierende Wertearray so aussehen:
'2006',
'controller' => 'archive',
'action' => 'show'
);
]]>
Führende und folgende Schrägstriche werden von der URL im Router vor
dem Vergleich entfernt. Als Ergebnis, wird ein Vergleich der URL
http://domain.com/foo/bar/, ein Regex von
foo/bar inkludieren, aber nicht /foo/bar.
Zeilenbeginn und Endanker (normalerweise '^' und '$') werden automatisch allen
Ausdrücken vor- und nachgesetzt. Deswegen sollten Sie nicht in den Regular Expressions
verwendet werden, und der komplette String sollte entsprechen.
Diese Routeklasse verwendet das '#' Zeichen als Begrenzer. Das
bedeutet das ein Hashzeichen ('#') kommentiert werden muß aber keine Schrägstriche ('/')
in der Routendefinition. Da das '#' Zeichen (Anker genannt) selben an einen Webserver
übergeben wird, wird man dieses Zeichen selten in der eigenen regex verwenden.
Die Inhalte von definierten Subpattern können auf dem üblichen Weg bekommen werden:
getRequest();
$year = $request->getParam(1); // $year = '2006';
}
]]>
Beachte das der Schlüssel ein Integer ist (1) anstatt ein String ('1').
Diese Route wird jetzt noch nicht exakt gleich wie Ihr Gegenspieler, die Standardroute,
arbeiten da der Standard für 'year' noch nicht gesetzt ist. Und was jetzt noch nicht
offensichtlich ist, ist das wir ein Problem mit endenden Schrägstrichen haben, selbst wenn
wir einen Standard für das Jahr definieren und das Subpattern optional machen. Die Lösung
ist, den ganzen year Teil optional zu nachen zusammen mit dem Schrägstrich, aber nur den
nummerischen Teil zu holen:
'2006',
'controller' => 'archive',
'action' => 'show'
)
);
$router->addRoute('archive', $route);
]]>
Jetzt betrachten wir das Problem das möglicherweise schon selbst gefunden wurde. Die
Verwendung von Integer basierten Schlüsseln für Parameter ist keine einfach zu handhabende
Lösung und kann, während einer langen Laufzeit, potentiell problematisch sein. Hier kommt der
dritte Parameter ins Spiel. Dieser Parameter ist ein assoziatives Array das einer Karte von
Regex Subpatterns zu Parametern benannten Schlüsseln entspricht. Betrachten wir ein
einfacheres Beispiel:
'archive',
'action' => 'show'
),
array(
1 => 'year'
)
);
$router->addRoute('archive', $route);
]]>
Als Ergebnis werden die folgenden Werte in die Anfrage injiziiert:
'2006',
'controller' => 'archive',
'action' => 'show'
);
]]>
Die Karte kann in jede Richtung definiert werden damit Sie in jeder Umgebung funktioniert.
Schlüssel können Variablennamen oder Indezes von Subpattern enthalten:
'year')
);
// ODER
$route = new Zend_Controller_Router_Route_Regex(
'archive/(\d+)',
array( ... ),
array('year' => 1)
);
]]>
Schlüssel von Subpattern müssen durch Integer repräsentiert werden.
Es gilt zu beachten das der nummerische Index in den Anfragewerten jetzt weg ist und eine
benannte Variable statt Ihm angezeigt wird. Natürlich können nummerische und benannte
Variablen gemischt werden wenn das gewünscht ist:
1)
);
]]>
Das führt zu gemischten Werten die in der Anfrage vorhanden sind. Als Beispiel, wird die
URL http://domain.com/archive/2006/page/10 zu
folgenden Werte führen:
'2006',
2 => 10,
'controller' => 'archive',
'action' => 'show'
);
]]>
Da Regex Patterns nicht einfach rückgängig zu machen sind, muß eine umgekehrte
URL vorbereitet werden wenn ein URL Helfer verwendet
werden soll oder sogar eine Herstellungsmethode dieser Klasse. Dieser umgekehrte Pfad wird
durch einen String dargestellt der durch sprintf() durchsucht
werden kann und als vierter Parameter definiert wird:
1),
'archive/%s'
);
]]>
Da all das bereits etwas ist das durch die Bedeutung eines standardmäßigen Route Objektes
möglich ist kommt natürlich die Frage aus worin der Vorteil einer regex Route besteht?
Primär erlaubt Sie jeden Typ von URL zu beschreiben ohne irgendwelche
Einschränkungen. Angenommen man hat einen Blog und will eine URL wie die
folgende erstellen:
http://domain.com/blog/archive/01-Using_the_Regex_Router.html, und muß
das jetzt Pfad Element 01-Using_the_Regex_Router.html bearbeiten, in
eine Artikel ID und eine Artikel Titel oder Beschreibung; das ist nicht möglich mit der
Standardroute. Mit der Regex Route ist etwas wie die folgende Lösung möglich:
'blog',
'action' => 'view'
),
array(
1 => 'id',
2 => 'description'
),
'blog/archive/%d-%s.html'
);
$router->addRoute('blogArchive', $route);
]]>
Wie man sieht, fügt das ein enormes Potential von Flexibilität zur Stnadardroute hinzu.