O manual PHP é disponibilizado em diversos formatos. Estes formatos podem ser divididos em dois grupos: formatos de leitura online e pacotes para download. Algumas editoras fizeram versões impressas deste manual. Porém estas versões não são recomendadas, pois tendem a se tornar rapidamente desatualizadas. O manual PHP pode ser lido online no site do PHP.net. A versão online do manual PHP tem atualmente duas folhas de estilo CSS, uma web amigável e a outra folha de estilo para impressão. Duas vantagens notáveis do manual online sobre a maioria dos formatos offline é a integração das notas dos usuários e os atalhos de URL que podem ser usados para ir rapidamente para partes desejadas do manual. Uma óbvia desvantagem é o requisito de estar online para visualização desta edição do manual. Existem diversos formatos offline do manual, e o formato mais adequado depende do sistema operacional e do estilo de leitura pessoal. Para informações de como o manual é gerado em tantos formatos, veja a seção Como os formatos são gerados deste apêndice. A versão HTML é o formato mais multi-plataforma deste manual. Esta versão está disponível como um único arquivo HTML e como um pacote de arquivos individuais para cada seção (que resulta em uma coleção de milhares de arquivos). Nós disponibilizamos estas versões compactadas, então um programa de descompactação é necessário para recuperar os arquivos contidos dentro destes pacotes. Para plataformas Windows, a versão Windows HTML Help do manual otimiza o formato HTML para o uso com o programa Windows HTML Help. Esta versão fornece busca de textos, índice completo e marcadores. Vários ambientes de desenvolvimento populares do PHP no Windows se integram com esse formato da documentação para facilitar o acesso à documentação. Visualizadores de CHM para desktops Linux também estão disponíveis. Veja xCHM ou GnoCHM. Existe também uma versão CHM estendida disponível, que é atualizada menos frequentemente, mas que oferece muitos recursos adicionais. Entretanto ela irá funcionar apenas no Microsoft Windows, devido às tecnologias usadas para compilar as páginas de ajuda. As notas dos usuários possuem um importante papel no desenvolvimento deste manual. Ao permitir que os leitores do manual possam contribuir com exemplos, ressalvas e outros esclarecimentos através de seus navegadores, somos capazes de incorporar esse feedback dentro do texto principal do manual. E até que as notas sejam incorporadas, elas podem ser vistas na sua forma online e em alguns dos formatos offline. As notas dos usuários não são moderadas antes delas aparecerem online, então a qualidade da escrita ou dos exemplos de código, e mesmo a veracidade da contribuição, não podem ser garantidas. (Não que haja qualquer garantia da qualidade ou exatidão do próprio texto do manual.) Para fins de cobertura de licença as notas fornecidas por usuários são consideradas parte do manual do PHP, e por isso são cobertas pela mesma licença desta documentação (atualmente a licença Creative Commons Attribution). Para mais detalhes, veja a página de Direitos Autorais do Manual. Cada função no manual é documentada para uma referência rápida. Saber como ler e entender o texto tornará a aprendizagem do PHP muito mais fácil. Mais do que simplesmente estudar exemplos ou copiar/colar, todos deveriam saber como ler as definições de funções (protótipos). Vamos começar: Mesmo o PHP sendo uma linguagem fracamente tipada, é importante ter um entendimento básico dos tipos pois eles têm um importante significado. Definições das funções nos dizem que tipo de valor é retornado. Vamos usar a definição da função strlen como nosso primeiro exemplo: Parte Descrição strlen Nome da função. (PHP 4, PHP 5, PHP 7) strlen() está disponível em todas as versões do PHP 4, 5 e 7 ( string $string ) O primeiro (e neste caso, o único) parâmetro/argumento para esta função é chamado string, e é uma string. int Tipo do valor que esta função retorna, que é um int (isto é, o comprimento de uma string é medido em números). Poderíamos reescrever a definição da função acima de uma maneira genérica: Muitas funções recebem múltiplos parâmetros, tais como a função in_array. Seu protótipo segue abaixo: O que isso significa? in_array() retorna um valor booleano, &true; em caso de sucesso (se needle foi encontrado em haystack) &return.falseforfailure; (se needle não foi encontrado em haystack). O primeiro parâmetro é chamado needle e pode de ser de vários tipos diferentes, por isso nós o chamamos "mixed" (misto). Esse needle mixed (o que nós estamos procurando) pode ser tanto um valor escalar (string, inteiro, ou float) ou um array. haystack (o array onde nós estamos procurando) é o segundo parâmetro. O terceiro parâmetro opcional é chamado strict. Todos os parâmetros opcionais têm valores padrão (default). Se o valor padrão é desconhecido, então é mostrado um ?. O exemplo diz que o valor padrão do parâmetro strict é o booleano &false;. Veja a página do manual de cada função para detalhes de como elas funcionam. Além do mais o símbolo & (ampersand, e comercial) antes de um parâmetro de função permite ao parâmetro ser passado por referência, como no exemplo abaixo: Neste exemplo podemos ver que o terceiro parâmetro opcional &$matches será passado por referência. Existem também funções com informações de versões do PHP mais complexas. Tome como exemplo html_entity_decode: = 4.3.0, PHP 5, PHP 7) ]]> Isto significa que esta função só está disponível a partir da versão PHP 4.3.0. O manual contém informações sobre as versões passadas, presente, e futuras do PHP. Modificações no comportamento são documentadas como notas, changelogs e em trechos nas páginas do manual. A versão mais antiga documentada é o PHP 7.0.0. Quando a documentação existir para versões mais recentes de desenvolvimento (unreleased) do PHP, será marcada como "available in Git" ou "development version". E, embora estas mudanças sejam planejadas, em casos raros elas podem mudar. Todo desenvolvimento ocorre no Git e o check out pode ser feito como descrito na página acesso anônimo ao Git . E para esclarecer, o manual refere-se a maiores, menores e específicas releases do PHP. Usando o PHP 7.3.1 como exemplo, o 7 refere-se à versão maior, 3 à menor e 1 é a release específica. Tipicamente o PHP somente adiciona novas features em maiores e menores releases, e corrige bugs em releases específicas. Porém, esta convenção nem sempre é verdadeira. Observe também que o manual PHP é escrito no tempo presente, e não no futuro, mesmo que para recursos documentados que ainda não estão disponíveis. A razão para isto é que o manual pode resistir ao teste do tempo, portanto não exige tediosas atualizações gramaticais a cada nova release do PHP. Muitas vezes o manual do PHP lista "Valores Padrão" para as diretivas do PHP. Estes valores são baseados em como o PHP se comporta sem um arquivo de configuração &php.ini;, então podem ser diferentes dos valores encontrados nos arquivos php.ini-development e php.ini-production distribuídos. Eles também referem-se à última versão do PHP, embora entradas do changelog mencionem valores anteriores. Veja o Apêndice Diretivas do PHP para detalhes a respeito destes valores e mudanças. Este manual não tenta fornecer instruções sobre práticas gerais de programação. Programadores de primeira viagem - ou apenas começando - podem achar difícil aprender a programar em PHP usando exclusivamente este manual. Em vez disso, procure um texto mais orientado para iniciantes. Há uma série de listas de discussão ativas para discussões de todos os aspectos da programação com PHP. Se estiver preso com algum problema, considere o uso destas listas. Para opções de suporte, incluindo listas de discussão, veja a página de suporte do PHP.net. Há várias maneiras de ajudar a melhorar a documentação. Se um erro for encontrado neste manual, em qualquer linguagem, por favor informe-os usando o rastreador de problemas do respectivo repositório da linguagem em &url.php.git;. Por exemplo, erros no manual em português do Brasil devem ser reportados em &url.php.git;doc-pt_br/issues. Todos os problemas relacionados com a documentação, inclusive sobre os formatos de manuais, devem ser enviados como relatórios de problemas. Por favor, não abuse dos rastreadores de problemas enviando pedidos de ajuda. Neste caso, use uma das muitas opções de suporte. Ao contribuir com notas, os usuários podem fornecer exemplos adicionais, ressalvas e esclarecimentos para outros leitores. Mas por favor, não informe problemas usando o sistema de anotações. Para mais detalhes, veja a seção intitulada 'Sobre as notas de usuários'. Também é possível enviar requisições de correções para o repositório espelho Github da documentação. O manual PHP é traduzido em várias línguas. Saber inglês e uma língua estrangeira permite uma outra maneira de ajudar a melhorar o manual PHP trabalhando com um time de tradução. Para mais informações sobre como iniciar uma nova tradução, ou ajudar no projeto de tradução atual, por favor leia &url.php.dochowto;. O Projeto de Documentação do PHP também possui um canal IRC onde muitos autores do manual se reúnem. Passe no canal #php.doc em irc.efnet.org e discuta maneiras de melhorar a documentação do PHP. Este manual é escrito em XML usando o DocBook XML DTD e o PhD (The [PH]P based [D]ocBook renderer) para manutenção e formatação. Usar XML dá a capacidade de gerar diversos formatos de saída a partir dos arquivos fonte, enquanto apenas um documento fonte é mantido para todos os formatos. A ferramenta usada para formatar o manual online é o PhD. O Microsoft HTML Help Workshop é usado para gerar o formato Windows HTML Help do manual e, é claro, o próprio PHP é usado para fazer algumas conversões e formatações. O manual do PHP é gerado em vários idiomas e formatos, veja &url.php.docs; para maiores detalhes. O código fonte XML pode ser baixado do Git e visualizado em &url.php.git.mirror;doc-en (ou doc-pt_br para o manual em português do Brasil). O manual do PHP está disponível não apenas em vários formatos, mas também em vários idiomas. O texto do manual é escrito primeiro em inglês e então grupos de pessoas ao redor do mundo fazem as traduções para suas línguas nativas. Se a tradução para um capítulo ou para uma função específica ainda não foi feita, o sistema de compilação do manual utiliza a versão original em inglês. Pessoas envolvidas na tradução iniciam com o código fonte XML disponível em &url.php.git.mirror;doc-en e a partir daí é feita tradução para sua língua nativa. Eles não utilizam as versões geradas (como HTML ou texto plano) já que é o sistema de compilação do manual que cuida das conversões de XML para formatos mais legíveis. Para colaborar com a tradução da documentação entre em contato com time de tradução/documentação inscrevendo-se na lista de discussão do phpdoc: envie um e-mail vazio para &email.php.doc.subscribe;. O endereço da lista de discussão é &email.php.doc;. Informe na mensagem o interesse em traduzir o manual e alguém irá responder com orientações sobre como avançar iniciando uma tradução para uma nova língua ou entrando em contato com o time de documentação da língua desejada. Atualmente o manual está disponível, parcialmente ou não, em mais de 10 idiomas. Todos eles podem ser baixados aqui: &url.php.docs;.