Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Filesystem
ReactPHP's evented asynchronous, non-blocking filesystem access library.
Table of Contents
Introduction
react/filesystem is a package to power your application with asynchronous, non-blocking filesystem access. Asynchronous access is enabled by various adapters described below.
Adapters
- ChildProcessAdapter - Adapter using child processes to perform IO actions (default adapter if no extensions are installed)
Examples
Adding examples here over time.
Creating filesystem object
<?php
$loop = \React\EventLoop\Factory::create();
$filesystem = \React\Filesystem\Filesystem::create($loop);File object
<?php
$loop = \React\EventLoop\Factory::create();
$filesystem = \React\Filesystem\Filesystem::create($loop);
$file = $filesystem->file(__FILE__); // Returns a \React\Filesystem\Node\FileInterface compatible objectReading files
$filesystem->getContents('test.txt')->then(function($contents) {
});Which is a convenience method for:
$filesystem->file('test.txt')->open('r')->then(function($stream) {
return \React\Stream\BufferedSink::createPromise($stream);
})->then(function($contents) {
// ...
});Which in it's turn is a convenience method for:
$filesystem->file('test.txt')->open('r')->then(function ($stream) use ($node) {
$buffer = '';
$deferred = new \React\Promise\Deferred();
$stream->on('data', function ($data) use (&$buffer) {
$buffer += $data;
});
$stream->on('end', function ($data) use ($stream, $deferred, &$buffer) {
$stream->close();
$deferred->resolve(&$buffer);
});
return $deferred->promise();
});Writing files
Open a file for writing (w flag) and write abcde to test.txt and close it. Create it (c flag) when it doesn't exists and truncate it (t flag) when it does.
$filesystem->file('test.txt')->open('cwt')->then(function ($stream) {
$stream->write('a');
$stream->write('b');
$stream->write('c');
$stream->write('d');
$stream->end('e');
});Directory object
<?php
$loop = \React\EventLoop\Factory::create();
$filesystem = \React\Filesystem\Filesystem::create($loop);
$dir = $filesystem->dir(__DIR__); // Returns a \React\Filesystem\Node\DirectoryInterface compatible objectList contents
$filesystem->dir(__DIR__)->ls()->then(function (array $list) {
foreach ($list as $node) {
echo $node->getPath(), PHP_EOL;
}
});Install
The recommended way to install this library is through Composer. New to Composer?
This will install the latest supported version:
$ composer require react/filesystem:^0.1.1License
React/Filesystem is released under the MIT license.
