README.md 736 Bytes
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
PHAR Utils
==========

PHAR file format utilities, for when PHP phars you up.

Installation
------------

`composer require seld/phar-utils`

API
---

### `Seld\PharUtils\Timestamps`

- `__construct($pharFile)`

  > Load a phar file in memory.

- `updateTimestamps($timestamp = null)`

  > Updates each file's unix timestamps in the PHAR so the PHAR signature
  > can be produced in a reproducible manner.

- `save($path, $signatureAlgo = '')`

  > Saves the updated phar file with an updated signature.
  > Algo must be one of `Phar::MD5`, `Phar::SHA1`, `Phar::SHA256`
  > or `Phar::SHA512`

Requirements
------------

PHP 5.3 and above

License
-------

PHAR Utils is licensed under the MIT License - see the LICENSE file for details