A Kézikönyv szerkezete

Ez az ismertető bemutatja a PEAR Kézikönyv általános szerkezetét, elrendezését, és az alkalmazott szabályokat. A kézikönyv hat fő részre osztható, ezek:

• A PEAR-ről

  Ez a szakasz egy összefoglaló bemutató a PEAR-ről, és arról, hogy mit nyújt. Általános információkat tartalmaz a PEAR telepítéséről és használatáról, a nyújtott támogatásról, és válaszokat ad a PEAR-rel kapcsolatos gyakran feltett kérdésekre.

• Fejlesztői Kézikönyv

  Általános információ PEAR csomagok fejlesztéséről és megjelentetéséről.

• Core komponensek

  Ez a szakasz a PEAR fő komponenseinek dokumentációját tartalmazza. Ezek a komponensek valamennyi PEAR osztály alapjai, megértésükkel a PEAR könyvtár általános használatát sajátíthatjuk el. A témák magukban foglalják a PEAR alaposztályt, a PEAR adminisztrációt, a hibakezelést a PEAR_Error objektumon keresztül, és a rendszer parancsokat. Ezek az osztályok kerülnek általánosan terjesztésre minden PHP forrás disztribúcióval.

• Csomagok

  Rengeteg PEAR csomag létezik, és számuk napról napra nő. Majdnem minden csomag dokumentálva van, és a legtöbb csomag alapállapotban nincs telepítve. További információk a PEAR osztályok telepítésével kapcsolatban a telepítésről szóló fejezetben találhatók.

  Minden dokumentált osztály alapvető információkat tartalmaz a csomagok publikusan elérhető függvényeiről. A dokumentáció további információkat is nyújthat, mint például egy bevezetés, az elérhető konstansok, és példák az adott csomag használatára. Esetlegesen még több információ található magukban a forrásfájlokban.

  A függvények leírása a következő részeket tartalmazhatja:

  • Összegzés

    Bemutatja a függvény struktúráját és prototípusát.

  • Leírás

    Leírja, hogy mire jó az adott függvény.

  • Paraméterek

    Leírja a függvény minden egyes paraméterét, a paraméterek típusával és nevével együtt. Mind a kötelező, mind az opcionális paraméterek felsorolásra kerülnek.

  • Visszatérési érték

    Leírja a függvény sikeres futása esetén adott visszatérési értékét.

  • Lehetséges hibaértékek

    Leírja a függvény sikertelen futása esetén visszaadott PEAR_Error objektumát.

  • Megjegyzés

    További megjegyzések és információ a függvényről. Példa a megjegyzésre: "A függvény meghívható statikusan".

  • Lásd

    Linkek más kapcsolódó függvényekre és kézikönyv-bejegyzésekre.

  • Példa

    Példa egy függvény vagy osztály használatára.

• PECL Csomagok

  A PECL Csomagok szabályos, C-ben írt PHP bővítmények. A dokumentáció struktúrája a fentieknek felel meg.

• Közreműködés a PEAR-ben

  Saját PEAR csomagok írásával kapcsolatos információkat tartalmaz.