Instalação

Enviado por Yukare em domingo, 6 de Agosto de 2017 - 19:50

Importante: escrevi toda esta documentação há um tempo atrás para a versão 1.4.3 do phpDocumentor. No entanto agora existe a versão 2. Acredito que quase tudo escrito aqui se aplica também a versão 2, mas ainda preciso revisar todo este conteúdo para corrigir qualquer eventual diferença.

Existem dois métodos oficiais. O primeiro e através de copiar e extrair um dos arquivos disponíveis em http://sourceforge.net/projects/phpdocu/files (atualmente na versão 1.4.3), e a outra é através do instalador PEAR. É importante notar que a instalação funciona da mesma maneira, tanto no Windows quanto no Linux, para as duas opções existentes.

Instalação através de um arquivo copiado

Para instalar o phpDocumentor a partir de um arquivo zip copiado diretamente de sourceforge.net, primeiro determine se você estará usando a interface via web ou a interface de linha de comando(acho a interface de linha de comando bem mais pratica de usar, embora levemente mais complicada de usar)

Para usar a interface de linha de comando, descompacte o arquivo em qualquer diretório, por exemplo, /home/myuser/phpdoc ou C:\phpdoc, e adicione este diretório ao seu PATH. Para executar, use o comando "phpdoc". No windows você vai precisar editar o arquivo the phpdoc.bat, e mudar a primeira linha para o caminho da versão CLI do seu PHP (normalmente C:\php4\cli\php.exe por padrão).

Você também pode fazer assim, supondo que você tenha o php instalado em c:\php, e que tenha descompactado o arquivo zip do phpdoc em c:\phpdoc, abra uma janela do prompt de comando, nesta janela do prompt de comando digite:

c:\php\php.exe c:\phpdoc\phpdoc.php

Para usar a interface web, você deve ter um servidor web, como por exemplo o Apache, instalado, e você deve ter o PHP funcionando neste servidor. Para usar a interface web do phpDocumentor simplesmente descompacte o arquivo zip em um subdiretório do seu servidor (como por exemplo phpdoc) e navegue para esta localização (http://localhost/phpdoc).

Um navegador com capacidade de javascript é necessário para usar a interface web nova, como por exemplo Netscape, Mozilla, Internet Explorer, Opera, ou Konqueror . Se você quiser um navegador sem javascript como links/lynx, use a interface web antiga, phpdoc.php em http://localhost/phpdoc/phpdoc.php.

Instalação através do PEAR

Para instalar o phpDocumentor através do PEAR, você primeiro deve ter uma instalação do PEAR funcionando. Instruções para instalar de maneira adequada o PEAR estão disponíveis em seu site oficial, http://pear.php.net.

Instalar phpDocumentor para uso na linha de comando é simples. Simplesmente execute:

$ pear install PhpDocumentor

E então você terá pleno acesso ao comando phpdoc, tando no windows quanto no unix, sem mais nenhuma configuração.

Para instalar o phpDocumentor para usar a interface web, primeiro você deve modificar uma das variáveis de configuração do PEAR, data_dir, para ser um subdiretório do seu servidor web. A maneira mais simples de fazer isso é através da interface de comando do PEAR com:

$ pear config-set data_dir /path/to/document_root/pear

Configurar este valor através da interface web também é simples. Clique no ícone de configuração no quadro a esquerda, e escreva o caminho na caixa de texto data_dir.

Uma vez que a configuração esteja completa, simplesmente instale o phpDocumentor como descrito no segundo paragrafo acima, e então você pode navegar para http://localhost/pear/PhpDocumentor para ter acesso a interface web. Uma vez que estes passos de configuração tenham sido feitos, jamais terá necessidade de mudar, e você pode facilmente atualizar para futuras versões do phpDocumentor usando o comando upgrade do PEAR.