ride / lib-archive
Abstraction library for (de)compression of archives.
1.0.0
2016-10-13 11:32 UTC
Requires
- ride/lib-system: ^1.0.0
This package is auto-updated.
Last update: 2024-10-13 00:06:40 UTC
README
Ride library for abstraction of file archiving.
What's In This Library
Archive
The Archive interface is used to implement a compression algorithm. You can use it to compress files into an archive or to decompress an archive to your file system.
There are 2 implementations provided:
- PharArchive
- ZipArchive
Code Sample
Check this code sample to see how to use this library:
<?php use ride\library\archive\ZipArchive; use ride\library\system\file\FileSystem; function createArchive(FileSystem $fileSystem) { // create the archive $archiveFile = $fileSystem->getTemporaryFile(); $archive = new ZipArchive($archiveFile); // compress single file in the root of the archive $file = $fileSystem->getFile('/my/file'); $archive->compress($file); // compress multiple files in a folder in the archive $files = array( $fileSystem->getFile('/my/second-file'), $fileSystem->getFile('/my/third-file'), ); $archive->compress($files, 'path/in/archive'); // we're done here return $archiveFile; }
Installation
You can use Composer to install this library.
composer require ride/lib-archive