Der Aufbau des Handbuchs

Diese Einführung erklärt die allgemeine Struktur, das Layout und die Konventionen im PEAR-Handbuch. Es ist unterteilt in sechs große Teile, die sind:

• Über PEAR

  Dieser Teil enthält eine Einführung darüber, was PEAR ist und was es bietet. Dazu kommen allgemeine Informationen über die Installation und die Benutzung von PEAR, Support-Möglichkeiten und beantwortet häufig gestellte Fragen zu PEAR.

• Entwickler-Leitfaden

  Allgemeine Informationen über die Entwicklung und Herausgabe von PEAR-Packages.

• Core-Bestandteile

  Dieser Teil dokumentiert die PEAR-Core-Klassen. Sie sind die Basis für jede Klasse in PEAR - wenn Sie die Core-Klassen kennen, dürfte das Arbeiten mit den übrigen keine Schwierigkeit sein. Themen sind u.a.: PEAR, PEAR verwalten, die Fehlerbehandlung über die PEAR_Error-Klasse, und system-nahe Kommandos. Die hier beschriebenen Funktionen sind Bestandteil jeder orginalen PHP-Distribution.

• Packages

  Es gibt eine wachsende Anzahl von PEAR-Packages. Viele sind hier dokumentiert - aber standardmäßig nicht installiert. Für die Installation von PEAR Packages lesen Sie bitte das Installation chapter.

  Die Dokumentation für jede Klasse enthält zumindest eine Beschreibung aller öffentlichen Methoden. Häufig sind zusätzlich verfügbar: eine Einführung, eine Auflistung definierter Konstanten und Anwendungs-Beispiele. Daneben gibt es natürlich noch Informationen im Quellcode der Klassen selbst.

  Die Beschreibung jeder Methode enthält einige oder alle folgenden Teile:

  • Synopsis

    Zeigt den Aufbau der Methode

  • Beschreibung

    Beschreibt, was die Methode tut

  • Parameter

    Beschreibt jeden Parameter der Methode mit ihrem Namen und Datentyp. Es werden erforderliche und optionalen Parameter aufgeführt

  • Rückgabewert

    Beschreibt den Rückgabewert, wenn kein Fehler auftritt

  • Fehler-Meldungen

    Beschreibt das zurückgelieferte PEAR_Error-Objekt wenn ein Fehler auftritt

  • Hinweise

    Zusätzliche Hinweise über eine Methode. Z.B. ist hier vermerkt, wenn eine Methode statisch aufgerufen werden kann.

  • Siehe auch

    Links zu zugehörigen Methoden oder Handbuch-Seiten

  • Beispiel

    Ein Benutzungs-Beispiel für die Methode oder Klasse

• An PEAR mitarbeiten

  Enthält Information zum Schreiben eigener PEAR-Packages