Struktura podręcznika

Ten przewodnik wyjaśnia ogólną strukturę, układ i konwencje użyte w podręczniku PEAR. Podręcznik ten jest podzielony na sześć głównych rozdziałów:

• O PEAR

  Ta sekcja zawiera łagodne wprowadzenie w świat PEAR i to, co ma do zaoferowania. Zawarte są ogólne informacje na temat instalowania i używania PEAR, pytania o wsparcie i odpowiedzi na najczęściej zadawane pytania dotyczące PEAR.

• Podręcznik Developerów

  Ogólne informacje na temat rozwijania i wydawania pakietów PEAR.

• Podstawowe komponenty

  Ta sekcja zawiera dokumentację na temat podstawowych klas PEAR. Te podstawowe koponenty są podstawą każdej klasy w PEAR, a zrozumienie tych podstaw ułatwi użycie biblioteki PEAR. Omówione tematy to między innymi baza PEAR, administracja PEAR, obsługa błędów za pomocą obiektu PEAR_Error oraz komendy systemowe. Te klasy są zazwyczaj dostarczane wraz ze źródłami PHP.

• Pakiety

  Dostępnych jest wiele pakietów PEAR a ich liczba wzrasta z dnia na dzień. Praktycznie każdy pakiet jest udokumentowany, ale mało który jest domyślnie instalowany. Informacje na temat instalowania klas PEAR w Twoim systemie znajdziesz w rozdziale Instalacja.

  Każda udokumentowana klasa zawiera podstawową dokumentację na temat publicznie dostępnych funkcji. Mogą być także dodatkowe informacje takie jak wstęp, lista dostępnych stałych, czy przykłady użycia danego pakietu. Dodatkowe informacje mogą także się znajdować wewnątrz źródeł danego pakietu.

  Opis każdej funkcji może zawierać niektóre lub wszystkie z poniższych elementów:

  • Synopsis

    Pokazuje strukturę oraz prototyp funkcji.

  • Opis

    Pokazuje opis danej funkcji (do czego służy).

  • Parametry

    Opis każdego z parametrów funkcji wraz z typem i nazwą. Wyświetlone są zarówno wymagane jak i opcjonalne parametry.

  • Zwraca

    Opis zwracanej wartości, jeśli wykonanie funkcji zakończy się pomyślnie.

  • Wyjątki

    Opis zwróconego obiektu PEAR_Error jeśli wykonanie funkcji nie powiodło się.

  • Uwagi

    Dodatkowe informacje dotyczące danej funkcji. Przykładowa uwaga może dotyczyć tego, czy funkcja może być wywołana statycznie.

  • Zobacz

    Odnośniki do pokrewnych funkcji lub pozycji podręcznika.

  • Przykład

    Przykład użycia funkcji lub klasy.

• Pakiety PECL

  Pakiet PECL są typowymi rozszerzeniami PHP napisanymi w C. Struktura dokumentacji powinna być identyczna z opisaną powyżej.

• Dołączanie do PEAR

  Zawiera informacje dotyczące tworzenia własnych pakietów PEAR.