phine / phar-compact
Integrates the compact library with the phar library.
Requires
- php: >=5.3.3
- phine/compact: ~1.1
- phine/exception: ~1.0
- phine/observer: ~2.0
- phine/path: ~1.0
- phine/phar: ~1.0
Requires (Dev)
- league/phpunit-coverage-listener: ~1.0
- phine/test: ~1.0
Suggests
- ext-phar: For creating PHP archives.
This package is not auto-updated.
Last update: 2021-12-07 01:42:01 UTC
README
Integrates the compact library with the phar library.
Requirement
- PHP >= 5.3.3
- Phine Compact >= 1.1
- Phine Exception >= 1.0.0
- Phine Observer >= 2.0
- Phine Phar >= 1.0.0
Installation
Via Composer:
$ composer require "phine/phar-compact=~1.0"
Usage
The library provides a single subject observer for lib-phar. This observer can be registered to the following subjects in order to compact file contents as they are being added to the archive:
Builder::ADD_FILE
Builder::ADD_STRING
To create an observer, you will need a new instance of CompactObserver
.
use Phine\Compact; use Phine\Compact\Collection; use Phine\Phar\Builder; use Phine\Phar\Compact\CompactObserver; // create the archive builder $builder = Builder::create('example.phar'); // create the collection of compactors $collection = new Collection(); $collection->addCompactor(new Compact\Json()); $collection->addCompactor(new Compact\Php()); $collection->addCompactor(new Compact\Xml()); // create the compactor observer $observer = new CompactObserver($collection); // register it with the builder subjects $builder->observe(Builder::ADD_FILE, $observer); $builder->observe(Builder::ADD_STRING, $observer);
With the observer registered, any time a file is added to the archive via the
addFile()
or addFromString()
methods, the contents of the supported file
types will be automatically compacted before being added to the archive.
Documentation
You can find the API documentation here.
License
This library is available under the MIT license.