Como instalar e usar o Composer, gerenciador de dependências PHP

Composer é o gerenciador de dependências da comunidade PHP. Ele simplifica a instalação, atualização e uso de pacotes de terceiros. Os pacotes podem ser hospedados por repositórios públicos e privados, com a publicação dos projetos mais populares no Packagist.

Instalando o Composer

Composer é um esforço da comunidade que não vem com PHP. É distribuído como um arquivo PHP PHAR de getcomposer. org. Algumas distribuições do Linux incluem o Composer em seus repositórios de software, mas a instalação dessa forma geralmente fornece uma versão desatualizada.

Certifique-se de ter o PHP instalado antes de continuar. PHP 5.3 é a versão mais antiga suportada no momento da escrita. Você também precisará de git e descompactação em seu sistema se quiser instalar pacotes a partir do código-fonte.

O Composer fornece um script de configuração automatizado. Comece baixando o instalador para seu diretório de trabalho:

 curl https://getcomposer. org/installer -o composer-setup. php 

Agora você deve verificar o hash do instalador para verificar se ele não foi adulterado. Consulte o site do Composer para verificar o hash mais recente e obter um exemplo de código de verificação.

Em seguida, use o script de configuração para instalar o Composer:

 php composer-setup. php --install-dir = / usr / local / bin --filename = composer 

Isso irá baixar o Composer em / usr / local / bin, permitindo que ele fique em seu caminho junto com seus outros executáveis. Tente executar o composer em seu shell para verificar se tudo está funcionando. A versão do Composer deve ser exibida, seguida por uma lista dos comandos disponíveis do Composer.

Para atualizar o Composer no futuro, execute a atualização automática do composer. Isso substituirá automaticamente o binário do Composer pela versão mais recente. Você não precisará usar o script composer-setup. php novamente para excluí-lo agora.

Preparando seu projeto

Você precisará criar um arquivo composer. json no diretório de trabalho do seu projeto antes de começar a usar o Composer. Execute composer init para criar um interativamente. Isso o colocará em uma configuração básica.

Siga as instruções da linha de comando para fornecer informações sobre o seu projeto, como nome, descrição e detalhes do autor. Os nomes dos pacotes usam a sintaxe do fornecedor / pacote para evitar conflitos entre autores em repositórios públicos. Você deve usar seu nome de usuário Packagist como o componente do fornecedor.

A maioria das chaves em composer. json são opcionais, a menos que você pretenda publicar sua base de código no Packagist. Você pode encontrar uma descrição completa da estrutura do arquivo &’ no site de documentação do Composer.

Instalando pacotes

Você pode adicionar pacotes ao seu projeto usando o comando composer require:

 compositor requer fornecedor / pacote 

Pesquise pacotes para instalar usando o site Packagist. Eles serão adicionados à seção necessária do arquivo composer. json do seu projeto. Depois de instalado, o código-fonte do pacote vai para a pasta do fornecedor em seu projeto.

O Composer depende do controle de versão semântico para lidar com as atualizações do pacote. A versão exata de cada pacote que você instalou é gravada em composer. lock no diretório do seu projeto. Isso permite que o Composer identifique o pacote específico a ser instalado quando composer. json indicar que um intervalo de versões é aceitável.

Você deve submeter composer. json e composer. lock ao seu controle de origem. Outros desenvolvedores trabalhando em seu projeto podem então executar composer install para adquirir todas as dependências que você definiu.

Pacotes como executores de teste podem ser marcados como dependências de desenvolvimento fornecendo o sinalizador --dev para o comando require. Eles serão separados em uma seção require-dev no composer. json. Ao instalar seus pacotes, use composer install --no-dev para excluir dependências de desenvolvimento. Isso é útil ao usar o Composer em scripts de implantação e sistemas CI.

Atualizando pacotes

Você deve tentar manter seus pacotes atualizados para não perder a segurança e correções de bugs. Execute o comando composer outdated para ver uma lista de dependências em `composer. json` que têm novas versões disponíveis.

Para aplicar as atualizações, execute a atualização do composer. Isso respeitará o controle de versão semântico e puxará a versão mais recente de cada pacote, dentro das restrições de versão especificadas por seu composer. json. Um pacote marcado como ^ 1.2 será atualizado para 1.2.x ou 1.3.x, mas não 2.0. Os documentos do Composer incluem informações detalhadas sobre como a ferramenta resolve diferentes formas de restrição de versão.

Atualizar um pacote irá reescrever automaticamente seu arquivo composer. lock para especificar a nova versão. Outros desenvolvedores trabalhando em seu projeto podem executar novamente a instalação do composer para obter os pacotes exatos que você &’ está usando.

O Autoloader Composer

O carregamento automático é o mecanismo preferido para descobrir arquivos de origem dentro do PHP. O Composer tem suporte de primeira classe para carregamento automático; na maioria das vezes, seu autoloader será o único arquivo que você precisa para require_once () dentro do seu projeto.

Conforme você instala as dependências, o Composer irá escrever automaticamente um autoloader para vendor / autoload. php. Os pacotes especificam como devem ser carregados automaticamente usando o campo autoload em composer. json. Você deve configurar isso para seu próprio projeto para que o Composer possa carregar automaticamente seus arquivos também:

{" autoload & quot ;: {" psr-4 & quot ;: {" ExampleProject \\ & quot ;: " src / " }}}

O snippet acima irá configurar o carregamento automático do seu projeto usando o padrão PSR-4. Os recursos do codebase no namespace ExampleProject serão mapeados para arquivos no diretório src – por exemplo, use ExampleProject \ ExampleClasses \ MyClass automaticamente require_once ("src / ExampleProject / ExampleClasses / MyClass. php").

O único arquivo que você &’ precisará manualmente require_once () é o próprio autoloader:

 require_once (__ DIR__. "/vendor/autoload. php");

Você deve adicionar a linha o mais cedo possível em sua inscrição. Isso garantirá que o carregamento automático seja habilitado antes de você começar a consumir classes e interfaces em sua base de código.

Às vezes, pode ser necessário forçar a regeneração do autoloader. Geralmente, isso ocorre porque você atualizou a configuração de carregamento automático do seu projeto. Você pode executar composer dump-autoload para escrever um novo autoloader sob demanda.

Resumo

O Composer simplifica o desenvolvimento do PHP ao fornecer o gerenciador de dependências ausente na linguagem principal. Usando o Composer, você pode facilmente incorporar código de terceiros em seus projetos, sem ter que baixar manualmente os arquivos de origem e mantê-los atualizados.

O autoloader interno do Composer permite que você acesse os pacotes instalados sem nenhum trabalho extra de sua parte. A ferramenta também inclui um executor de script que permite que você execute tarefas dentro de sua base de código adicionando comandos ao bloco de scripts em composer. json. Use composer run my-script para executar o script.