【PHP8.x】Phar::buildFromDirectory()メソッドの使い方

buildFromDirectoryメソッドは、PHPアプリケーションやライブラリを単一のアーカイブファイル（Pharファイル）としてパッケージ化するために使用されるメソッドです。このメソッドは、指定されたディレクトリの内容を再帰的に走査し、その中に含まれるファイルやサブディレクトリをPharアーカイブに効率的に追加します。

第1引数には、アーカイブに含めたいファイルのルートとなるディレクトリのパスを指定します。このディレクトリ内のすべてのファイルとサブディレクトリは、その相対パスを保ったままアーカイブに追加されます。第2引数はオプションで、正規表現パターンを指定できます。このパターンを使用することで、アーカイブに含めるファイルを特定の条件でフィルタリングすることが可能です。例えば、.php拡張子を持つファイルだけを含めたり、テストファイルなどの特定のファイルをアーカイブから除外したりすることができます。

このメソッドを利用することで、複雑な構成を持つアプリケーションでも、すべての関連ファイルを一つの実行可能なPharファイルにまとめ上げることが可能になります。これにより、アプリケーションの配布、デプロイメント、管理が大幅に簡素化され、単一ファイルを転送するだけでアプリケーション全体を配置できるようになります。

Copy
1<?php
2
3// Pharアーカイブを新規作成または既存のものを開きます。
4$phar = new Phar('my_application.phar');
5
6// 指定されたディレクトリ ('./source_files') から、
7// オプションとして正規表現 ('/\.php$/i' はPHPファイルにマッチ) に
8// 合致するファイルだけをPharアーカイブに追加します。
9$addedFiles = $phar->buildFromDirectory('./source_files', '/\.php$/i');
10
11?>

string $directory, string $pattern = ''

• string $directory:pharアーカイブに含めるファイルが格納されているディレクトリへのパス
• string $pattern = '':pharアーカイブに含めるファイルの名前のパターン。デフォルトでは空文字列で、すべてのファイルが含まれます。

array

Phar::buildFromDirectory メソッドは、指定されたディレクトリから Phar アーカイブを構築する際に、アーカイブに追加されたファイルパスの配列を返します。