Phar::buildFromDirectory

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

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

Descrierea

public Phar::buildFromDirectory ( string $base_dir , string $regex = ? ) : array

Notă:

Această metodă necesită ca parametrul php.ini phar.readonly să fie stabilit în 0 pentru ca obiectele Phar să funcționeze. În caz contrar va fi emisă o excepție PharException.

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().

Parametri

base_dir

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

regex

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.

Valorile întoarse

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

Erori/Excepții

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

Exemple

Example #1 A Phar::buildFromDirectory() example

<?php
// 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'));
?>

A se vedea și

add a note add a note

User Contributed Notes 1 note

up
1
dalfarra at codref dot com
7 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):

/tmp/myfolder
  /nbproject
  /something
  /something-else
    /nbproject
  /file1.php
  /file2.php

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

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

the archive will contain:
/
  /something
  /something-else
  /file1.php
  /file2.php
To Top