Heute möchte ich ein kurzes Tutorial zum Thema „SEO URLs“ veröffentlichen. SEO steht, für die die es noch nicht wussten, für „Search Engine Optimization“ – Also Suchmaschinenfreundliche URLs. Doch diese Web-Adressen sind gleichermaßen Benutzerfreundlich da sie keine kryptischen GET Parameter enthalten sondern klare Texte (sofern ihr eure Applikation/Website entsprechend aufbaut).
Dieses Tutorial sollte übrigens bei allen gängigen XAMPP installationen und Webservern funktionieren.

Die folgende nicht-SEO URL liefert dem PHP Skript im Hintergrund zwar eine klare ID, doch als Benutzer können wir damit nicht viel anfangen. Wir wissen weder wie der Eintrag heißt noch von wann er ist – Sprich: Sowohl Suchmaschinen- als auch Benutzer-unfreundlich.

http://web-developer-blog.com/?post_id=403

In dieser SEO URL dagegen wird ein kompletter String übergeben statt einer Zahl. Ich benutze hier im Blog das folgende Format: "<Jahr>/<Monat>/<Name des Eintrags>.html". Der heutige Eintrag ist also unter der folgenden URL zu finden…

http://web-developer-blog.com/2012/02/tutorial-einfache-seo-urls.html

Somit wissen wir auf einen Blick wie der Eintrag heißt und von wann ist.

Also wie erreichen wir diese schönen Adressen in unserer Applikation oder auf unserer Website?

Es gibt zwei Wege – Die erste hat zwar nichts mit PHP (oder sonstigen Entwicklung) zutun, doch ich möchte sie zur Vollständigkeit aufführen:
Ihr könnt auf eurem Webserver eine ganz normale Ordnerstruktur anlegen und innerhalb jedes Ordners eine „index.html“ (oder „index.php“) ablegen. Ihr könnt anschließend durch die („real“-) existierenden Ordner navigieren und könnt damit eine ähnliche Struktur abbilden wie in meinem Beispiel oben.
Das würde allerdings bedeuten das ihr in jeder index-Datei eines jeden Ordners das komplette Layout usw. einbringen müsst. Das ist natürlich alles andere als Pflegeleicht…

Nun aber zu der Methode die ich eigentlich ansprechen möchte!
Zu aller erst müssen wir uns eine „htaccess“ Datei anlegen. Das ist eine Datei ohne Namen mit der Endung „htaccess“. Eine solche Datei lässt sich nicht von Windows erstellen (Windows erlaubt keine Dateien ohne Namen) – Deshalb müssen wir diese entweder mit einem Editor erstellen (und als „.htaccess“ speichern) oder wir nutzen Linux 😉

Der Inhalt dieser Datei kann etwa so aussehen:

RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule .* index.php [L,QSA]

