WhatZeWeb

Composer est un gestionnaire de dépendances PHP, dont la première version est sortie en 2012.

Il nous permet de déclarer et d’ajouter des bibliothèques externes à nos applications PHP.

Nous allons voir comment l’installer et l’utiliser.

 

Configuration requise

Composer nécessite à minima la version 5.3.2 de PHP pour fonctionner, et est disponible sur Windows, Linux et Mac OS.

 

Installation

Windows

Sur Windows, il suffit de télécharger et d’exécuter Composer-Setup. Cet exécutable va se charger de récupérer pour vous la dernière version et configurera vos variables d’environnement (PATH) afin que vous puissiez faire appel à composer depuis n’importe quel répertoire.

A présent, ouvrez une console et vérifiez la bonne installation avec la commande suivante :

composer -V

Vous devriez obtenir une réponse de ce type :

 

Mac OS et Linux

Il vous faut ici aussi télécharger l’installeur, mais vous allez avoir la possibilité d’installer Composer soit localement (dans le cadre d’un projet spécifique), soit globalement.

Pour l’installer localement, il vous faut exécuter le programme d’installation précédemment téléchargé directement dans le répertoire de votre projet.

Le programme va tout d’abord vérifier vos paramètres PHP, puis télécharger l’archive PHP exécutable composer.phar.

php installer

puis

php composer.phar

pour lancer Composer

Et voilà ! Composer est prêt à être utilisé pour gérer les dépendances de votre projet.

Pour une installation globale, il vous suffit de déplacer composer.phar dans un dossier défini dans les variables d’environnement, comme ceci par exemple :

mv composer.phar /usr/local/bin/composer

Vous pouvez désormais lancer composer avec la commande

composer

 

Utilisation

A présent que Composer est installé, nous pouvons commencer à l’utiliser. Pour l’exemple, nous allons installer Twig, un moteur de template pour PHP.

Tout d’abord, créez un fichier composer.json à la racine de notre projet et ajoutez-y la clé require, la seule obligatoire :

{
   "require": {
       "twig/twig":"2.0"
   }
}

twig/twig est la dépendance que nous souhaitons installer, et “2.0” sa version (ici, précisément, nous demandons à installer la dernière version). Pour en savoir plus quant à la syntaxe à adopter, je vous invite à lire la documentation.

Depuis le dossier de votre projet, lancez la commande suivante :

composer install

Voici ce que vous devriez obtenir :

Vous pouvez constater que Twig a bien été téléchargé, avec ses dépendances.

Et si vous regardez le dossier de votre projet, vous verrez qu’un fichier composer.lock a été créé, ainsi qu’un dossier vendor :

Le fichier composer.lock sert à préciser les versions exactes utilisées pour chaque dépendance, permettant ainsi à tous les collaborateurs de travailler sur une base commune (ce qui signifie qu’un composer install ne prendra pas en compte d’éventuelles mises à jour, à l’inverse d’un composer update).

Le dossier vendor, quant à lui, est le dossier dans lequel vont être placées toutes vos dépendances.

Si vous utilisez git pour versionner votre projet, pensez à bien ajouter ce dossier vendor à un fichier .gitignore.

 

Et voilà ! Vous avez vu ici l’installation et l’utilisation de base de ce gestionnaire de dépendances pour vos projets PHP.

Pour en savoir plus, je vous invite à consulter la doc, et pour trouver les dépendances dont vous pourriez avoir besoin, n’hésitez pas à faire vos recherches sur le site Packagist, qui est la principale sources de packages PHP.