(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)

Phar::buildFromDirectoryConstruct a phar archive from the files within a directory


public Phar::buildFromDirectory(string $directory, string $pattern = ""): array


Este método requer que a configuração phar.readonly do php.ini seja definida como 0 para funcionar com objetos Phar. Caso contrário, uma exceção PharException será lançada.

Populate a phar archive from directory contents. The optional second parameter is a regular expression (pcre) that is used to exclude files. Any filename that matches the regular expression will be included, all others will be excluded. For more fine-grained control, use Phar::buildFromIterator().



The full or relative path to the directory that contains all files to add to the archive.


An optional pcre regular expression that is used to filter the list of files. Only file paths matching the regular expression will be included in the archive.

Valor Retornado

Phar::buildFromDirectory() returns an associative array mapping internal path of file to the full path of the file on the filesystem.


This method throws BadMethodCallException when unable to instantiate the internal directory iterators, or a PharException if there were errors saving the phar archive.

Registro de Alterações

Versão Descrição
8.1.0 Phar::buildFromDirectory() no longer returns false.


Exemplo #1 A Phar::buildFromDirectory() example

// create with alias "project.phar"
$phar = new Phar('project.phar', 0, 'project.phar');
// add all files in the project
$phar->buildFromDirectory(dirname(__FILE__) . '/project');
$phar->setStub($phar->createDefaultStub('cli/index.php', 'www/index.php'));

$phar2 = new Phar('project2.phar', 0, 'project2.phar');
// add all files in the project, only include php files
$phar2->buildFromDirectory(dirname(__FILE__) . '/project', '/\.php$/');
$phar2->setStub($phar->createDefaultStub('cli/index.php', 'www/index.php'));

Veja Também

add a note

User Contributed Notes 1 note

dalfarra at codref dot com
6 years ago
If you want to exclude a directory from the archive (but include all the other content), the regular expression must take into consideration the whole path of the file, not just the file or directory name relative to the source folder.

As an example, if we want to exclude "nbproject" directory from the archive (and any occurrence of it):


the regex should be:
= '/^(?!(.*nbproject))(.*)$/i'; //ignoring the case

A more complete example:
= 'myarchive.tar';
$folder_to_compress = '/tmp/myfolder';
$archive = new PharData($archive_file);
$exclude = '/^(?!(.*nbproject))(.*)$/i';
unlink($archive_file); // as we already obtained a tar.gz

the archive will contain:
To Top