raulfraile / distill
Smart compressed files extractor
Installs: 169 891
Dependents: 11
Suggesters: 0
Security: 0
Stars: 224
Watchers: 8
Forks: 21
Open Issues: 8
Requires
- php: >=5.4.0
- pimple/pimple: ~3.0
- symfony/filesystem: ~2.4|^3.0
- symfony/process: ~2.4|^3.0
Requires (Dev)
- mockery/mockery: 0.9.1
- raulfraile/ladybug: ~1.0
- symfony/finder: ~2.4|^3.0
Suggests
- ext-rar: Allows to uncompress rar files using RarArchive
- ext-zip: Allows to uncompress zip files using ZipArchive
This package is not auto-updated.
Last update: 2024-10-26 16:49:05 UTC
README
Distill extracts files from compressed archives.
Features:
- Extract files from
ar
,bz2
,cab
,chm
,cpio
,deb
,dmg
,epub
,gz
,phar
,rar
,shar
,tar
,tar.bz2
,tar.gz
,tar.xz
,wim
,7z
,xz
,Z
andzip
archives. - Different decompression methods under the hood: PHP extensions, command line binaries, third-party libraries and even fallback methods in plain PHP.
- Strategy to choose the right file in case there are more than one available format. Strategies can be based on minimizing bandwidth or optimizing decompression speed.
Installation
The recommended way to install Distill is through Composer. Require the raulfraile/distill
package into your composer.json
file:
{ "require": { "raulfraile/distill": "@stable" } }
Protip: you should browse the raulfraile/distill page to choose a stable version to use, avoid the @stable
meta constraint.
Otherwise, install the library and setup the autoloader yourself.
Example
use Distill\Distill; $distill = new Distill(); $distill->extract(__DIR__ . '/../tests/files/file_ok.zip', __DIR__ . '/extract');
Formats
Strategies
Distill allows to choose one format in case there are many available. For example, it can be useful for installers that want to reduce the bandwidth usage trying to choose compression formats with higher compression ratio and available in the client machine.
The library provides three strategies (more can be added):
- Minimum size (default): Choose files with higher compression ratio.
- Uncompression speed: Choose files which are faster to uncompress.
- Random: Gets a random file which can be uncompressed by the system.
use Distill\Distill; $distill = new Distill(); $preferredFile = $distill ->getChooser() ->setStrategy(new \Distill\Strategy\MinimumSize()) ->addFile('http://get.symfony.com/Symfony_Standard_Vendors_2.5.3.zip') ->addFile('http://get.symfony.com/Symfony_Standard_Vendors_2.5.3.tgz') ->getPreferredFile(); echo $preferredFile; // http://get.symfony.com/Symfony_Standard_Vendors_2.5.3.tgz
use Distill\Distill; $distill = new Distill(); $preferredFile = $distill ->getChooser() ->setStrategy(new \Distill\Strategy\UncompressionSpeed()) ->addFile('test.phar') ->addFile('test.zip') ->getPreferredFile(); echo $preferredFile; // test.zip
Command line tool
If you are looking for a command line tool to extract compressed files check out distill-cli, which uses this library:
$ distill-cli extract archive.tar.gz path/
Contributing
See CONTRIBUTING file.
Running the Tests
Install the Composer dev
dependencies:
$ composer install --dev
Then, run the test suite using PHPUnit:
$ phpunit
Credits
- Raul Fraile (@raulfraile)
- All contributors
License
Distill is released under the MIT License. See the bundled LICENSE file for details.