PHPackages                             icicleio/filesystem - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Queues & Workers](/categories/queues)
4. /
5. icicleio/filesystem

AbandonedArchivedLibrary[Queues & Workers](/categories/queues)

icicleio/filesystem
===================

Asynchronous filesystem component for Icicle.

v0.1.0(10y ago)38288MITPHP

Since Jan 28Pushed 10y ago5 watchersCompare

[ Source](https://github.com/icicleio/filesystem)[ Packagist](https://packagist.org/packages/icicleio/filesystem)[ Docs](http://icicle.io)[ RSS](/packages/icicleio-filesystem/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (4)Versions (5)Used By (0)

Asynchronous File Access for Icicle
===================================

[](#asynchronous-file-access-for-icicle)

Asynchronous filesystem access that is *always* non-blocking, no extensions required.

This library is a component for [Icicle](https://github.com/icicleio/icicle), providing asynchronous filesystem functions and abstracting files as asynchronous [streams](https://github.com/icicleio/stream). Like other Icicle components, this library uses [Coroutines](//github.com/icicleio/icicle/wiki/Coroutines) built from [Awaitables](https://github.com/icicleio/icicle/wiki/Awaitables) and [Generators](http://www.php.net/manual/en/language.generators.overview.php) to make writing asynchronous code more like writing synchronous code.

[![Build Status](https://camo.githubusercontent.com/d584879588143397c0f9d3ddd4f093a19dc1931149cae76f803d9f804ee2d9ba/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f696369636c65696f2f66696c6573797374656d2f76312e782e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/icicleio/filesystem)[![Coverage Status](https://camo.githubusercontent.com/866f75cbdc01ae23f516225e9fa757b9b3bfd07a2fd6afc514968284b485f3b0/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f696369636c65696f2f66696c6573797374656d2f76312e782e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/r/icicleio/filesystem)[![Semantic Version](https://camo.githubusercontent.com/1a6346d948d1ed3a1c5e810e9968be69955b6f9624059dee1c7f1ec48409095f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f696369636c65696f2f66696c6573797374656d2e7376673f7374796c653d666c61742d737175617265)](http://semver.org)[![MIT License](https://camo.githubusercontent.com/17953d35d3c14209d17173aae3e02cad91d571cf54cafcb27d691c64fa2fb5aa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f696369636c65696f2f66696c6573797374656d2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![@icicleio on Twitter](https://camo.githubusercontent.com/fb16a2e03bb85dd9926a15e837d3754b7766046281e2698271930aadbcd972cf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d253430696369636c65696f2d3531383963372e7376673f7374796c653d666c61742d737175617265)](https://twitter.com/icicleio)

#### Documentation and Support

[](#documentation-and-support)

- [Full API Documentation](https://icicle.io/docs)
- [Official Twitter](https://twitter.com/icicleio)
- [Gitter Chat](https://gitter.im/icicleio/icicle)

##### Requirements

[](#requirements)

- PHP 5.5+ for v0.1.x branch (current stable) and v1.x branch (mirrors current stable)
- PHP 7 for v2.0 branch (under development) supporting generator delegation and return expressions

##### Installation

[](#installation)

The recommended way to install is with the [Composer](http://getcomposer.org/) package manager. (See the [Composer installation guide](https://getcomposer.org/doc/00-intro.md) for information on installing and using Composer.)

Run the following command to use this library in your project:

```
composer require icicleio/filesystem
```

You can also manually edit `composer.json` to add this library as a project requirement.

```
// composer.json
{
    "require": {
        "icicleio/filesystem": "^0.1"
    }
}
```

##### Suggested

[](#suggested)

- [eio extension](http://php.net/manual/en/book.eio.php): Uses libeio to provide asynchronous file access (v1.2.6+ required).

#### Example

[](#example)

```
#!/usr/bin/env php