Composer: installation et utilisation
Composer est un gestionnaire de dépendances pour PHP. C’est un outil simple et fiable que les développeurs utilisent pour gérer et intégrer des paquets ou des bibliothèques externes dans leurs projets basés sur PHP. Ainsi, ils n’ont pas à créer leurs pages ou applications web à partir de zéro.
Avant d’apprendre à installer Composer, assurez-vous que vous avez accès à l’interface en ligne de commande de votre système ou serveur.
Introduction
C’est quoi un gestionnaire de dépendance?
Le gestionnaire de dépendances est un outil qui peut être utilisé pour gérer les dépendances d’un projet. Le gestionnaire de dépendances est un excellent concept. C’est principalement un outil pour installer, désinstaller et mettre à jour ces dépendances. Grosso-modo, un ensemble de mécanismes et permet également la création de packages (vos projets) qui peuvent être distribués. Qu’est-ce que la dépendance à Internet? JavaScript, CSS, HTML, etc.
Définition du Composer
Le logiciel Composer est un gestionnaire de dépendances sous licence libre (GPL v3) écrite en PHP. Il permet à ses utilisateurs de déclarer et d’installer les bibliothèques requises par le projet principal. Cela évite aux développeurs d’avoir à utiliser toutes les bibliothèques qu’ils utilisent pour distribuer leurs projets. Par conséquent, pour les projets écrits en PHP, nous pouvons le considérer comme l’équivalent d’APT.
Installer Composer
Cette section vous montrera comment installer Composer sur un hébergement mutualisé et sur des systèmes d’exploitation tels que Linux, macOS et Windows.
1. Installation de Composer sur un hébergement mutualisé, Linux ou macOS
Les commandes pour installer Composer sur un hébergement mutualisé, Linux (PC ou serveur), et macOS sont les mêmes.
Notez que Composer est préinstallé sur les plans d’hébergement mutualisé Premium et Business de Hostinger. Si vous utilisez l’un d’eux, sautez cette partie. Cependant, si vous découvrez qu’il est obsolète, vous pouvez mettre à jour Composer en exécutant cette commande :
php composer.phar self-update
Suivez ces instructions pour savoir comment installer Composer sur votre système :
- Connectez-vous à votre compte d’hébergement en utilisant une connexion SSH.
- Téléchargez Composer depuis le site officiel en utilisant la commande suivante :
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
- Vérifiez la signature de l’installateur (SHA-384) pour vous assurer que le fichier d’installation n’est pas corrompu. Tapez :
php -r "if (hash_file('sha384', 'composer-setup.php') === 'e0012edf3e80b6978849f5eff0d4b4e4c79ff1609dd1e613307e16318854d24ae64f26d17af3ef0bf7cfb710ca74755a') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
- La longue chaîne de caractères de la commande ci-dessus (‘e0012edf…’) est la signature de l’installateur. Cette signature change à chaque fois qu’une nouvelle version de Composer est publiée. Donc, assurez-vous d’aller chercher la dernière version de SHA-384 sur cette page.
- Une fois que c’est fait, vous pouvez installer Composer localement ou globalement. L’installation locale signifie que le gestionnaire de dépendances sera stocké dans votre répertoire actuel, et que vous devez spécifier le chemin d’accès avant d’exécuter les commandes correspondantes. En attendant, l’installation globale vous permet d’exécuter Composer depuis n’importe quel endroit de votre système en le stockant dans le répertoire /usr/local/bin. Voici comment effectuer les deux méthodes :
- Installation locale :
php composer-setup.php
- Installation globale :
php composer-setup.php --install-dir=/usr/local/bin --filename=composer
- Vous obtiendrez ce résultat :
All settings correct for using Composer Downloading... Composer (version 1.10.5) successfully installed to: /usr/local/bin/composer
- Une fois que c’est fait, supprimez l’installateur :
php -r "unlink('composer-setup.php');"
- Testez l’installation du Composer :
composer
- La ligne de commande renvoie ce résultat :
______ / ____/___ ____ ___ ____ ____ ________ _____ / / / __ / __ `__ / __ / __ / ___/ _ / ___/ / /___/ /_/ / / / / / / /_/ / /_/ (__ ) __/ / ____/____/_/ /_/ /_/ .___/____/____/___/_/ /_/ Composer version 1.10.5 2020-02-12 16:20:11
2. Installer Composer sous Windows
La mise en route de Composer sur une machine Windows est un peu différente. Aucune instruction en ligne de commande n’est nécessaire pour télécharger et installer le logiciel.
Il suffit de suivre les étapes suivantes :
- Installez PHP sur votre ordinateur. Nous vous recommandons d’utiliser XAMPP à cette fin, car le processus est simple et vous pouvez le terminer en quelques minutes.
- Une fois que XAMPP est installé, téléchargez la dernière version de Composer.
- Lancez l’assistant d’installation de Composer. Lorsqu’il vous demande d’activer le mode développeur, ignorez-le et poursuivez le processus d’installation.
- Une autre fenêtre s’ouvre et vous demande de localiser la ligne de commande PHP. Par défaut, elle se trouve dans C:/xampp/php/php.exe. Après avoir spécifié le chemin, cliquez sur Suivant.
- Vous serez invité à entrer les paramètres du proxy. Laissez la case non cochée et sautez cette partie en cliquant sur Suivant. Ensuite, dans la dernière fenêtre, cliquez sur Installer.
- Une fois l’installation terminée, ouvrez l’invite de commande. Tapez la commande suivante :
composer
Excellent travail ! Vous avez maintenant Composer installé sur votre ordinateur Windows. Le programme d’installation ajoutera automatiquement Composer à votre variable PATH. Vous pouvez maintenant ouvrir l’invite de commande et exécuter le logiciel depuis n’importe quel endroit.
Générer et comprendre composer.json
Voici maintenant la partie intéressante – utiliser Composer dans votre projet PHP.
Pour cela, vous devez générer un fichier composer.json. Vous pouvez le considérer comme un moyen de rechercher des données dans une liste pour Composer. Ce fichier contient des paquets (dépendances) qui doivent être téléchargés.
De plus, composer.json vérifie également la compatibilité des versions avec votre projet. Cela signifie que si vous utilisez un ancien paquet, composer.json vous le fera savoir afin d’éviter tout problème ultérieur.
Vous avez la possibilité de créer et de mettre à jour composer.json vous-même. Toutefois, étant donné qu’il s’agit d’un tutoriel sur l’automatisation de tâches redondantes, nous vous déconseillons de créer le fichier manuellement.
Voyons l’utilité de composer.json en créant un exemple de projet.
Notre projet est un simple timer PHP, qui permet aux développeurs de connaître le temps d’exécution du code. C’est très utile pour le débogage et l’optimisation.
Vous pouvez suivre ces étapes :
- Créer un nouveau répertoire pour le projet. Comme notre projet est un timer, nous nommerons simplement le dossier phptimer. Pour ce faire, exécutez la commande suivante :
mkdir phptimer
- Accédez au répertoire nouvellement créé :
cd phptimer
- Trouvez un paquet ou une bibliothèque pour le projet. Le meilleur endroit pour y parvenir est Packagist, où vous trouverez des tonnes de bibliothèques pour vous aider à développer votre projet. Pour ce tutoriel, nous avons besoin d’un paquet timer (minuterie). Pour l’obtenir, il suffit de taper timer dans la barre de recherche :
- Comme vous pouvez le voir, plusieurs paquets de minuterie sont disponibles et chacun d’eux a un nom et une petite description de ce qu’il fait. Dans cet exemple, nous avons choisi phpunit/php-timer car il possède le plus de téléchargements et le plus des étoiles GitHub.
- Précisez le package souhaité pour que Composer puisse l’ajouter à votre projet :
composer require phpunit/php-timer
- Le résultat montrera la version de phpunit/php-timer :
Using version ^1.0 phpunit/php-timer
Le symbole du signe d’insertion (^) est défini comme l’option permettant une interopérabilité maximale. Cela signifie que Composer mettra toujours à jour le paquet jusqu’à ce qu’une certaine version brise le paquet d’une manière ou d’une autre.
Dans notre cas, la plage de mise à jour du paquet est >=1.0.9 <2.0.0, car la version 2.0.0 brisera la rétrocompatibilité. Pour des informations détaillées sur le versionnage dans Composer, consultez la page de documentation.
Après l’exécution de la commande ci-dessus, votre répertoire de projet contiendra deux nouveaux fichiers – composer.json et composer.lock – et un dossier nommé vendor. C’est dans ce répertoire que Composer stockera tous vos paquets et dépendances.
Utilisation du script de chargement automatique
Votre projet est presque prêt à démarrer, et la seule chose qui reste à faire est de charger la dépendance dans votre script PHP. Et heureusement, le fichier de chargement automatique de Composer vous permet de terminer ce processus plus rapidement.
Pour utiliser le chargement automatique, écrivez la ligne suivante avant de déclarer ou d’instancier de nouvelles variables dans votre script :
require '/vendor/autoload.php'
Nous allons vous donner un exemple pour vous aider à mieux comprendre.
Disons que nous voulons tester notre projet phptimer :
- Ouvrez l’éditeur de texte nano pour créer un script nommé demo.php.
nano demo.php
- Ensuite, collez les lignes suivantes dans votre fichier :
<?php require __DIR__ . '/vendor/autoload.php' Timer::start(); // your code $time = Timer::stop(); var_dump($time); print Timer::secondsToTimeString($time);
- Exécutez le script :
php demo.php
- Le terminal doit afficher un résultat similaire à ce qui suit :
double(1.0893424438611E-5) 0 ms
Mise à jour des dépendances de vos projets
Enfin, vous devez savoir comment mettre à jour vos paquets. Cela peut se faire de deux manières :
- Mise à jour universelle. Pour vérifier et installer les mises à jour de tous vos paquets et dépendances en même temps, tapez la commande suivante :
composer update
- Mise à jour spécifique au paquet. Exécutez cette commande pour vérifier les mises à jour d’un ou de plusieurs paquets spécifiques :
composer update vendor/package vendor2/package2
N’oubliez pas de remplacer vendor/package par le nom du paquet que vous voulez mettre à jour.
En exécutant la commande update, Composer met également à jour les fichiers composer.json et composer.lock pour qu’ils correspondent à l’état actuel des dépendances de votre projet.
Conclusion
Composer aide les développeurs à gérer les dépendances des projets PHP. Grâce à ce logiciel, ils peuvent facilement intégrer et gérer des paquets open source en un seul endroit.
Ce qui est formidable, c’est que Composer peut également résoudre les dépendances par projet. Ainsi, les développeurs peuvent contrôler les paquets pour chaque projet et garder la taille du projet sous contrôle.
Dans cet article, vous avez appris comment installer et utiliser Composer efficacement. Pour résumer, revoyons encore une fois toutes les étapes :
- Installez Composer sur un hébergement mutualisé, sous Linux, MacOS ou Windows.
- Générer et comprendre le fichier composer.json.
- Utilisez le script de chargement automatique pour charger les dépendances dans votre fichier PHP.
- Mettez à jour les dépendances de votre projet.