https://github.com/voku/diridea
📁 Diridea: process your different directory types
https://github.com/voku/diridea
directory filesystem php
Last synced: 7 months ago
JSON representation
📁 Diridea: process your different directory types
- Host: GitHub
- URL: https://github.com/voku/diridea
- Owner: voku
- License: mit
- Created: 2022-02-20T01:39:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T14:53:38.000Z (12 months ago)
- Last Synced: 2024-10-29T22:47:35.410Z (11 months ago)
- Topics: directory, filesystem, php
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# :file_folder: Diridea
The idea of this library is to provide a simple and easy to understand directory structure for the files in your project + you can run logic on the files and directories.
### Abstract
```*--[web|backend]_[public|private]_[expire|archive]\d[d|h]?_[encrypt]?_[backup]?_[cache]?```
### Regex
https://regex101.com/r/wM17gy/1
```#(?.*?)--(?web|backend)_(?public|private)(?(?_expire|_archive)(?\d+)(?[d|h]))?(?_encrypt)??(?_backup)?(?_cache?)?#```
### Examples
e.g.: ```download--web_public_expire30d```
-> directory with the prefix "download" available in the web, public for all system-users and the files will be expired and deleted after 30 days
e.g.: ```article_images--backend_private_archive7h_encrypt```
-> directory with the prefix "article_images" available in the backend, only accessible for the current system-user and the files will be moved into the "article_images*/archive/" directory after 7 hours
### Usage
$diridea = DirideaFactory::create(
\_\_DIR\_\_ . '/fixture/overview/',
\_\_DIR\_\_ . '/fixture/web/'
);
$result = $diridea->run();
### Unit Test:
1) [Composer](https://getcomposer.org) is a prerequisite for running the tests.
```
composer install
```
2) The tests can be executed by running this command from the root directory:
```bash
./vendor/bin/phpunit
```
### Support
For support and donations please visit [Github](https://github.com/voku/diridea/) | [Issues](https://github.com/voku/diridea/issues) | [PayPal](https://paypal.me/moelleken) | [Patreon](https://www.patreon.com/voku).
For status updates and release announcements please visit [Releases](https://github.com/voku/diridea/releases) | [Twitter](https://twitter.com/suckup_de) | [Patreon](https://www.patreon.com/voku/posts).
For professional support please contact [me](https://about.me/voku).
### Thanks
- Thanks to [GitHub](https://github.com) (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
- Thanks to [IntelliJ](https://www.jetbrains.com) as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
- Thanks to [Travis CI](https://travis-ci.com/) for being the most awesome, easiest continous integration tool out there!
- Thanks to [StyleCI](https://styleci.io/) for the simple but powerfull code style check.
- Thanks to [PHPStan](https://github.com/phpstan/phpstan) && [Psalm](https://github.com/vimeo/psalm) for relly great Static analysis tools and for discover bugs in the code!