Recommend this page to a friend! |
Download |
Info | Documentation | Files | Install with Composer | Download | Reputation | Support forum | Blog | Links |
Ratings | Unique User Downloads | Download Rankings | ||||
66% | Total: 623 | All time: 5,073 This week: 69 |
Version | License | PHP version | Categories | |||
unified-archive 0.0.8 | MIT/X Consortium ... | 5.1.0 | PHP 5, Files and Folders, Compression, S... |
Description | Author | |||
This package can manage archives in the ZIP, RAR, TAR, GZ, BZIP2 formats. Innovation Award
|
zip archives
add files to zip archive
UnifiedArchive - unified interface to archive (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 packer and unpacker + fully implemented PclZip-like interface (create, listContent, extract, properties, add, delete, merge, duplicate).
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.
Composer package: wapmorgan/unified-archive
[1]
{
"require": {
"wapmorgan/unified-archive": "dev-master"
}
}
Import a class
require 'vendor/autoload.php';
use \wapmorgan\UnifiedArchive\UnifiedArchive;
At the beginning, try to open the file with automatic detection of a format by name. In case of successful recognition the object of UnifiedArchive will be returned. in case of failure - null
$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');
Further, read the list of files of archive (notice, this function returns only names of files)
var_dump($archive->getFileNames());
Further, you can receive additional information on the concrete file by means of the getFileData function
var_dump($archive->getFileData('README.md'));
Further, you can receive file contents by means of the getFileContent function
```php
var_dump($archive->getFileContent('README.md'));
$archive->extractNode(outputFolder, archiveFolder = '/');
// to unpack all contents of archive
$archive->extractNode(tmpnam('/tmp', 'arc'));
// to unpack the src catalog in archive in the sources catalog on a disk
$archive->extractNode(tmpnam('/tmp', 'sources'), '/src/');
// to unpack the bookmarks catalog in archive in the sources catalog on a
// disk
$archive->extractNode(tmpnam('/tmp', 'sources'), '/bookmarks/');
To delete a single file from an archive:
$archive->deleteFiles('README.md');
To delete multiple files from an archive
$archive->deleteFiles(array('README.md', 'MANIFEST.MF'));
In case of success the number of successfully deleted files will be returned.
To add completely the catalog with all attached files and subdirectories:
$archive->addFiles('/var/log');
To add one file:
$archive->addFiles('/var/log/syslog');
To add some files or catalogs:
$archive->addFiles(array(directory, file, file2, ...));
Full syntax of multiple files addition is described in next section Process of archive creation.
To pack completely the catalog with all attached files and subdirectories:
UnifiedArchive::archiveNodes('/var/log', 'Archive.zip');
To pack one file:
UnifiedArchive::archiveNodes('/var/log/syslog', 'Archive.zip');
To pack some files or catalogs:
UnifiedArchive::archiveNodes(array(directory, file, file2, ...), 'Archive.zip');
Extended syntax with possibility of rewriting of paths and additional opportunities:
$nodes = array(
array('source' => '/etc/php5/fpm/php.ini', 'destination' => 'php.ini'),
array('source' => '/home/.../Dropbox/software/1/',
'destination' => 'SoftwareVersions/', 'recursive' => true),
array('source' => '/home/.../Dropbox/software/2/',
'destination' => 'SoftwareVersions/', 'recursive' => true),
array('source' => 'pictures/other/cats/*', 'destination' => 'Pictures/'),
array('source' => '~/Desktop/catties/*', 'destination' => 'Pictures/'),
array('source' => '/media/wapmorgan/.../Cats/*',
'destination' => 'Pictures/'),
);
UnifiedArchive::archiveNodes($nodes, 'Archive.zip');
It is impossible to create the ideal archiver, here therefore some restrictions and technical features are listed further:
To see all opportunities of this remarkable UnifiedArchive, together with source codes some scripts are delivered. They can become quite good replacement to standard commands of file system (tar, unzip, rar, gzip).
DIRECTORY=/tmp/output
# /All couples of commands are completely identical/
# /tar replacement/
tar xv -C $DIRECTORY archive.tar.gz
./cli.hierarchy.php -e -n / -a archive.tar.gz -o $DIRECTORY
# /unzip replacement/
unzip archive.zip -d $DIRECTORY
./cli.hierarchy.php -e -n / -a archive.zip -o $DIRECTORY
# /unrar replacement/
unrar x archive.rar $DIRECTORY
./cli.hierarchy.php -e -n / -a archive.rar -o $DIRECTORY
# /gzip -d replacement/
gzip -d -k archive.gz && mv archive $DIRECTORY
./cli.hierarchy.php -e -n / -a archive.gz -o $DIRECTORY
You noticed? The universal extractor itself defines type of archive and there is no need manually to choose type.
We will continue and look at examples of replacement of the unbridled number of utilities on one command:
# List of nodes in archive
./cli.hierarchy.php -l -a archivename
# Table of nodes in archive
./cli.hierarchy.php -t -a archivename
# Hierarchy of nodes in archive
./cli.hierarchy.php -h -a archivename
# /unzip -v archivename file_in_archive replacement/
./cli.hierarchy.php -d -a archivename -n file_in_archive
# /unzip archivename file_in_archive replacement/
./cli.hierarchy.php -e -a archivename -n /file_in_archive -o .
# /unzip -p archivename file_in_archive replacement/
./cli.hierarchy.php -u -a archivename -n file_in_archive
# /unzip archivename "directory_in_archive/" replacement */
./cli.hierarchy.php -e -a archivename -n /directory_in_archive/ -o .
# /Archive information/
./cli.hierarchy.php -i -a archivename
In the future probably I will add still some scripts or I will update existing having added some operations.
It is very easy and equally universal for any of supported types of archives (which already about 5)!
Try, it will be pleasant to you!
It is possible even to use the console version of the archiver in daily work for viewing of contents of archive from the terminal!
Conveniently, isn't that so?
Create object of class \wapmorgan\UnifiedArchive\UnifiedArchive
implementing
the \wapmorgan\UnifiedArchive\AbstractArchive
interface which has the
following methods:
public function __construct($filename, $type);
public function getFileNames();
public function getFileData($filename);
public function getFileContent($filename);
public function countFiles();
public function getArchiveSize();
public function getArchiveType();
public function countCompressedFilesSize();
public function countUncompressedFilesSize();
public function extractNode($outputFolder, $node = '/');
Archive modification
public function deleteFiles($fileOrFiles);
public function addFiles($nodes);
static public function open($filename);
static public function archiveNodes($nodes, $aname);
Yes, you didn't mishear - UnifedArchive provides full realization of the interface known on archiving popular library of PclZip (the last version 2.8.2).
Let's look at it:
use wapmorgan\UnifiedArchive\UnifiedArchive;
require 'vendor/autoload.php';
$archive = UnifiedArchive::open('ziparchive.zip');
$pclzip = $archive->pclzipInteface();
You are from this point free to use all available methods provided by the class PclZip:
All available options and the parameters accepted by original PclZip are also available.
It is also important to note increase in productivity when using my version of the PclZip-interface using a native class for work, over old and working with "crude" contents of archive means of the PHP-interpreter.
*The PclZip-interface is at present in a stage of experimental realization. I ask to take it into account.*
For those who isn't familiar with the PclZip interface or wishes to refresh knowledge, visit official documentation on PclZip on the official site: http://www.phpconcept.net/pclzip.
Also I need to note that one of an option nevertheless is unrealizable: PCLZIP_OPT_NO_COMPRESSION. This option allows to disconnect compression for added files. At present the native library for work doesn't allow to change compression parameters from zip-archive - all added the file forcibly contract. I tried to find a roundabout way, but at present to make it it didn't turn out.
In the examples catalog there are some files for check of operability of the program. start them from a command line.
+---------+--------------+--------------------------------------------------+
| version | date | description |
+---------+--------------+--------------------------------------------------+
| 0.0.8 | Jan 24, 2017 | Added: |
| | | * Initial support for CAB archives without |
| | | extracting. |
| | | Changed: |
| | | * Handling of short names of tar archives. |
| | | * Removed external repository declaration. |
| | | * Removed die() in source code. |
+---------+--------------+--------------------------------------------------+
| 0.0.7 | Jan 14, 2017 | Fixed: |
| | | * Using ereg function on PHP >7. |
+---------+--------------+--------------------------------------------------+
| 0.0.6 | Jan 9, 2017 | Added: |
| | | * Adding files in archive. |
| | | * Deleting files from archive. |
| | | Fixed: |
| | | * Fixed discovering 7z archive number of files |
| | | and creating new archive. |
+---------+--------------+--------------------------------------------------+
| 0.0.5 | Jan 8, 2017 | Added: |
| | | * Support for 7z (7zip) archives. |
+---------+--------------+--------------------------------------------------+
| 0.0.4 | Jan 7, 2017 | Added: |
| | | * Support for single-file bz2 (bzip2) and xz |
| | | (lzma2) archives. |
+---------+--------------+--------------------------------------------------+
| 0.0.3 | Aug 18, 2015 | Changed: |
| | | * archive_tar is no longer a required package, |
| | | now it is a suggestion. |
+---------+--------------+--------------------------------------------------+
| 0.0.2 | May 27, 2014 | Changed: |
| | | * UnifiedArchive released under the MIT license. |
+---------+--------------+--------------------------------------------------+
| 0.0.1 | May 26, 2014 | first release |
+---------+--------------+--------------------------------------------------+
Files (15) |
File | Role | Description | ||
---|---|---|---|---|
examples (3 files) | ||||
src (7 files) | ||||
composer.json | Data | Auxiliary data | ||
doc.archiveNodes.md | Data | Documentation | ||
LICENSE | Lic. | Auxiliary data | ||
README.md | Doc. | Documentation | ||
_config.yml | Data | Auxiliary data |
Files (15) | / | examples |
File | Role | Description |
---|---|---|
cli.fs.php | Example | Example script |
cli.hierarchy.php | Example | Example script |
cli.pack.php | Example | Example script |
Files (15) | / | src |
File | Role | Description |
---|---|---|
AbstractArchive.php | Class | Class source |
function.gzip_stat.php | Aux. | Auxiliary script |
LzwStreamWrapper.php | Class | Class source |
PclZipLikeZipArchiveInterface.php | Class | Class source |
PclZipOriginalInterface.php | Class | Class source |
REGISTER_LZW_STREAM_WRAPPER.php | Aux. | Class source |
UnifiedArchive.php | Class | Class source |
The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
Install with Composer |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
User Ratings | ||||||||||||||||||||||||||||||
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.
Related pages |
Github repository |