Accès direct au contenu Accès direct à la navigation

Ce document développe les différents moyens d’installer et d’utiliser nos sources, les inclure dans vos projets et utiliser le code.

Vous pouvez installer et inclure l’un de nos paquets de différentes façons :

  • faire un clône du paquet depuis GitHub
  • télécharger une archive des sources depuis GitHub
  • utiliser notre "Packagist" avec Composer

Clôner un dépôt

D’abord, vous pouvez clôner un dépôt depuis sont hébergement sur GitHub et l’inclure tel quel dans votre projet. Cette solution vous permet de suivre les mises à jour en exécutant un checkout sur votre clône régulièrement.

Pour clôner un dépôt, utilisez la commande :

  1. ~$ git clone git://github.com/atelierspierrot/PACKAGE_NAME.git path/to/your/project
  2. Cloning into ...
  3. ...

Si tout se passe correctement, vous devez obtenir une copie complète du dépôt avec un répertoire .git/ vous indiquant que votre copie est sous contrôle de version.

Voyez la partie Utilisez les namespaces pour savoir comment utiliser les sources dans votre projet.

Télécharger une archive

Vous pouvez également télécharger une archive du paquet depuis son dépôt sur GitHub. Pour se faire, allez sur la page d’accueil du paquet sur GitHub et cliquez sur le bouton "ZIP". De cette façon, vous obtiendrez la dernière version stable de la branche "master".

Si vous préférez effectuer ce téléchargement depuis la ligne de commande, utilisez :

  1. ~$ wget --no-check-certificate https://github.com/atelierspierrot/PACKAGE_NAME/archive/master.tar.gz
  2. ~$ tar -xvf master.tar.gz
  3. ~$ cp -r PACKAGE_NAME path/to/your/project/

Si le dépôt en propose, une bonne pratique consiste à télécharger un TAG depuis le dépôt. Pour lister les tags disponibles, allez à l’adresse :

http://github.com/atelierspierrot/PACKAGE_NAME/tags

Voyez la partie Utilisez les namespaces pour savoir comment utiliser les sources dans votre projet.

Utiliser Composer

Si vous utilisez Composer pour gérer les dépendances de votre projet, inclure l’un de nos paquets consiste simplement à ajouter dans votre fichier composer.json :

  1. "require": {
  2.     #...
  3.     "atelierspierrot/PACKAGE_NAME": "dev-master"
  4. },

Certains de nos paquets sont référencés dans Packagist et vous n’aurez donc pas besoin de faire plus. Pour les autres paquets, vous devez ajouter l’URL du dépôt dans l’entrée repositories du fichier composer.json :

  1. "repositories": [
  2.     #...
  3.     { "type": "vcs", "url": "http://github.com/atelierspierrot/PACKAGE_NAME" }
  4. ],

Dans certains cas, vous pouvez créer directement un projet avec Composer en jouant la commande :

  1. ~$ php path/to/composer.phar create-project atelierspierrot/PACKAGE_NAME path/to/your/project dev-master --no-dev

Vous pouvez spécifier une version en remplaçant dev-master par le numéro de version souhaitée.

Utilisez les namespaces

Comme expliqué dans le document Règles de codage et de nommage, nous essayons de suivre les règles courantes de nommage des fichiers : tout paquet embarque son propore "namespace" (espace de nom) et toutes les classes suivent les règles de nommage standard.

Par exemple, vous trouverez le code de la classe Patterns\Interfaces\ArrayInterface dans le fichier src/Patterns/Interfaces/ArratInterface.php du paquet.

En conséquence, pour utiliser les classes de nos paquets dans vos projets, vous devez simplement enregistrer la référence de leur espace de nom et l’associer au chemin racine de répertoire qui les contient. Vous pouvez utiliser la classe SplClassLoader ou tout autre "autoloader" personnalisé. Une copie du "SplClassLoader" est le plus souvent incluse dans nos paquets, dans le répertoire src/.

Par exemple, pour référencer l’espace de nom WebFilesystem, vous devez écrire :

  1. require_once '/path/to/package/src/SplClassLoader.php';
  2. $classLoader = new SplClassLoader('WebFilesystem', '/path/to/package/src');
  3. $classLoader->register();

Si vous avez installé l’un de nos paquets en utilisant Composer comme développé plus haut, tout les espaces de noms sont automatiquement référencés et chargés dans l’autoloader interne de Composer (généré à chaque installation ou mise à jour). Dans ce cas, vous n’avez rien d’autre à faire qu’à utiliser la command use dans vos scripts.