Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wyrihaximus/flypie

Flysystem plugin for CakePHP
https://github.com/wyrihaximus/flypie

cakephp cakephp-plugin flysystem hacktoberfest php

Last synced: 3 days ago
JSON representation

Flysystem plugin for CakePHP

Awesome Lists containing this project

README 

        
FlyPie

======



Lightweight [Flysystem](https://flysystem.thephpleague.com/v2/docs/) wrapper/configuration plugin for CakePHP.



See below for CakePHP V4 core version compatibility matrix.



## Installation ##



To install via [Composer](https://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.



```bash

composer require wyrihaximus/fly-pie 

```



## Bootstrap ##



Add the following to your `config/bootstrap.php` to load the plugin.



```php

Plugin::load('WyriHaximus/FlyPie', ['bootstrap' => true]);

```



## Configuration ##



Example configuration (for in `config/app_local.php`):



```php

/**

 * FlySystem filesystems

 */

'WyriHaximus' => [

    'FlyPie' => [

        's3_thumbnails' => [

            'adapter' => 'Local',

            'vars' => [

                __DIR__, // Path

                'second option',

                'third option',

            ],

        ],

    ],

],

```



At first it's namespaced within `WyriHaximus.FlyPie` to make sure it doesn't interfere with any other plugins. Secondly it's an associative array where every key is the alias for a specific plugin configuration. That is `s3_thumbnails` in our example. So when you need that filesystem somewhere in your project you can call `$this->filesystem('s3_thumbnails');` on the trait. 



To enable the filesystem panel in DebugKit add the configuration as shown below:



```php

'DebugKit' => [

    'panels' => ['WyriHaximus/FlyPie.Filesystem'],

],

```



### Configuration keys ###



* `adapter` - adapter name or full qualified class name to use for this filesystem

* `vars` - array containing the required settings for FlyPie to build an adapter for you. That is passed directly into `newInstanceArgs` upon adapter creation. (This is required in case you don't use a factory or provide the client.)

* `client` - a prebuild client

* `factory` - a callback, array (class instance, methodname), string (static class method or function name or event name) that can be utilized as a factory to build the adapter

* `url` - [Data Source Name](https://book.cakephp.org/4/en/appendices/glossary.html#term-dsn). A connection string format that is formed like a URI. See below for examples.



Check out [`config/config.sample.php`](config/config.sample.php) for more details.



## Usage ##



FlyPie comes with the `FilesystemsTrait` trait that lets you easily access filesystems. The only method in the trait, `filesystem($alias)`, provides access to the adapters you've defined in your configuration.



For example this lists all files in a `S3` bucket with thumbnails:

```php

$this->filesystem('s3_thumbnails')->listContents();

```



For more details on how to use [Flysystem, check out its Getting Started section](https://github.com/thephpleague/flysystem#getting-started).



## Supported Adapters ##



By default only a few adapters are included. Extra adapters can be added on a 

per case basis as extra composer packages. For all supported adapters see: 

[https://github.com/thephpleague/flysystem#commonly-used-adapters](https://github.com/thephpleague/flysystem#commonly-used-adapters)



## Example Data Source Names ##



| Adapter           | Data Source Name                                |

| ----------------- | ----------------------------------------------- |

| AsyncAwsS3Adapter | `s3://key:secret@bucket/path?region={{region}}` |



## CakePHP version compatibility matrix ##



| FlyPie | CakePHP core | PHP min   | Flysystem |

| ------ | ------------ | --------- | --------- |

| 1.x    | 3.x          | PHP 5.4   | 1.x       |

| 2.x    | 4.x          | PHP 7.2   | 2.x       |

| 3.x    | 4.x          | PHP 8.0.2 | 3.x       |

| 4.x    | 5.x          | PHP 8.1   | 3.x       |



## License ##



Copyright 2017 [Cees-Jan Kiewiet](https://www.wyrihaximus.net/)



Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:



The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.