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

buildFromDirectoryメソッドは、指定されたディレクトリの内容から新しいアーカイブファイルを作成するメソッドです。このメソッドは、PharDataクラスが提供する機能の一つで、アプリケーションやライブラリを配布するために、複数のファイルを一つにまとめる際に使用されます。具体的には、指定したディレクトリとその内部にあるすべてのサブディレクトリ、そしてそれらに含まれるファイルをまとめて、一つのアーカイブファイルとして構築します。PharDataクラスは、PHP独自のPhar形式だけでなく、一般的なTarやZip形式のアーカイブも扱えるため、幅広い用途で利用可能です。メソッドの呼び出し時には、アーカイブに含めるファイルや除外するファイルを正規表現を使って指定できるため、必要なデータのみを厳選してパッケージ化できます。これにより、複雑なディレクトリ構造を持つプロジェクトでも、デプロイや配布を効率的に行い、管理を簡素化することが可能になります。システム開発において、ファイル群を一つのまとまりとして扱うための非常に便利な機能です。

Copy
1<?php
2$pharData = new PharData('my_archive.tar');
3$addedFiles = $pharData->buildFromDirectory('path/to/source/directory');
4?>

string $directory, ?string $pattern = null

• string $directory: Pharアーカイブに含めるファイルが含まれるディレクトリへのパス
• ?string $pattern = null: DirectoryIterator::SKIP_DOTS を適用したglobパターン。指定しない場合はディレクトリ内のすべてのファイルが対象となる

array<string, bool>

指定されたディレクトリ内のファイルとディレクトリを Phar アーカイブにビルドした結果を、ファイルパスをキー、成功したかどうかを示す真偽値を値とする連想配列で返します。