<file>
<file> – <contents> タグ内のファイルを記述する
ファイルを記述する
<file> タグは、
パッケージのソースに含まれるディレクトリ内のファイルについて記述します。
file タグを記述できる場所は、
<dir>
タグの子要素としてだけです。
ファイルタスク を使えば、パッケージ作成時やインストール時にファイルを変更することができます。
属性
| 属性名 | 説明 |
|---|---|
| name | ソース内のファイルの名前。 |
| role | このファイルの型。 roles を参照ください。 |
| 属性名 | 説明 |
|---|---|
| baseinstalldir | すべてのファイルやサブディレクトリのインストール先の相対位置。 |
| md5sum | ファイルのコンテンツの MD5 ハッシュ。これは pear package を実行すると自動的に生成されるので、 自分で設定する必要はありません。 |
以前の (package.xml v1) オプション属性
<platform>および<install-as>は リリースタグ に置き換えられました。具体的には、
<install>を使って<install-as>を指定し、<ignore>を<installconditions>と組み合わせて 特定のプラットフォームではインストールしないようにしたりすることができます。
ロール
<file> タグの
<role> 属性は、
そのファイルの型やインストール先を定義します。
| ロールの値 | 説明 | 対象ディレクトリ |
|---|---|---|
<php> |
PHP ソースファイル | $php_dir (インクルードパス) |
<doc> |
ドキュメントあるいはサンプルファイル | $doc_dir/Package_Name/ |
<data> |
パッケージ関連のデータファイル (画像やデータテーブル、 CSS など) | $data_dir/Package_Name/ |
<www> |
HTTPd のドキュメントルートに置くファイル | $www_dir/ |
<test> |
パッケージ関連のテストファイル (ユニットテストなど) | $test_dir/Package_Name/ |
<script> |
パッケージ関連のシェルスクリプト | PHP バイナリディレクトリ ($bin_dir) あるいは 定義されていれば PHP_PEAR_BIN_DIR |
<ext> |
拡張モジュール、動的読み込み可能なライブラリ | PHP 拡張モジュールディレクトリ ($ext_dir) あるいは 定義されていれば PHP_PEAR_EXTENSION_DIR |
<src> / <extsrc> |
C あるいは C++ のソースコード | 直接コピーされることはありません。拡張モジュールのビルドに用います。 |
$php_dir のようなディレクトリの位置は PEAR で設定することができます。現在の値を取得するには pear config-show あるいは pear config-get php_dir を使用します。
例
<contents>
<dir name="/">
<dir name="examples">
<!-- gets installed as $doc_dir/Package_Name/examples/authors.php -->
<file name="authors.php" role="doc" />
<file name="authors.tpl" role="doc" />
<file name="README" role="doc" />
</dir>
<dir name="HTML">
<dir name="Template">
<!-- gets installed as $php_dir/HTML/Template/PHPLIB.php -->
<file name="PHPLIB.php" role="php" />
<dir name="PHPLIB">
<file name="Generator.php" role="php" />
<file name="Helper.php" role="php" />
<file name="Tool.php" role="php" />
<file name="Validator.php" role="php" />
</dir>
</dir>
</dir>
<dir name="tests">
<file name="AllTests.php" role="test" />
<file name="GeneratorTest.php" role="test" />
<file name="HelperTest.php" role="test" />
<file name="ValidatorTest.php" role="test" />
</dir>
</dir>
</contents>
<dir name="/">
<dir name="examples">
<!-- gets installed as $doc_dir/Package_Name/examples/authors.php -->
<file name="authors.php" role="doc" />
<file name="authors.tpl" role="doc" />
<file name="README" role="doc" />
</dir>
<dir name="HTML">
<dir name="Template">
<!-- gets installed as $php_dir/HTML/Template/PHPLIB.php -->
<file name="PHPLIB.php" role="php" />
<dir name="PHPLIB">
<file name="Generator.php" role="php" />
<file name="Helper.php" role="php" />
<file name="Tool.php" role="php" />
<file name="Validator.php" role="php" />
</dir>
</dir>
</dir>
<dir name="tests">
<file name="AllTests.php" role="test" />
<file name="GeneratorTest.php" role="test" />
<file name="HelperTest.php" role="test" />
<file name="ValidatorTest.php" role="test" />
</dir>
</dir>
</contents>
忘却曲線を使ってこの知識を確実に記憶に残す
