drips/routing

PHP-Routing-System zur Verknüpfung von URLs mit Funktionen - Ideal für APIs (Web-Services) bzw. schöne (benutzerdefinierte) URLs.

Routing

, _(*1)

Beschreibung

Das Routing ist zuständig für die Auslösung der URLs zu PHP-Funktionen. Somit können (schöne) URLs manuell festgelegt werden., _(*2)

Installation

Apache 2

Einfach eine .htaccess Datei im entsprechenden Verzeichnis hinzufügen:, _(*3)

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^(.*)$ index.php [QSA]
</IfModule>

Hierfür muss das Rewrite-Modul (mod_rewrite) des Webservers aktiviert sein., _(*4)

NGINX

Grundsätzlich müssen alle Anfragen an die index.php weitergeleitet werden. Hierfür kann folgende Konfiguration verwendet werden:, _(*5)

location / {
    if (!-e $request_filename) {
        rewrite ^(.*)$ /index.php;
    }
}

Verwendung

Anlegen eines Routers

Zuerst muss der Router geladen und angelegt werden., _(*6)

<?php
use Drips\Routing\Router;

$router = Router::getInstance();

Hinzufügen von Routen

Nachdem ein entsprechender Router angelegt wurde, können für diesen Routen registriert werden., _(*7)

<?php
$router->add("name_der_route", "/my/url", function(){
    echo "Hello World!";
});

Wird die URL /my/url aufgerufen, so wird die festgelegte Funktion ausgeführt und es wird Hello World! angezeigt., _(*8)

Achtung: der Name der Route muss eindeutig sein. Ist der Name bereits vergeben, kann die Route nicht hinzugefügt werden., _(*9)

MVC-Unterstützung

Das Routing-System unterstützt zusätzlich die Verwendung des Drips-MVC Systems. Dementsprechend kann beim Hinzufügen von Routen nicht nur eine Funktion sondern auch ein Controller übergeben werden:, _(*10)

$router->add("name_der_route", "/my/url", MyController::class);

Routen mit Platzhaltern

Oftmals sind Routen dynamisch. Deshalb können die Routen auch mit Platzhaltern versehen werden. Ein Platzhalter verwendet folgende Schreibweise: {name_des_platzhalters}. Alle Parameter entsprechen den jeweiligen Platzhaltern. (Die Reihenfolge der Parameter ist zwingend einzuhalten!), _(*11)

<?php
$router->add("name_der_route", "/my/url/{name}", function($name){
    echo "Hello $name!";
});

Außerdem können die Platzhalter mithilfe von regulären Ausdrücken eingeschränkt werden., _(*12)

<?php
$router->add("name_der_route", "/my/url/{name}", function($name){
    echo "Hello $name!";
}, array(
    "pattern" => array(
        "name" => "([A-Za-z]+)"
    );
));

Routen einschränken

Die Routen können mehrfach eingeschränkt werden:, _(*13)

• auf bestimmte Domains
• nur für HTTPS-Verbindungen
• auf bestimmte Verbs (Request-Methoden) ... GET, POST, DELETE, PUT

Um eine Einschränkung festlegen zu können wird beim Hinzufügen einer Route ein weiterer Parameter angegeben. Dieser ist ein Array und beinhaltet alle gewünschten Einschränkungen., _(*14)

<?php
$router->add("name_der_route", "/my/url", function(){
    echo "Hello World!";
}, array(
    "https" => true,
    "verb" => ["POST", "GET"],
    "domain" => ["example.com", "example.at"]
));

Routing starten

Wenn der Router angelegt ist und alle Routen registriert sind, dann kann mit dem Routing-Prozess begonnen werden. Dies funktioniert vollkommen automatisch - es muss lediglich die Funktion, die das Routen übernimmt, aufgerufen werden., _(*15)

<?php
$router->route();

Routen abfragen

Die Methode getRoutes() liefert alle registrieren Routen zurück. Mithilfe der Funktion hasRoutes() kann überprüft werden, ob bereits Routen registriert wurden, oder nicht., _(*16)

<?php
if($router->hasRoutes()){
    // Es sind bereits Routen registriert
} else {
    // Es sind noch keine Routen registriert
}

<?php
$routes = $router->getRoutes(); // returns array

Seite nicht gefunden - Error 404

Wird keine entsprechende Route gefunden, wird eine Error404Exception geworfen., _(*17)

<?php
try {
    $router->route();
} catch(Error404Exception $e) {
    echo "Error 404 - Die Seite wurde nicht gefunden!";
}

Links generieren

Damit sich die URLs jederzeit ändern können und auch von unterschiedlichen Verzeichnissen aus aufgerufen werden können, werden die Verlinkungen mit Hilfe der route Funktion erzeugt., _(*18)

Ein Link kann wie folgt generiert werden:, _(*19)

<?php
$url = route("testRoute");

Übergeben wird der Name der Route. Des Weiteren können bei Routen mit Platzhaltern die Links auch entsprechend erzeugt werden, indem einfach die Parameter als Array übergeben werden., _(*20)

Angenommen es gibt eine Route /users/{username}:, _(*21)

<?php
$url = route("users", array("username" => "admin"));

Assets

Das Link-System funktioniert auch für "Dateien", die nicht im Router registriert sind. Gibt es beispielsweise eine CSS-Datei, welche auf einer bestimmten Seite angezeigt werden soll, kann für diese ebenfalls ein absoluter Pfad generiert werden., _(*22)

<?php
$url = asset("css/style.css");

Umleitungen

Oftmals ist es notwendig auf eine andere Seite weiterzuleiten. Dies erfolgt über die redirect-Funktion. Diese funktioniert im Prinzip genau gleich, wie die routelink-Methode, mit dem einzigen Unterschied, dass kein Link zurückgeliefert wird, sondern direkt auf diese Seite weitergeleitet wird., _(*23)

<?php
redirect("home");

Automatisches Routing

Die Route wird wie folgt definiert: /my/url/[auto]. Somit werden alle Informationen die nach /my/url/ folgen als Parameter übergeben., _(*24)