Composer est un gestionnaire de paquet pour PHP. Grâce à lui, vous pouvez installer des bibliothèques tierces facilement. Il gère également les dépendances.

Depuis Jelix 1.7, il est possible de créer un projet basé sur Jelix avec Composer, et d'installer le framework Jelix avec Composer. Dans la future version 2.0 du framework, la plupart des modules seront disponibles via Composer: les sources du framework seront plus légères et on pourra installer que ce que l'on a besoin. Pour le moment, le paquet Composer de Jelix 1.7 contient tous les composants et modules “standards” (comme dans les versions précédentes de Jelix).

Si vous ne voulez pas utiliser Composer, il est toujours possible de le faire. Voyez alors dans le manuel comment faire. Sinon, installez Composer avant de poursuivre.

Voici les différents cas d'utilisation de Jelix avec Composer.

Une application développée avec Composer ne comportes normalement pas les bibliothèques tierces. C'est à dire que le code source de l'application, dans un dépôt git, subversion ou mercurial, ne contient pas le code source de ces bibliothèques tierces. Elles sont installées par Composer lors du déploiement de l'application (que ce soit en local pour développer ou sur un serveur de déploiement pour la mise en production).

Ainsi, une application utilisant le framework Jelix 1.7+ avec Composer, ne devrait pas inclure Jelix dans son code source, et indiquer plutôt le paquet Jelix dans le fichier composer.json de l'application. Composer installera alors les fichiers de Jelix (et autres bibliothèques) dans un dossier vendor/ (que vous ne devez donc pas inclure dans votre dépôt git/svn/hg).

Pour créer un nouveau projet, deux choix :

La manière la plus rapide est d'utiliser le paquet jelix/jelix-skeleton-app. Ce paquet contient une arborescence et les fichiers nécessaires pour réaliser une application avec une page.

Pour ce faire, si vous voulez créer une application “myapp” :

``` composer create-project jelix/jelix-skeleton-app myapp dev-jelix-1.7 ```

Quelques fichiers ensuite à copier avant d'initialiser l'application:

ln -s ../vendor/jelix/jelix/lib/jelix-www www/jelix
cp var/config/profiles.ini.php.dist var/config/profiles.ini.php
cp var/config/localconfig.ini.php.dist var/config/localconfig.ini.php
 
php install/installer.php

Lancez ensuite un serveur web, par exemple celui fourni avec PHP (uniquement pour du développement !)

php -S localhost:8080 -t www 

Et votre application est prête (ici sur http://localhost:8080).

Depuis ses premières version, la commande createapp de Jelix permet de créer un squelette d'application. C'est une alternative encore crédible au paquet jelix-skeleton-app car elle permet de personnaliser la création du squelette.

Dans ce cas de figure, il suffira alors :

1. de créer le répertoire de votre application (prenons myapp comme nom) et y mettre un fichier composer.json dont voici un exemple de contenu

{
    "name": "myorganisation/myapp",
    "type": "application",
    "description": "Cool app",
    "require": {
        "php": ">=5.3.3",
        "jelix/jelix": "dev-jelix-1.7"
    },
    "require-dev": {
        "phpunit/phpunit": "4.3.*"
    },
    "minimum-stability": "dev"
}

Dans ce répertoire, on y exécute Composer pour installer les paquets indiqués dans le composer.json :

cd myapp
composer install

Et on peut lancer ensuite la création du squelette de l'application

php vendor/jelix/jelix/lib/jelix-scripts/createapp.php ../myapp

Puisque l'on utilise Composer, il faut ensuite modifier le fichier application.init.php pour charger ../vendor/autoload.php au lieu du classique lib/jelix/init.php.

// require(__DIR__.'/vendor/jelix/jelix/lib/jelix/init.php'),
require(__DIR__.'/vendor/autoload.php');

Lancez ensuite un serveur web, par exemple celui fourni avec PHP (uniquement pour du développement !)

php -S localhost:8080 -t www 

Et votre application est prête (ici sur http://localhost:8080).

Il peut être nécessaire d'utiliser des bibliothèques tierces. La plupart sont disponibles via Composer. Il suffit de rechercher leur nom exact sur http://packagist.org, de connaitre la version que l'on veut, et d'indiquer ces informations dans la section "require" du fichier composer.json du projet. Ensuite un coup de composer update et la bibliothèque sera prête à être utiliser dans votre application.

Si le paquet en question est un module Jelix, vous allez devoir en plus le déclarer dans la configuration de Jelix. Si par exemple le module “foo” se trouve dans vendor/the_vendor/the_package/foo, il faudra mettre dans le mainconfig.ini.php :

modulePath="<ici autres chemins>,app:vendor/the_vendor/the_package/"
 
[modules]
foo.access=2

Sans oublier ensuite de relancer l'initialisation de l'application

php install/installer.php

Il arrive que l'on développe une application qui utilise des modules externes (utilisés par d'autres projets) que l'on a soit-même développé ou auxquels on contribue, et que l'on veut améliorer. On aura donc deux répertoires de travail (deux clones git par exemple), l'un qui est celui de l'application, et l'autre celui du module externe que l'on veut faire évoluer pour les besoins de l'application.

To be continued