omnidrive / local

1.x-dev 2026-10-23 07:22 UTC

Requires

• php: >=8.2
• league/flysystem-local: ^3.0
• omniscient/omnidrive: ^1.0@dev

Requires (Dev)

• phpunit/phpunit: ^11.0

MIT

• Marco Meyer

• filesystem
• storage
• local
• Flysystem
• omnidrive

Published on Packagist.org on 2026-10-23 07:26 UTC

README

A directory of this machine as an omnidrive drive, through league/flysystem-local.

composer require omniscient/omnidrive omnidrive/local

use Omnidrive\Local\LocalDriveFactory;
use Omnidrive\Registry;

$drives = new Registry([new LocalDriveFactory()], [
    'uploads' => ['factory' => 'local', 'options' => ['root' => __DIR__.'/var/uploads', 'public_url' => '/uploads']],
]);
$drives->get('uploads')->write('avatars/1.png', $bytes);
$drives->get('uploads')->localPath('avatars/1.png');   // .../var/uploads/avatars/1.png

Option	Default
root	required	the directory behind the drive's paths
lazy_root	false	the root made on the first write rather than when the drive is built
lock	true	an exclusive lock while a file is written
links	disallow	a symbolic link met in a listing is an error; skip leaves it out
permissions	0644/0600, 0755/0700	the Unix mode of each visibility, for files and directories
public_url, visibility, directory_visibility, retain_visibility		as every drive

capabilities(): local, public addresses with public_url, no temporary address.

Verified, and not

• Verified (2026-10-23, omnidrive's harness, PHP 8.4): the contract's tests on a temporary directory; the modes of each visibility as permissions gives them (octal strings too); a link refused, then skipped; the root made at once or lazily; the drive in plain PHP (bare).
• Not verified: Windows paths and permissions.

License: MIT. Unofficial; not affiliated with The PHP League.