https://github.com/codrasil/mediabox
Mediabox is a PHP implementation of a web-based file management system.
https://github.com/codrasil/mediabox
fileexplorer filemanager laravel mediamanager
Last synced: 3 months ago
JSON representation
Mediabox is a PHP implementation of a web-based file management system.
- Host: GitHub
- URL: https://github.com/codrasil/mediabox
- Owner: codrasil
- License: mit
- Created: 2020-05-19T07:49:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-29T13:57:11.000Z (over 4 years ago)
- Last Synced: 2025-05-29T02:42:52.730Z (10 months ago)
- Topics: fileexplorer, filemanager, laravel, mediamanager
- Language: PHP
- Homepage: https://packagist.org/packages/codrasil/mediabox
- Size: 609 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## About Mediabox
Mediabox is a PHP implementation of a __web-based file management system__. The library makes it easy to interact with the local disk storage's files and folders.
Features include:
* Adding of files and folders
* Copying
* Deleting files from disk
* Displaying and downloading files from browser
* Renaming and Moving files and folders.
* Toggling of hidden files
* Easy syntax to retrieve file meta info like size, permission, last modified date, owner, etc.
Mediabox is also a [Laravel](https://github.com/laravel/laravel) package out-of-the-box with minimal setup.
### Demonstration
Clone or download this repository then run the `demo:plain` composer script:
```bash
git clone https://github.com/codrasil/mediabox
cd mediabox/ && composer install
composer demo:plain
```
The above command will run a built-in PHP server at localhost:8080.
You may also run `composer demo:prep` to generate dummy files and folders for the demo.
---
### Requirements
* `PHP 7+`
* `php-imagick` (optional; for generating thumbnails)
* `illuminate/cache`: `^7.15`
* `illuminate/filesystem`: `^7.11`
* `symfony/http-foundation`: `^5.0`
### Installation
The library can be installed via composer:
```bash
composer require codrasil/mediabox
```
##### Publishing Configuration
If used in a Laravel project, the configuration file can be published via `artisan` command:
```bash
php artisan vendor:publish --tag mediabox
```
See [docs/Laravel](./docs/Laravel/00.%20Getting%20Started.md) for instructions on how to setup in a Laravel project.
### Usage
##### Plain PHP
```php
use Codrasil\Mediabox\Mediabox;
...
$rootStoragePath = '/path/to/a/storage/folder';
$baseStoragePath = $_GET['p'] ?: $rootStoragePath;
$mediabox = new Mediabox($baseStoragePath, $rootStoragePath);
$mediabox->showHiddenFiles($yes = true);
foreach ($mediabox->all() as $file) {
if ($file->isDir()) {
echo $file->name().'/'.PHP_EOL;
} else {
echo $file->name().PHP_EOL;
}
}
```
##### Laravel
If using within a Laravel project, just inject the `Codrasil\Mediabox\Mediabox` class to a controller or another class.
```php
// routes/web.php
use Codrasil\Mediabox\Mediabox;
use Illuminate\Http\Request;
Route::get('media', function (Request $request, Mediabox $mediabox) {
return view('path.to.a.view')->withMediabox($mediabox);
});
```
```blade
{{-- resources/views/path/to/a/view.blade.php --}}
@foreach ($mediabox->all() as $file)
@if ($file->isDir())
{{ $file->name() }}/
@else
{{ $file->name() }}
@endif
@endforeach
```
Note by default, the library will list the files and folders listed in `storage/app/public/media`.
To change the path, update the `root_path` value in `config/mediabox.php` file.
All the necessary setup is taken cared of by the `Codrasil\Mediabox\MediaboxServiceProvider` class.
See `config/mediabox.php` to view all available customization options.
See also [docs/Laravel](./docs/Laravel/00.%20Getting%20Started.md) for more information on how to use the library on a Laravel project.
#### Adding
```php
$mediabox->addFolder('Reminders');
$mediabox->addFile('Reminders/groceries.todo', 'Milk');
```
Adding folders is recursive by default.
#### Copying
The `copy` method accepts the relative path of the file to be copied as first argument.
The second argument is the new file name.
```php
$mediabox->copy('Reminders/groceries.todo', 'Copy of groceries.todo');
$mediabox->copy('Reminders', 'Copy of Reminders');
// or
$mediabox->copyDirectory('Reminders', 'Copy of Reminders');
```
#### Moving or renaming
The `rename` and `move` methods accept a `$path` and `$target` destination.
```php
$mediabox->rename('Reminders/groceries.todo', 'Reminders/My Grocery List.todo');
// or
$mediabox->move('Reminders/groceries.todo', 'Reminders/My Grocery List.todo');
```
#### Deleting
The `delete` method can accept a path or array of paths.
```php
$mediabox->delete('Copy of Reminders');
$mediabox->delete('Copy of groceries.todo');
// or
$mediabox->delete(['Copy of Reminders', 'Copy of groceries.todo']);
```
#### Displaying & Downloading
To display a file on a browser, use the `stream` or `fetch` method.
```php
$mediabox->stream('/path/to/a/file.txt');
// or
$mediabox->fetch('/path/to/a/file.txt');
```
To force browser to download the file, use the `download` method.
```php
$mediabox->download('/path/to/a/file.txt');
```
Both methods will return an instance of `Symfony\Component\HttpFoundation\BinaryFileResponse`.
### Documentation & Examples
To learn more about the API, see the [docs](./docs) folder.
For more example implementation, checkout [docs/examples](./docs/examples) folder.
For instructions on how to use in a Laravel project, see [docs/Laravel](./docs/Laravel/00.%20Getting%20Started.md).
For instructions on how to use in a Laravel + VueJS project, see [docs/VueJS](./docs/VueJS/00.%20Getting%20Started.md).
### License
The library is open-source software licensed under the [MIT license](./LICENSE).