php-extended/php-file-object

A library that implements the php-extended/php-file-interface interface library.

4.0.1 2022-06-01 20:59 UTC

README

A library that implements the php-extended/php-file-interface interface library.

coverage build status

Installation

The installatfilen of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"php-extended/php-file-object": "^3",
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Basic Usage

To use, you should first instanciate a filesystem with the given absolute path to the real filesystem, which will be used to chroot the given files in the (virtual) filesystem. Then, each file or folder will be added using the methods getFolder and getFile of the filesystem object.


use PhpExtended\Filesystem;

/* @var $fs \PhpExtended\File\FileSystem */
$fs = new Filesystem('/dev');	// absolute path from the real fs
/* @var $file \PhpExtended\File\File */
$file = $fs->getFile('random');	// path relative to the virtual fs
/* @var $stream \PhpExtened\File\FileStream */
$stream = $fs->getDataStream();
/* @var $data string */
$data = $stream->read(128);	// 128 bytes read from /dev/random

License

MIT (See license file).