PHPackages                             wyrihaximus/fly-pie - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. wyrihaximus/fly-pie

ActiveCakephp-plugin[File & Storage](/categories/file-storage)

wyrihaximus/fly-pie
===================

Flysystem integration plugin for CakePHP 5

4.0.1(1y ago)38297.8k—2.7%10[4 issues](https://github.com/WyriHaximus/FlyPie/issues)[15 PRs](https://github.com/WyriHaximus/FlyPie/pulls)MITPHPPHP ^8.1CI failing

Since Jan 18Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/WyriHaximus/FlyPie)[ Packagist](https://packagist.org/packages/wyrihaximus/fly-pie)[ GitHub Sponsors](https://github.com/WyriHaximus)[ RSS](/packages/wyrihaximus-fly-pie/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (11)Versions (35)Used By (0)

FlyPie
======

[](#flypie)

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

See below for CakePHP V4 core version compatibility matrix.

Installation
------------

[](#installation)

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

```
composer require wyrihaximus/fly-pie
```

Bootstrap
---------

[](#bootstrap)

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

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

Configuration
-------------

[](#configuration)

Example configuration (for in `config/app_local.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:

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

### Configuration keys

[](#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
-----

[](#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:

```
$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
------------------

[](#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:

Example Data Source Names
-------------------------

[](#example-data-source-names)

AdapterData Source NameAsyncAwsS3Adapter`s3://key:secret@bucket/path?region={{region}}`CakePHP version compatibility matrix
------------------------------------

[](#cakephp-version-compatibility-matrix)

FlyPieCakePHP corePHP minFlysystem1.x3.xPHP 5.41.x2.x4.xPHP 7.22.x3.x4.xPHP 8.0.23.x4.x5.xPHP 8.13.xLicense
-------

[](#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.

###  Health Score

59

—

FairBetter than 99% of packages

Maintenance68

Regular maintenance activity

Popularity47

Moderate usage in the ecosystem

Community19

Small or concentrated contributor base

Maturity83

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 58.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~286 days

Recently: every ~390 days

Total

14

Last Release

411d ago

Major Versions

1.1.1 → 2.0.0-beta12020-03-03

2.0.1 → 3.0.02022-08-03

3.0.1 → 4.0.02023-12-16

PHP version history (6 changes)1.0.0-beta1PHP >=5.4.19

2.0.0-beta1PHP >=7.2

2.0.0-beta2PHP ^7.2.5

2.0.1PHP >=7.2.5

3.0.0PHP ^8.0.2

4.0.0PHP ^8.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/147145?v=4)[Cees-Jan Kiewiet](/maintainers/WyriHaximus)[@WyriHaximus](https://github.com/WyriHaximus)

---

Top Contributors

[![WyriHaximus](https://avatars.githubusercontent.com/u/147145?v=4)](https://github.com/WyriHaximus "WyriHaximus (150 commits)")[![swiffer](https://avatars.githubusercontent.com/u/2990373?v=4)](https://github.com/swiffer "swiffer (94 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (4 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![ceeram](https://avatars.githubusercontent.com/u/111448?v=4)](https://github.com/ceeram "ceeram (1 commits)")[![Spriz](https://avatars.githubusercontent.com/u/3512268?v=4)](https://github.com/Spriz "Spriz (1 commits)")[![madbbb](https://avatars.githubusercontent.com/u/4654464?v=4)](https://github.com/madbbb "madbbb (1 commits)")[![curtisgibby](https://avatars.githubusercontent.com/u/1086964?v=4)](https://github.com/curtisgibby "curtisgibby (1 commits)")[![EOM](https://avatars.githubusercontent.com/u/1219132?v=4)](https://github.com/EOM "EOM (1 commits)")[![komarserjio](https://avatars.githubusercontent.com/u/297514?v=4)](https://github.com/komarserjio "komarserjio (1 commits)")

---

Tags

cakephpcakephp-pluginflysystemhacktoberfestphpFlysystemcakephp

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/wyrihaximus-fly-pie/health.svg)

```
[![Health](https://phpackages.com/badges/wyrihaximus-fly-pie/health.svg)](https://phpackages.com/packages/wyrihaximus-fly-pie)
```

###  Alternatives

[league/flysystem-aws-s3-v3

AWS S3 filesystem adapter for Flysystem.

1.6k263.6M790](/packages/league-flysystem-aws-s3-v3)[league/flysystem-local

Local filesystem adapter for Flysystem.

225231.8M39](/packages/league-flysystem-local)[oneup/flysystem-bundle

Integrates Flysystem filesystem abstraction library to your Symfony project.

64422.9M66](/packages/oneup-flysystem-bundle)[league/flysystem-bundle

Symfony bundle integrating Flysystem into Symfony applications

40129.5M87](/packages/league-flysystem-bundle)[league/flysystem-sftp-v3

SFTP filesystem adapter for Flysystem.

6129.6M91](/packages/league-flysystem-sftp-v3)[spatie/flysystem-dropbox

Flysystem Adapter for the Dropbox v2 API

3644.6M68](/packages/spatie-flysystem-dropbox)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)