php-extended/php-file-object

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

8.0.6 2025-03-02 17:03 UTC

Requires

• php: >=8.1
• php-extended/php-file-interface: ^8

Requires (Dev)

• php-extended/placeholder-phpunit: ^9

MIT

• Anastaszor

• php
• file
• filesystem
• object

README

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

Installation

The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.

• Download composer.phar from their website.
• Then run the following command to install this library as dependency :
• php composer.phar php-extended/php-file-object ^8

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).