Zum Inhalt springen

Websiteentwicklung: PHP: Praktische Einführung: Mit dem PHP-Handbuch arbeiten

Aus Wikibooks

Dieses Buch kann dir nicht jede Funktion vorstellen, die es in PHP gibt (das ist auch gar nicht seine Aufgabe). Wenn du Informationen brauchst, warum dieser oder jener Fehler auftritt, oder was das fünfte Argument einer sehr komplizierten Funktion bewirkt, kannst du im PHP-Handbuch nachschlagen. Du findest es unter http://de.php.net/docs.php.

Eine Funktion für einen bestimmten Zweck finden

[Bearbeiten]

Wenn man nicht genau weiß, wie die Funktion heißt, die man sucht, kann man durch die Funktionsreferenz blättern. Sucht man beispielsweise eine Funktion, um herauszufinden, ob ein String in einem String enthalten ist, sollte man selbstverständlich bei den String-Funktionen nachschlagen. Dort findet sich eine Liste mit allen Stringfunktionen und einer Beschreibung in einem kurzen Satz. Bei strpos werden wir schließlich fündig.

Solltest du bereits wissen, wie eine Funktion heißt, möchtest jedoch die Erklärung dazu aufrufen, kannst du dies mit der PHP-Referenz direkt über die URL tun:

http://de.php.net/NAME_DER_FUNKTION

Die Funktionsbeschreibung

[Bearbeiten]

Jede Funktion hat im PHP-Handbuch eine ähnlich aussehende Funktionsbeschreibung. Oben finden sich Angaben zu den Versionen, in denen die Funktion vorhanden ist (z.B. "(PHP 4, PHP 5)"), darunter die Ein-Satz-Beschreibung und die Funktionssignatur. Die Signatur für strpos lautet beispielsweise:

int strpos ( string $haystack , mixed $needle [, int $offset = 0 ] )

Dadurch erfährst du, dass die Funktion ein Integer zurückgibt und drei Argumente hat. Das erste Argument muss ein String sein (oder wird automatisch dazu gecastet), das zweite darf von einem beliebigem Typ sein ("mixed" gibt es nicht wirklich als Typ, er wird nur innerhalb der Dokumentation verwendet). Der letzte Parameter ist in eckige Klammern gesetzt, was darauf hinweist, dass dieser optional ist. Die Benennung der Argumente ist nur für die Dokumentation, diese helfen aber in der Regel beim Verständnis. So wird mit $haystack ("Heuhaufen") stets der Kontext, in dem etwas gesucht wird, mit $needle ("Nadel") das Gesuchte bezeichnet.

Auf die Signatur folgt eine ausführlichere Beschreibung. Besonders die Hinweise und Warnungen solltest du beachten. Funktionen, die als DEPRECATED gekennzeichnet wurden, werden in zukünftigen Versionen von PHP entfernt. Auf diese kannst du dich nicht verlassen; dein Code könnte nach einem Update von PHP nicht mehr funktionieren.

Ein Beispiel sagt in der Programmierung meist mehr als viele Worte, deswegen findet sich zu jeder Funktion meist eines oder mehrere Anwendungsbeispiele, die alle Argumentkombinationen vorstellt und Stolperfallen aufzeigt.

Abschließend werden unter "Siehe auch" alternative Funktionen für ähnliche Anwendungsfälle aufgezeigt. Auch das ist ein Weg, eine dir unbekannte Funktion zu finden. Bei strpos wirst du etwa auf strrpos hingewiesen, welches dir die letzte Position eines Zeichens aufzeigt.

Die Benutzerkommentare

[Bearbeiten]

Unterhalb aller Handbuchseiten findest du die Benutzerkommentare. Diese sind in Englisch verfasst und werden von (meist) erfahrenen PHP-Benutzern eingereicht. Diese Kommentare weisen auf Dinge hin, die im Handbuch keine Erwähnung finden, oder bieten Lösungen für häufige Problemstellungen.

Übung

[Bearbeiten]