Skip to end of metadata
Go to start of metadata

O Composer é, além de outras coisas, um gestor de dependências. Simples, fácil de instalar, configurar e usar, é uma ferramenta versátil e ajuda a realizar o download de pacotes, bibliotecas e/ou frameworks completos, e suas respectivas dependências, usando declarações simples em um arquivo de configuração e uma interface simples em linha de comando.

Para obter e saber mais sobre o Composer acesse seu site oficial. Para navegar no repositório padrão de dependências do Composer, o Packagist, e procurar por pacotes para seu projeto você pode acessar o endereço https://packagist.org.


Inicializando o Composer em um projeto.

Caso seu projeto ainda não possua o Composer, ou se você está iniciando um projeto do zero, e você queira adicioná-lo é bem simples. Acione o menu de contexto na raiz de seu projeto, ou acesse o menu Tools, acione o item Composer ➝ Init Composer....

Você deverá apontar a instalação do Composer ou baixá-lo do site oficial diretamente na raiz do projeto.


Caso decida baixar o Composer basta clicar em Click here to download from getcomposer.org e o campo Path to composer.phar será preenchido automaticamente. Após a definição do Composer basta clicar em OK.

Agora basta preencher os campos no arquivo composer.json, navegando entre eles com Tab e Shift + Tab

Adicionando dependências a um projeto Composer

Se você já estiver utilizando o Composer em seu projeto, ou acabou de realizar o passo anterior, você pode adicionar dependências a partir do PhpStorm. Para isso basta ir ao menu Tools ➝ Composer ➝ Add dependency....

A janela Add Composer Dependency será exibida e você pode usar o campo de filtros para procurar a dependência que deseja.


Ao encontrá-la selecione a versão desejada e clique em Install.

Será realizado o download da dependência e você poderá selecionar outro pacote para instalar. Também é possível atualizar pacotes através dessa interface. Para encerrar, basta clicar em Close.

Criando um projeto a partir do Composer

Vamos criar um projeto no PhpStorm a partir de um pacote de projeto, como é o caso da instalação padrão do Symfony. Para iniciar um projeto com este pacote navegue ao menu File ➝ New Project... ou pela janela de boas vindas do PhpStorm clicando na opção Create New Project - você será apresentado ao seguinte diálogo:


Preencha-o com o nome de seu projeto, o caminho para o mesmo e selecione o tipo de projeto em Project type como Composer Project. A janela de projetos Composer será exibida:


Na seção composer.phar selecione se vai usar uma instalação do Composer já presente em sua máquina ou se vai baixar no diretório do projeto com a opção Download composer.phar from getcomposer.org.

Na seção Package utilize o campo Filter packages para encontrar o pacote symfony/framework-standard-edition, aguarde a descrição do projeto aparecer no quadro à direita e selecione a versão a instalar.

Para finalizar verifique a seção Settings com relação ao caminho para o executável do PHP (Path to PHP executable) e se deseja acrescentar algum parâmetro à chamada do Composer então clique em OK. O PhpStorm se encarregará de baixar o Composer, se for o caso, e invocá-lo para baixar as dependências requeridas pelo Symfony, além de rodar quaisquer scripts definidos por ele.

Agora você já pode começar o desenvolvimento de seu projeto.

Usando como ferramenta de linha de comando

O PhpStorm conta com uma poderosa ferramenta para executar programas na linha de comando de maneira facilitada. Podemos usar o Composer com ela também.

Para configurá-la com o nosso gestor de dependências vamos às configurações com [Ctrl + Alt + S] ([Cmd + ,] no Mac) ou pelo menu File ➝ Settings... (PhpStorm ➝ Preferences no Mac)e lá acesse Tools ➝ Command Line Tool Support.

Vamos criar uma nova entrada, para isso clique no ícone de adição verde à direita.

Agora vamos selecionar em Choose tool o Composer, e selecionar se esta configuração valerá somente para este projeto, ou para todos no PhpStorm. Clique em OK.


Agora precisamos configurar qual interpretador será usado e onde está o Composer que iremos utilizar. Se você já está usando o Composer no seu projeto, estes campos já estarão preenchidos.


Ao clicar em OK voltamos à janela de configurações onde podemos ver a nova linha com o Composer. Se você reparar há uma coluna nesta tela para Alias que está preenchida com "c" na linha do Composer. 

Clique em OK e voltemos ao IDE. Com [CtrlShiftX] ([CmdShiftX] no Mac) podemos acionar o console de ferramentas de linha de comando. No campo exibido, digite o alias/apelido "c": você será apresentado aos comandos do Composer.

Continue com "i" (para o comando info) e pressione Enter, e insira um pacote que você conheça, como respect/rest por exemplo.

Editando arquivos composer.json

Os arquivos composer.json regem a configuração do Composer para seu Projeto. Com a finalidade de tornar mais prática a edição desses arquivos o desenvolvedor Piotr Śliwa construiu o Plugin Composer.json for PhpStorm. Este plugin provê o acabamento automático para as diretivas do composer.json, além de inspeções para o mesmo.

Para começar a utilizá-lo devemos instalá-lo. Acesse as configurações do PhpStorm e lá navegue para a opção Plugins e acione o botão Browse Repositories.... Na nova janela procure pelo plugin PHP Composer.json support e clique em Install plugin.

Clique em Close e reinicie o PhpStorm para ativar o plugin.

Agora você é capaz de invocar o acabamento automático para diretivas do composer.json e valores como o da diretiva license.

O plugin também lista pacotes nas diretivas require e require-dev.

O plugin vai notificá-lo também se você tentar utilizar uma diretiva inválida. Esta inspeção também dá sugestões de correção.

O plugin ainda conta com acabamento para diretórios e arquivos nas diretivas pertinentes, além de outras inspeções. Para saber mais, visite o projeto no github.

  • No labels