A PEAR a PHP Extension and Application Repository rövidítése.
Ez a kézikönyv XML-ben íródott, a DocBook XML DTD használatával, DSSSL-t (Document Style and Semantics Specification Language) felhasználva a formázásra. A HTML formázásra használt eszközök a Jade, készítette James Clark, valamint The Modular DocBook Stylesheets írta Norman Walsh.
A struktúra a PHP dokumentációs csoport nagyszerű munkáján alapul. További részletekért lásd a PHP kézikönyv About the PHP manual fejezetét.
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:
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.
Általános információ PEAR csomagok fejlesztéséről és megjelentetéséről.
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.
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.
Saját PEAR csomagok írásával kapcsolatos információkat tartalmaz.
A következő lista azokat a személyeket tartalmazza, akik ezen dokumentáció karbantartásában nyújtanak segítséget. Amennyiben kapcsolatba szeretnénk lépni valamelyikükkel, írjunk a [email protected] levelezőlistára.
Lorenzo Alberton
Gregory Beaver
David Coallier
Daniel Convissor
David Costa
Thomas V.V. Cox
Michael Gauthier
Christophe Gesché
Ken Guest
Martin Jansen
Alan Knowles
Clay Loveless
Alexander Merz
Stefan Neufeind
Jon Parise
Tobias Schlitt
Stephan Schmidt
Mika Tuupola
Michael Wallner
Christian Weiske
Mark Wiesemann
A PEAR Kézikönyv magyar nyelvű változatának fordítói:
Norbert Mocsnik
(ABC-sorrendben)