projek-xyz/slim-flysystem

Access your Slim 3 application file system using FlySystem.

dev-main / 0.1.x-dev 2024-10-22 20:26 UTC

Requires

• league/flysystem: ~1.0
• psr/container: ^1.0 || ^2.0
• slim/slim: ~3.5

Requires (Dev)

• kahlan/kahlan: ^5.1
• league/flysystem-ziparchive: ^1.0
• projek-xyz/container: ^0.7
• squizlabs/php_codesniffer: ^3.6

MIT

• Fery Wardiyanto

• framework
• microframework
• filesystem
• library
• slim
• Flysystem

README

FlySystem Integration for Slim micro framework 3

Access your Slim 3 application file system using FlySystem.

Install

Via Composer

$ composer require projek-xyz/slim-flysystem --prefer-dist

Requires Slim micro framework 3 and PHP 5.5.0 or newer.

Usage

// Create Slim app
$app = new \Slim\App();

// Fetch DI Container
$container = $app->getContainer();

// Register FlySystem helper:
// Option 1, using FlysystemProvider
$container->register(new \Projek\Slim\FlysystemProvider);

// Option 2, using Closure
$container['fs'] = function ($c) {
    $fs = new \Projek\Slim\Flysystem([
        'local' => [
            'path' => 'path/to/your/resources',
        ]
    ]);

    return $fs;
};

// Define named route
$app->get('/hello/{name}', function ($request, $response, $args) {
    // Read a file.
    $this->fs->read('path/to/file');

    return $response;
});

// Run app
$app->run();

NOTE: if you are using option 1 please make sure you already have $container['settings']['filesystem'] in your configuration file.

Custom functions

Description soon.

aFunction()

Description soon.

// ...

Contributing

Please see CONTRIBUTING and CONDUCT for details.

License

This library is open-sourced software licensed under MIT license.