Здесь вы сможете найти описание обшей структуры, разметки и соглашений,
которые используются в руководстве по PEAR. Руководство разделено на 5
основных частей:
О PEAR
Эта секция содержит небольшой вступление на тему что такое PEAR и что
он может предложить. В нее также включена общая информация об установке
и использовании PEAR, вариантах поддержки и ответы на часто задаваемые
вопросы о PEAR.
Основные компоненты
Эта секция содержит документацию по базовым классам PEAR.
Эти классы являются базовыми для каждого класса PEAR, понимание их
основ позволит вам использовать PEAR. Обсуждаемые темы включают:
базу PEAR, администрирование PEAR, обработку ошибок с помощью
PEAR_Error и команды системы. Эти классы поставляются вместе с
релизами PHP.
Пакеты
Существует много пакетов PEAR и их количество растет день ото дня.
Почти каждый пакет документирован и почти каждый не ставится по
умолчанию. Информацию об установке классов PEAR на вашей системе
вы можете найти в главе Установка.
Каждый документированный класс содержит основную документацию о
функциях, которые он предоставляет. Может быть, также, дополнительная
информация в виде введения, списка констант и примеров использования
пакета. Дополнительная информация может присутствовать в исходниках
пакета.
Описание каждой функции может содержать некоторые или все из
нижеперечисленных частей:
Обзор
Содержит описание структуры и прототип функции.
Описание
Содержит описание того, что делает эта функция.
Параметр
Описывает каждый параметр функции с указанием имен и типов каждого
из них. Перечислены обязательные и опциональные параметры.
Возвращаемое значение
Описывает возвращаемое значение, если функция не завершается
ошибкой.
Throws
Описывает объекты класса PEAR_Error,
возвращаемые в случае завершении функции с ошибкой.
Заметка
Дополнительные заметки и информация о функции. Содержит пример, если
фукнция может быть вызвана статически.
См. также
Ссылки на другие функции и разделы руководства.
Пример
Пример использование функции или класса.
Пакеты PECL
Пакеты PECL - это обычные модули PHP, написанные на C.
Структура документации аналогична описанной выше.
Участие в PEAR
Содержит информацию о написании и добавлении в PEAR своих собственных
пакетов.
|