パッケージ定義ファイル package.xml の解説

package.xml のトップレベル要素は <package version="1.0"> です。 副要素として使用可能なものは次の通り。

• <name>: パッケージの名称
• <summary>: パッケージについての解説の短い要約
• <description>: パッケージについての完全な解説
• <license>: パッケージのライセンス (LGPL, PHP License など).

• <maintainers>: パッケージのメンテナに関する情報

  • <maintainer>: メンテナ各人に関する情報 (複数回記述可能)

    • <user>: メンテナのユーザアカウント名
    • <role>: メンテナのパッケージ開発における役割 (lead, developer, helper のいずれか)
    • <name>: メンテナの本名
    • <email>: メンテナのメールアドレス

• <release>: 現リリースに関する情報

  • <version>: リリースのバージョン番号
  • <state>: リリースの状態 (stable, beta, alpha, devel もしくは snapshot のいずれか)
  • <date>: リリースされた日時
  • <license>: コードに適用された ライセンス
  • <notes>: リリースノート

  • <filelist>

    • <file name="xxx" role="xxx" />: ファイル名
    • <dir name="xxx" [role="xxx"]>: サブディレクトリ名。このサブディレクトリには <file role="xxx"> 要素を再度含むことができます。

• <deps>: パッケージの依存性のリスト

  • <dep type="xxx" rel="yyy" optional="yes">name</dep> : 依存性に関するより詳細な情報については 下記 を参照してください。

• <changelog>: パッケージに関する更新履歴的情報

  • <release>

    • <version>: 対象リリースのバージョン
    • <state>: 対象リリースの状態
    • <date>: 対象リリースの日付
    • <notes>: 更新履歴の情報

要素内で使用可能な文字は A-Z および a-z です。 他の文字、たとえば é など、 を使用するには、エンティティを用います（この場合は é）。

package.xml ファイルを PEAR_PackageFileManager を使って作成する場合には、 インストールされた PEAR をバージョン 1.4.0a2 以降にしておくと良いでしょう。 FileManager が自動的に処理しますので、使用可能な文字について心配しなくてすみます。

package.xml ファイルを手動で作成する場合は、使用するエンティティを 自ら入力する必要があります。 一般的に良く使われるエンティティについては、 http://www.evolt.org/article/A_Simple_Character_Entity_Chart/17/21234/ を参照してください。 必要な文字が無い場合は、 http://www.oasis-open.org/docbook/xmlcharent/0.1/index.shtml や他のリストも参照してください。

package.xml の検証には、 libxml2 に同梱されているツール xmllint を使用します。

xmllint --dtdvalid http://pear.php.net/dtd/package-1.0 --noout package.xml

<?xml version="1.0" encoding="ISO-8859-1" ?>
<package version="1.0">
 <name>Money_Fast</name>
 <summary>Make money fast.</summary>
 <description>
  This package helps you to make money pretty fast.
 </description>
 <license>PHP License</license>
 <maintainers>
  <maintainer>
   <user>foo</user>
   <name>Joe Foo</name>
   <email>[email protected]</email>
   <role>lead</role>
  </maintainer>
 </maintainers>

 <release>
  <version>1.0</version>
  <date>2002-05-27</date>
  <state>stable</state>
  <notes>
   This is the first release.
  </notes>
  <filelist>
   <dir name="/" baseinstalldir="Money">
    <file role="php" name="Fast.php" />
   </dir>
  </filelist>
 </release>
</package>

この package.xml は、必要な要素をすべて含んでおり、 テンプレートとして使用できます。 多くの場合、タグ間の文字データを変更するだけで、この例を自作のパッケージに適用できます。

<?xml version="1.0" encoding="ISO-8859-1" ?>

[...]

 <release>
  <version>1.0</version>
  <date>2002-07-23</date>
  <state>stable</state>
  <notes>
   This is the first release.
  </notes>
  <filelist>
   <dir name="/" baseinstalldir="Money">
    <file role="php" name="Fast.php" />
    <dir name="Calculator">
     <file name="Calculator.php" role="php" />
     <file name="Currency.php" role="php" />
     <file name="Stocks.php" role="php" />
    </dir>
    <dir name="docs">
     <file name="README.txt" role="doc" />
     <file name="tutorial.txt" role="doc" />
     <dir name="examples">
      <file name="NASDAQ.php" role="php" />
      <file name="DAX.php" role="php" />
     </dir>
    </dir>
   </dir>
  </filelist>
 </release>
</package>

この例では、便利な機能が使われています。パッケージ中に 同じタイプのファイルだけを含むディレクトリがある場合、 role 属性を <dir> タグに記述することで、 個別の <file> タグにいちいち記述しないですみます。

このセクションで得た知識に基づいて、 パッケージ定義ファイルを作成可能になったことでしょう。 この話題について、さらに疑問がある場合は、 メーリングリストで 質問してください。

<file> タグ中の type 属性により ファイルのタイプを指定します。これにより、ファイルがインストール される場所が決まります。

PEAR パッケージのインストールの際に、PEAR パッケージマネージャに インストール先のシステム特性をチェックさせることが可能です。 インストールに当たって必要な（もしくは推奨される）システム特性を <dep> タグで定義します。

<?xml version="1.0" encoding="ISO-8859-1" ?>

[...]
 </release>
 <deps>
  <dep type="php" rel="ge" version="4.3.0" />
  <dep type="pkg" rel="has" version="1.0">XML_Parser</dep>
 </deps>
</package>

      
$ pear install <package>
Optional dependencies:
Package `XML_Tree' is recommended to utilize some features.
Package `MDB' is recommended to utilize some features.