Diese Zeilen machen folgendes:
Als erstes wird das URL Rewriting aktiviert – Das ist nötig um die URLs selbst definieren zu können. Der Befehl RewriteBase / wird den HTTP Host als Ausgangsort festlegen (also z.B. „http://leonardfischer.de“) – Sollte eure Applikation/Website Beispielsweise in einem Unterordner liegen muss der Befehl entsprechend angepasst werden. Für „http://leonardfischer.de/applikation“ z.B. RewriteBase /applikation/.

Die nächsten beiden Zeilen RewriteCond %{REQUEST_FILENAME} !-f und RewriteCond %{REQUEST_FILENAME} !-d geben an, das tatsächlich existierende Dateien (-f) und Ordner (-d) angesteuert werden sollen.
Das ist unter anderem für ausgelagerte Dateien (wie Bilder, Javascript oder CSS) wichtig – Denn diese sollen ja schließlich „gefunden“ und angezeigt werden.

Die letzte Zeile RewriteRule .* index.php [L,QSA] leitet nun alle ankommenden Requests auf die „index.php“ um – Natürlich nur sofern keine der definierten Regeln zutrifft. Die Buchstaben in der eckigen Klammer sorgen dafür das nach dieser Zeile keine weiteren Regeln definiert werden können und die aktuellen Request-Daten aus unserer URL an die sogenannten Request-URI an gehangen werden.

Wir haben nun also quasi Narrenfreiheit was die URL angeht – Selbst Adressen wie z.b. „http://leonardfischer.de/test-eins-zwei/ordner/datei.endung.zweite-endung“ werden ganz normal auf unsere index.php weitergeleitet. Das ist genau das Verhalten welches wir erreichen wollten!

Legen wir nun eine „index.php“ Datei mit folgendem Inhalt in unseren Ausgangsordner:

Hallo Welt, wir befinden uns auf:<br />
<?php echo $_SERVER['REQUEST_URI']; ?>

So werden wir (mit der Beispiel-Adresse von vorhin) folgenden Text zu sehen bekommen:

Hallo Welt, wir befinden uns auf
/test-eins-zwei/ordner/datei.endung.zweite-endung

Wie wir diesen String nun verarbeiten ist uns vollkommen selbst überlassen! Aber für einen Schnellstart habe ich hier ein kleines PHP Skript abgetippt welches ein ganz rudimentäres Routing bereitstellt…

// Zuerst entfernen wir führende und abschließende Slashes.
$url = trim(strtolower($_SERVER['REQUEST_URI']), '/');

// Wir nehmen uns die ersten drei Ebenen der URL und bauen uns somit eine kleine Struktur auf.
list($controller, $action, $id) = explode('/', $url);

// Wir definieren einen standard Controller, falls unsere URL leer ist.
if (empty($controller))
{
    $controller = 'startseite';
}

// Wir definieren eine standard Action, falls unsere URL keine beinhaltet.
if (empty($action))
{
    $action = 'index';
}

if (class_exists($controller))
{
    $controller = new $controller;

    if (method_exists($controller, $action))
    {
        $controller->$action($id);
    }
    else
    {
        trigger_404('Entschuldigung, die angeforderte Aktion wurde nicht gefunden');
    }
}
else
{
    trigger_404('Entschuldigung, das angeforderte Modul wurde nicht gefunden');
}

function trigger_404($msg = '')
{
    header("HTTP/1.0 404 Not Found");
    header("Status: 404 Not Found");
    echo $msg;
}

Achtung – Mit diesem „routing“ wird es euch nicht möglich sein Bindestriche in der URL zu nutzen – Aber das könnt ihr ganz einfach „nachrüsten“:

// Damit auch Bindestriche in der URL funktionieren benutzt ihr statt:
$url = trim(strtolower($_SERVER['REQUEST_URI']), '/');

// Einfach diese Zeile:
$url = trim(strtolower(str_replace('-', '_', $_SERVER['REQUEST_URI'])), '/');

// Dadurch wir bei "http://leonardfischer.de/hallo-welt/" der Controller "hallo_welt" aufgerufen.

Anschließend braucht ihr nur noch für jedes Modul eine Klasse erstellen und entsprechende Actions definieren. Und schon habt ihr ein funktionierendes Routing, mit dem ihr arbeiten könnt. Ihr solltet allerdings euer Error-Reporting etwas umstellen, sonst kann es schnell passieren das ihr „NOTICE“ Meldungen bekommt weil das Array, das durch den explode Befehl erstellt wird ggf. keine Einträge beinhaltet, doch die list Funktion drei Stück erwartet:

// Wir möchten keine NOTICE-Meldungen erhalten.
error_reporting(E_ALL^E_NOTICE);

Anschließend stelle ich noch den „startseite“ Controller zur Verfügung damit ihr einen noch schnelleren Einstieg habt 😉

// Startseite Controller
class startseite
{
    public function index($id = null)
    {
        echo 'Hallo und willkommen auf meiner tollen Seite!';
    }
}

Mit dieser Grundlage könnt ihr durchaus schon ganz gut arbeiten – Für größere Projekte empfehle ich allerdings ein besseres Routing und eine sicherere Grundlage (z.B. ein Framework). Als Grundlage sollte dieser Blog-Eintrag allerdings hervorragend geeignet sein!

Achtung! Solltet ihr Eingaben aus der URL in die Datenbank bringen (z.B. weil ihr euer Routing in die Datenbank auslagert) solltet ihr unbedingt den Beitrag SQL-Injection vorbeugen lesen!

Mit diesen Worten möchte ich mich für Heute verabschieden. Vielleicht werde ich mal ein paar mehr kleine Tutorials vorbereiten! Ich wünsche euch eine erfolgreiche Rest-Woche!