README

UnifiedArchive - unified interface to all popular archive formats (zip # 7z # rar # gz # bz2 # xz # cab # tar # tar.gz # tar.bz2 # tar.x # tar.Z # iso-9660) for listing, reading, extracting and creation + built-in console archive manager.

Contents:

1. Preamble
2. Installation
3. Usage
   1. Archive modification
   2. Archive creation
4. Formats support
5. API
6. Built-in console archive manager
7. Changelog

Preamble

If on your site there is a possibility of uploading of archives and you would like to add functionality of their automatic unpacking and viewing with no dependency on format of the archive, you can use this library.

Installation

Composer package: wapmorgan/unified-archive [1]

{
    "require": {
        "wapmorgan/unified-archive": "~0.1.2"
    }
}

Usage

1. Import UnifiedArchive

   require 'vendor/autoload.php';
   use \wapmorgan\UnifiedArchive\UnifiedArchive;

2. At the beginning, try to open the file with automatic detection of a format by name. In case of successful recognition an UnifiedArchive object will be returned. In case of failure - null will be returned.

   $archive = UnifiedArchive::open('filename.rar');
   // or
   $archive = UnifiedArchive::open('filename.zip');
   // or
   $archive = UnifiedArchive::open('filename.7z');
   // or
   $archive = UnifiedArchive::open('filename.gz');
   // or
   $archive = UnifiedArchive::open('filename.bz2');
   // or
   $archive = UnifiedArchive::open('filename.xz');
   // or
   $archive = UnifiedArchive::open('filename.cab');
   // or
   $archive = UnifiedArchive::open('filename.tar');
   // or
   $archive = UnifiedArchive::open('filename.tar.gz');
   // or
   $archive = UnifiedArchive::open('filename.tar.bz2');
   // or
   $archive = UnifiedArchive::open('filename.tar.xz');
   // or
   $archive = UnifiedArchive::open('filename.tar.Z');
   // or
   $archive = UnifiedArchive::open('filename.iso');

3. Further, read the list of files of archive.

   $files_list = $archive->getFileNames(); // array with files list
   // ['file', 'file2', 'file3', ...]

4. Further, check that specific file is in archive.

   if ($archive->isFileExists('README.md')) {
      // some operations
   }

5. To get common information about specific file use getFileData() method. This method returns an ArchiveEntry instance

   $file_data = $archive->getFileData('README.md')); // ArchiveEntry with file information

6. To get raw file contents use getFileContent() method

   $file_content = $archive->getFileContent('README.md')); // string
   // raw file content

7. Further, you can unpack all archive or specific files on a disk. The extractFiles() method is intended to it.

   $archive->extractFiles(string $outputFolder, string|array $archiveFiles);

   Example:

   // to unpack all contents of archive to "output" folder
   $archive->extractFiles(__DIR__.'/output');
   
   // to unpack specific files (README.md and composer.json) from archive to "output" folder
   $archive->extractFiles(__DIR__.'/output', ['README.md', 'composer.json']);
   
   // to unpack the "src" catalog with all content from archive into the "sources" catalog on a disk
   $archive->extractFiles(__DIR__.'/output', '/src/', true);

Archive modification

Only few archive formats support modification:

• zip
• 7z
• tar (with restrictions)

For details go to Formats support section.

1. Deletion files from archive

   // Delete a single file
   $archive->deleteFiles('README.md');
   
   // Delete multiple files
   $archive->deleteFiles(['README.md', 'MANIFEST.MF']);
   
   // Delete directory with full content
   $archive->deleteFiles('/src/', true);

   In case of success the number of successfully deleted files will be returned.

   Details.

2. Addition files to archive

   // Add a catalog with all contents with full paths
   $archive->addFiles('/var/log');
   
   // To add one file (will be stored as one file "syslog")
   $archive->addFiles('/var/log/syslog');
   
   // To add some files or catalogs (all catalogs structure in paths will be kept)
   $archive->addFiles([$directory, $file, $file2, ...]);

   Details.

Archive creation

Only few archive formats support modification:

• zip
• 7z
• tar (with restrictions)

For details go to Formats support section.

To pack completely the catalog with all attached files and subdirectories in new archive:

UnifiedArchive::archiveFiles('/var/log', 'Archive.zip');

// To pack one file
UnifiedArchive::archiveFiles('/var/log/syslog', 'Archive.zip');

// To pack some files or catalogs
UnifiedArchive::archiveFiles([$directory, $file, $file2, ...], 'Archive.zip');

Also, there is extended syntax for addFiles() and archiveFiles():

UnifiedArchive::archiveFiles([
          '/var/www/site/abc.log' => 'abc.log',   // stored as 'abc.log'
          '/var/www/site/abc.log',                // stored as '/var/www/site/abc.log'
          '/var/www/site/runtime/logs' => 'logs', // directory content stored in 'logs' dir
          '/var/www/site/runtime/logs',           // stored as '/var/www/site/runtime/logs'
    ], 'archive.zip');

Details.

Formats support

API

API of UnifiedArchive is stored in API document.

Built-in console archive manager

UnifiedArchive is distributed with a unified console program to manipulate popular archive formats. This script is stored in vendor/bin/cam.

It supports all formats that UnifiedArchive does and can be used to manipulate archives without other software. To check your configuration and check formats support launch it with -f flag in console:

$ php vendor/bin/cam -f

Changelog

To see all changes in library go to CHANGELOG file.