1. Предисловие

Предисловие

PEAR - это PHP Extension and Application Repository (репозиторий расширений и приложений PHP).

Об этом руководстве

Это руководство создано с помощью XML с использованием DocBook XML DTD и DSSSL (Document Style and Semantics Specification Language) для форматирования. Утилиты, использовавшиеся для форматирования HTML и PDF версий: Jade, который создал James Clark и The Modular DocBook Stylesheets, которые создал Norman Walsh.

Руководство основывается на большом объеме работы, которую в свое время сделали участники PHP Documentation Group. Подробнее читайте здесь - About the PHP manual.

Структура руководства

Здесь вы сможете найти описание обшей структуры, разметки и соглашений, которые используются в руководстве по PEAR. Руководство разделено на 5 основных частей:

  • О PEAR

    Эта секция содержит небольшой вступление на тему что такое PEAR и что он может предложить. В нее также включена общая информация об установке и использовании PEAR, вариантах поддержки и ответы на часто задаваемые вопросы о PEAR.

  • Основные компоненты

    Эта секция содержит документацию по базовым классам PEAR. Эти классы являются базовыми для каждого класса PEAR, понимание их основ позволит вам использовать PEAR. Обсуждаемые темы включают: базу PEAR, администрирование PEAR, обработку ошибок с помощью PEAR_Error и команды системы. Эти классы поставляются вместе с релизами PHP.

  • Пакеты

    Существует много пакетов PEAR и их количество растет день ото дня. Почти каждый пакет документирован и почти каждый не ставится по умолчанию. Информацию об установке классов PEAR на вашей системе вы можете найти в главе Установка.

    Каждый документированный класс содержит основную документацию о функциях, которые он предоставляет. Может быть, также, дополнительная информация в виде введения, списка констант и примеров использования пакета. Дополнительная информация может присутствовать в исходниках пакета.

    Описание каждой функции может содержать некоторые или все из нижеперечисленных частей:

    • Обзор

      Содержит описание структуры и прототип функции.

    • Описание

      Содержит описание того, что делает эта функция.

    • Параметр

      Описывает каждый параметр функции с указанием имен и типов каждого из них. Перечислены обязательные и опциональные параметры.

    • Возвращаемое значение

      Описывает возвращаемое значение, если функция не завершается ошибкой.

    • Throws

      Описывает объекты класса PEAR_Error, возвращаемые в случае завершении функции с ошибкой.

    • Заметка

      Дополнительные заметки и информация о функции. Содержит пример, если фукнция может быть вызвана статически.

    • См. также

      Ссылки на другие функции и разделы руководства.

    • Пример

      Пример использование функции или класса.

  • Участие в PEAR

    Содержит информацию о написании и добавлении в PEAR своих собственных пакетов.

Authors and Contributors

The following is a list of people that are helping to maintain this documentation. If you would like to contact one of them, please write to pear-doc@lists.php.net.

  • Edited By

    Lorenzo Alberton

  • Edited By

    Gregory Beaver

  • Edited By

    David Coallier

  • Edited By

    Daniel Convissor

  • Edited By

    David Costa

  • Edited By

    Thomas V.V. Cox

  • Edited By

    Michael Gauthier

  • Edited By

    Christophe Gesché

  • Edited By

    Ken Guest

  • Edited By

    Martin Jansen

  • Edited By

    Alan Knowles

  • Edited By

    Clay Loveless

  • Edited By

    Alexander Merz

  • Edited By

    Stefan Neufeind

  • Edited By

    Jon Parise

  • Edited By

    Tobias Schlitt

  • Edited By

    Stephan Schmidt

  • Edited By

    Mika Tuupola

  • Edited By

    Michael Wallner

  • Edited By

    Christian Weiske

  • Edited By

    Mark Wiesemann

(In alphabetic order.)

About the manual (Previous)
Last updated: Fri, 19 Dec 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.