projek-xyz/slim-flysystem

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Access your Slim 3 application file system using FlySystem.

dev-master / 0.1.x-dev 2020-06-11 04:25 UTC

This package is auto-updated.

Last update: 2021-10-07 11:21:12 UTC


README

LICENSE VERSION Build Status Coveralls Code Climate Code Climate SensioLabs Insight

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.