2015-08-05 16:55:56 +02:00
|
|
|
# file
|
2015-07-18 21:06:19 +02:00
|
|
|
|
2015-08-05 16:55:56 +02:00
|
|
|
[](https://travis-ci.org/amphp/file)
|
|
|
|
|
[](https://coveralls.io/github/amphp/file?branch=master)
|
2015-07-28 15:53:00 +02:00
|
|
|
|
|
|
|
|
|
2015-07-11 03:59:39 +02:00
|
|
|
|
2015-07-28 15:53:00 +02:00
|
|
|
|
2015-08-05 16:55:56 +02:00
|
|
|
`amphp/file` is a non-blocking filesystem library for use with the [`amp`](https://github.com/amphp/amp)
|
2015-07-28 15:53:00 +02:00
|
|
|
concurrency framework.
|
2015-07-11 03:59:39 +02:00
|
|
|
|
|
|
|
|
**Dependencies**
|
|
|
|
|
|
|
|
|
|
- PHP 5.5+
|
2015-07-18 21:06:19 +02:00
|
|
|
- [eio](https://pecl.php.net/package/eio)
|
|
|
|
|
- [php-uv](https://github.com/bwoebi/php-uv) (experimental, requires PHP7)
|
2015-07-11 03:59:39 +02:00
|
|
|
|
2015-08-05 16:55:56 +02:00
|
|
|
`amphp/file` works out of the box without any PHP extensions but it does so using
|
2015-07-19 19:18:01 +02:00
|
|
|
blocking functions. This capability only exists to simplify development across
|
2015-08-05 16:55:56 +02:00
|
|
|
environments where extensions may not be present. Using `amphp/file` in production
|
2015-07-19 19:18:01 +02:00
|
|
|
without pecl/eio or php-uv is **NOT** recommended.
|
2015-07-11 03:59:39 +02:00
|
|
|
|
|
|
|
|
**Current Version**
|
|
|
|
|
|
2015-08-05 16:55:56 +02:00
|
|
|
`amphp/file` is currently pre-alpha software and has no tagged releases. Your mileage may vary.
|
2015-07-11 03:59:39 +02:00
|
|
|
|
|
|
|
|
**Installation**
|
|
|
|
|
|
|
|
|
|
```bash
|
2015-08-05 16:55:56 +02:00
|
|
|
$ composer require amphp/file:dev-master
|
2015-07-11 03:59:39 +02:00
|
|
|
```
|
2015-07-30 15:07:01 +02:00
|
|
|
|
|
|
|
|
**TODO**
|
|
|
|
|
|
2015-08-05 16:55:56 +02:00
|
|
|
- seek/read/write to/from specific offsets on open file handles
|
|
|
|
|
- expose API for receiving notifications when files/directories are modified
|
