De structuur van de handleiding

Deze rondleiding legt de generale structuur, layout, en gebruikte conventies in de PEAR handleiding uit. Deze handleiding is opgesplits in de volgende zes stukken:

• Over PEAR

  Deze sectie bevat een introductie over wat PEAR is en te bieden heeft. Hier vind je algemene informatie over het installeren en gebruiken van PEAR, support mogenlijkheden, en antwoorden op veel gestelde vragen.

• Ontwikkelaars handboek

  Algemene informatie over het ontwikkelen en uitgeven van PEAR-Pakketten.

• Core Componenten

  Deze sectie bevat documentatie over de core PEAR classes. De core komponenten zijn de basis voor elke PEAR class en het begrijpen van de basics maakt algemeen gebruik van de PEAR library mogelijk. Hier vind je de PEAR basis class, PEAR administratie, foutmelding afhandeling met het PEAR_Error object, en systeem commandos. Deze classes worden algemeen gelevert bij elke PHP source distributie.

• Pakketten

  Er zijn veel PEAR pakketten en elke dag komen er meer bij. Bijna alle pakketten zijn gedocumenteerd en de meeste zijn niet standaard geinstalleerd. Voor informatie over het installeren van PEAR pakketten op je systeem, zie de Installatie hoofdstukken.

  Elke gedocumenteerde class bevat basis documentatie over het pakket's publieke functies. Er kan ook extra informatie zijn zoals een introductie, lijst van de beschikbare constanten, en voorbeelden van het pakket. Extra informatie kan ook in de source van het pakket voorkomen.

  De beschijving van elke functie kan sommige of alle van deze stukken bevatten:

  • Overzicht

    Laat de structuur en het prototype van de functie zien.

  • Beschrijving

    Geeft een beschrijving van wat de functie doet.

  • Parameters

    Beschrijft elke parameter van de functie samen met het parameter type en de naam. Zowel verplichte als optionele parameters worden genoemd.

  • Return waarde

    Beschrijft the terug gegeven waardes.

  • Throws

    Beschrijft het terug gegeven PEAR_Error objects, als de functie faalt.

  • Note

    Extra notes en informatie over de functie. Een voorbeeld note is dat de functie statisch opgeroepen kan worden.

  • Zie

    Links naar andere gerelateerde functies of handleiding stukken.

  • Voorbeeld

    Een voorbeeld hoe de functie of class te gebruiken.

• PECL Pakketten

  PECL Pakketten zijn reguliere PHP extensie geschreven in C. De documentatie structuur zou hetzelfde moeten zijn als de Pakketten sectie hier boven.

• Contributing to PEAR

  Bevat informatie over het schrijven van je eigen PEAR Pakketten.