Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.25 KB

README.md

File metadata and controls

56 lines (34 loc) · 1.25 KB

Pathsilo

Generates filesystem paths. Includes name based paths and date based paths.

The intended use case is to facilitate storage and retrieval of "large" numbers of files by storing them in multiple folders.

Install

Via Composer

$ composer require jacqball/pathsilo

Usage

// Generate path based on key string (key can be anything such as a file name)
$ps = new Jacq\PathSilo\PathSilo();
$path = $ps->getPath('SomeTextString');

// Generate path from date string - dates are not validated, if you pass in 8 digits it will operate
$dps =  new Jacq\PathSilo\DatePathSilo();
$path = $dps->getPath('20160831');

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email jacqball@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.