07 mai 2003

Comment créer un package PEAR ?

PEAR offre des outils permettant de " standardiser " les APIs PHP. Pour rendre vos APIs compatibles voici ce qu'il faut faire :

Voici un exemple avec l'APIs fictive Monapi

Organisation des fichiers et des répertoires

  • Monapi
    • api_file1.php
      • api_file2.php
      • package.xml
      • tests
        • api_test1.php
        • api_test2.php
      • docs
        • readme.txt
        • readme.html

Description

Toute les informations concernant l'API doivent se trouver dans le fichier package.xml


<?xml version="1.0" encoding="ISO-8859-1" ?>
<package version="1.0">
 <name>Monapi</name>
 <summary>En gros, ce que ça fait</summary>
 <description>En détail, ce que ça fait</description>
 <maintainers>
  <maintainer>
   <user>???</user>
   <name>Votre nom</name>
   <email>Votre adresse Mél</email>
   <role>lead</role>
  </maintainer>
 </maintainers>
 <release>
  <version>0.1</version>
  <date>2003-05-07</date>
  <license>LGPL</license>
  <state>stable</state>
  <notes>Note de version</notes>
  <deps>
   <dep type="pkg" rel="ge" version="1.02">Cache_Lite</dep>
  </deps>
  <filelist>
   <dir name="/" baseinstalldir="Monapi">
    <file role="php">api_file1.php</file>
    <file role="php">api_file2.php</file>
    <dir name="tests">
     <file role="test">api_test1.php</file>
     <file role="test">api_test2.php</file>
    </dir>
    <dir name="docs">
     <file role="doc">readme.txt</file>
     <file role="doc">readme.html</file>
    </dir>
   </dir>
  </filelist>
 </release>
</package>

Voilà maintenant à vous d'affiner chaque champs ou groupe de champs.

vous pouvez tester la conformité de votre fichier package.xml avec la commande suivante :


touv@localhost% pear package-validate package.xml 
Validation: 0 error(s), 0 warning(s)

touv@localhost% 

Génération

Reste à générez le package en lui-même avec la commande suivante :


touv@localhost% pear package package.xml 
Package Monapi-0.1.tgz done

touv@localhost% 

Aucun commentaire:

Publier un commentaire