Prefácio

PEAR é um Repositório de Aplicação e Extensão PHP (PHP Extension and Application Repository).

Sobre este nanual

Este manual está escrito em XML usando o DocBook XML DTD e DSSSL (Linguagem de Especificações Semânticas e Estilo de Documento - Document Style and Semantics Specification Language) para formatação. A ferramenta usada para a formatação da versão HTML é Jade, escrito por James Clark e The Modular DocBook Stylesheets escrito por Norman Walsh.

A estrutura básica está baseada no grande trabalho já feito pelo grupo de documentação do PHP. Leia Sobre o manual PHP para mais detalhes.

A estrutura do Manual

Este guia explica a estrutura geral, a disposição e convenções usadas no manual do PEAR. O manual está dividido em seis partes principais, que são:

  • Sobre PEAR

    Esta seção contém uma breve introdução do que o PEAR tem a oferecer. Também está incluído informações gerais sobre instalação e uso do PEAR, opções de suporte, e respostas às perguntas mais freqüentes (FAQ) sobre PEAR.

  • Guia do Desenvolvedor

    Informações gerais sobre desenvolvimento e lançamento dos pacotes PEAR (PEAR-Packages).

  • Componentes do Núcleo (Core)

    Este seção contém a documentação sobre o núcleo das classes PEAR. Estes componentes são a base de todas classes PEAR e compreendê-los irá permitir o uso geral das biblioteca PEAR. Os tópicos incluem a classe básica PEAR, administração PEAR, manipulação de erros com o uso do objeto da classe PEAR_Error, e comandos do sistema. Geralmente estas classes são enviadas com a distribuição dos códigos fonte do PHP.

  • Pacotes

    Há muitos pacotes PEAR e o número vem crescendo a cada dia. A maioria dos pacotes está documentado e muitos não são instalados por padrão. Para informações em como instalar as classes PEAR em seu sistema, leia o Capítulo de Instalação.

    Cada classe documentada contém informações básicas sobre as funções públicas disponíveis no pacote. Pode também haver informações adicionais como introdução, lista de constantes disponíveis, e exemplos de uso das mesmas. Informações adicionais também podem ser encontradas nos códigos fontes presentes no pacote.

    A descrição das funções pode conter algumas ou todas as seguintes partes:

    • Sinopse (Synopsis)

      Mostram a estrutura e o protótipo da função.

    • Descrição (Description)

      Descreve o que a função faz.

    • Parâmetros (Parameter)

      Descreve cada parâmetro da função, com seus tipos e nomes. Também são listados os parâmetros obrigatórios e opcionais.

    • Retorno (Returns)

      Descreve o valor de retorno, caso a função não tenha falhado.

    • Throws

      Descreve o objeto retornado PEAR_Error, se a função falhou.

    • Notas (Note)

      Notas e informações adicionais sobre a função. Uma nota de exemplo poderia ser se há a possibilidade de se chamar a função estaticamente.

    • Ver (See)

      Links para outras funções relacionadas ou entradas no manual.

    • Exemplo (Example)

      Exemplo de uso da função ou classe.

  • Contribuindo com o PEAR

    Contém informações para escrever seus próprios pacotes PEAR.

Autores e Contribuidores

A seguinte lista contém o nome das pessoas que ajudam a manter esta documentação. Se você deseja contatá-los, mande um email para 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

(Em ordem alfabética.)

About the manual (Previous)
Last updated: Wed, 17 Sep 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.