{"id":15649678,"url":"https://github.com/wyrihaximus/flypie","last_synced_at":"2025-08-19T22:32:16.563Z","repository":{"id":21998301,"uuid":"25323376","full_name":"WyriHaximus/FlyPie","owner":"WyriHaximus","description":"Flysystem plugin for CakePHP","archived":false,"fork":false,"pushed_at":"2023-12-16T12:38:29.000Z","size":408,"stargazers_count":38,"open_issues_count":3,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-09T18:13:07.946Z","etag":null,"topics":["cakephp","cakephp-plugin","flysystem","hacktoberfest","php"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WyriHaximus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"WyriHaximus"}},"created_at":"2014-10-16T21:47:36.000Z","updated_at":"2024-03-17T20:56:35.000Z","dependencies_parsed_at":"2024-06-18T21:27:08.146Z","dependency_job_id":"b6ccf7da-15c1-4497-8cf4-eca9933390ae","html_url":"https://github.com/WyriHaximus/FlyPie","commit_stats":{"total_commits":214,"total_committers":10,"mean_commits":21.4,"dds":"0.44859813084112155","last_synced_commit":"979aa1f76dc09b6989a6034c2304acc3f301900f"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WyriHaximus%2FFlyPie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WyriHaximus%2FFlyPie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WyriHaximus%2FFlyPie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WyriHaximus%2FFlyPie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WyriHaximus","download_url":"https://codeload.github.com/WyriHaximus/FlyPie/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230374118,"owners_count":18216041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cakephp","cakephp-plugin","flysystem","hacktoberfest","php"],"created_at":"2024-10-03T12:30:51.701Z","updated_at":"2024-12-19T04:07:02.634Z","avatar_url":"https://github.com/WyriHaximus.png","language":"PHP","funding_links":["https://github.com/sponsors/WyriHaximus"],"categories":[],"sub_categories":[],"readme":"FlyPie\n======\n\nLightweight [Flysystem](https://flysystem.thephpleague.com/v2/docs/) wrapper/configuration plugin for CakePHP.\n\nSee below for CakePHP V4 core version compatibility matrix.\n\n## Installation ##\n\nTo install via [Composer](https://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.\n\n```bash\ncomposer require wyrihaximus/fly-pie \n```\n\n## Bootstrap ##\n\nAdd the following to your `config/bootstrap.php` to load the plugin.\n\n```php\nPlugin::load('WyriHaximus/FlyPie', ['bootstrap' =\u003e true]);\n```\n\n## Configuration ##\n\nExample configuration (for in `config/app_local.php`):\n\n```php\n/**\n * FlySystem filesystems\n */\n'WyriHaximus' =\u003e [\n    'FlyPie' =\u003e [\n        's3_thumbnails' =\u003e [\n            'adapter' =\u003e 'Local',\n            'vars' =\u003e [\n                __DIR__, // Path\n                'second option',\n                'third option',\n            ],\n        ],\n    ],\n],\n```\n\nAt 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-\u003efilesystem('s3_thumbnails');` on the trait. \n\nTo enable the filesystem panel in DebugKit add the configuration as shown below:\n\n```php\n'DebugKit' =\u003e [\n    'panels' =\u003e ['WyriHaximus/FlyPie.Filesystem'],\n],\n```\n\n### Configuration keys ###\n\n* `adapter` - adapter name or full qualified class name to use for this filesystem\n* `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.)\n* `client` - a prebuild client\n* `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\n* `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.\n\nCheck out [`config/config.sample.php`](config/config.sample.php) for more details.\n\n## Usage ##\n\nFlyPie 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.\n\nFor example this lists all files in a `S3` bucket with thumbnails:\n```php\n$this-\u003efilesystem('s3_thumbnails')-\u003elistContents();\n```\n\nFor more details on how to use [Flysystem, check out its Getting Started section](https://github.com/thephpleague/flysystem#getting-started).\n\n## Supported Adapters ##\n\nBy default only a few adapters are included. Extra adapters can be added on a \nper case basis as extra composer packages. For all supported adapters see: \n[https://github.com/thephpleague/flysystem#commonly-used-adapters](https://github.com/thephpleague/flysystem#commonly-used-adapters)\n\n## Example Data Source Names ##\n\n| Adapter           | Data Source Name                                |\n| ----------------- | ----------------------------------------------- |\n| AsyncAwsS3Adapter | `s3://key:secret@bucket/path?region={{region}}` |\n\n## CakePHP version compatibility matrix ##\n\n| FlyPie | CakePHP core | PHP min   | Flysystem |\n| ------ | ------------ | --------- | --------- |\n| 1.x    | 3.x          | PHP 5.4   | 1.x       |\n| 2.x    | 4.x          | PHP 7.2   | 2.x       |\n| 3.x    | 4.x          | PHP 8.0.2 | 3.x       |\n| 4.x    | 5.x          | PHP 8.1   | 3.x       |\n\n## License ##\n\nCopyright 2017 [Cees-Jan Kiewiet](https://www.wyrihaximus.net/)\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwyrihaximus%2Fflypie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwyrihaximus%2Fflypie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwyrihaximus%2Fflypie/lists"}