Extractor library for php

This library extracts your files from compressed packages and returns a Symfony Finder instance, ready to be managed, _(*1)

, _(*2)

Installing/Configuring

Installing Extractor

You have to add require line into you composer.json file, _(*3)

``` yml "require": { "php": ">=5.3.3", ..., _(*4)

"mmoreram/extractor": "dev-master",

}, _(*5)


Then you have to use composer to update your project dependencies

``` bash
$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar update

Usage

Get a finder instance given a compressed file, _(*6)

``` php <?php, _(*7)

use Symfony\Component\Finder\Finder; use Mmoreram\Extractor\Filesystem\TemporaryDirectory; use Mmoreram\Extractor\Resolver\ExtensionResolver; use Mmoreram\Extractor\Extractor;, _(*8)

$temporaryDirectory = new TemporaryDirectory(); $extensionResolver = new ExtensionResolver; $extractor = new Extractor( $temporaryDirectory, $extensionResolver );, _(*9)

/** * @var Finder $files */ $files = $extractor->extractFromFile('/tmp/myfile.rar'); foreach ($files as $file) {, _(*10)

echo $file->getRealpath() . PHP_EOL;

}, _(*11)


## Adapters

This library currently manages these extensions. All of these adapters only
works if the php extension is installed.

* Zip - http://php.net/manual/en/book.zip.php
* Rar - http://php.net/manual/en/book.rar.php
* Phar - http://php.net/manual/en/book.phar.php
* Tar
* GZ
* BZ2

## Directories

This library provide the way of working with temporary and specific directories.

### Temporary directory

``` php
use Mmoreram\Extractor\Filesystem\TemporaryDirectory;
use Mmoreram\Extractor\Resolver\ExtensionResolver;
use Mmoreram\Extractor\Extractor;

$temporaryDirectory = new TemporaryDirectory();
$extensionResolver = new ExtensionResolver;
$extractor = new Extractor(
    $temporaryDirectory,
    $extensionResolver
);

Specific directory

``` php use Mmoreram\Extractor\Filesystem\SpecificDirectory; use Mmoreram\Extractor\Resolver\ExtensionResolver; use Mmoreram\Extractor\Extractor;, _(*12)

$specificDirectory = new SpecificDirectory('/my/specific/path'); $extensionResolver = new ExtensionResolver; $extractor = new Extractor( $specificDirectory, $extensionResolver ); ```, _(*13)