LocalStorage

MMO\edms\storages · 1 symbol · generated 5 Oct 2026

class

LocalStorage

The bytes of the files, in a local folder ($folder): a key is a path in it.

class MMO\edms\storages\LocalStorage implements MMO\edms\interfaces\iStorage

Namespace: MMO\edms\storages
Implements: iStorage

The folder belongs outside the web root, the download route being the only way to the files: a warning is logged when it is not, and an apache `.htaccess` refusing every request is written at its root anyway.

$storage = new LocalStorage(); $storage->put('2026/09/0f3a...', $uploadedFilename); $handle = $storage->open('2026/09/0f3a...');

Index

	folder
	protected
	delete($key)
	exists($key)
	filename($key)
	getFolder()
	keys()
	localFilename($key)
	open($key)
	protect()	Make sure a web server does not send the stored files itself: an apache `.htaccess` refusing every request, and a warning when the folder is inside the web root, where it does not belong.
	put($key, $filename)
	size($key)
	__construct($folder)

Properties2

folder

string $folder = '{files}'

Type: string

protected

protected bool $protected = false

Type: bool

Methods11

delete($key)

LocalStorage.php:59

function delete(string $key): void

$key	string
returns	void

exists($key)

LocalStorage.php:64

function exists(string $key): bool

$key	string
returns	bool

filename($key)

LocalStorage.php:39

function filename(string $key): string

$key	string
returns	string	where the bytes of $key are (or would be)
throws		if $key is not a key: a segment starts with a letter or a digit, so none is `..`

$storage->filename('2026/09/0f3a'); // '/var/app/files/2026/09/0f3a'

getFolder()

LocalStorage.php:30

function getFolder(): string

returns

string

the folder of the files, as an absolute path

keys()

LocalStorage.php:78

function keys(): Generator

returns

Generator

localFilename($key)

LocalStorage.php:73

function localFilename(string $key): ?string

$key	string
returns	null \| string

open($key)

LocalStorage.php:52

function open(string $key)

$key

string

protect()

LocalStorage.php:96

Make sure a web server does not send the stored files itself: an apache .htaccess refusing every request, and a warning when the folder is inside the web root, where it does not belong.

protected function protect(): void

returns

void

put($key, $filename)

LocalStorage.php:46

function put(string $key, string $filename): void

$key	string
$filename	string
returns	void

size($key)

LocalStorage.php:68

function size(string $key): ?int

$key	string
returns	null \| int

__construct($folder)

LocalStorage.php:25

function __construct(?string $folder = null)

$folder = null

null | string