cakephp-file-storage

KO | EN

gitlite — search

#react #ai #typescript #golang #go #android #machine-learning #macos #java #kubernetes #awesome-list #security #ios #open-source

cakephp-file-storage

(★ 10)

Abstract file storage and upload plugin for CakePHP. Write to local disk, FTP, S3, Dropbox and more through a single interface. It's not just yet another uploader but a complete storage solution.

cakephp-file-storage Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FileStorage Plugin for CakePHP

[![CI](https://github.com/dereuromark/cakephp-file-storage/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/dereuromark/cakephp-file-storage/actions/workflows/ci.yml?query=branch%3Amaster)
[![codecov](https://codecov.io/gh/dereuromark/cakephp-file-storage/branch/master/graph/badge.svg)](https://app.codecov.io/gh/dereuromark/cakephp-file-storage/tree/master)
[![PHPStan](https://img.shields.io/badge/PHPStan-level%208-brightgreen.svg?style=flat)](https://phpstan.org/)
[![Latest Stable Version](https://poser.pugx.org/dereuromark/cakephp-file-storage/v/stable.svg)](https://packagist.org/packages/dereuromark/cakephp-file-storage)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.2-8892BF.svg)](https://php.net/)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/dereuromark/cakephp-file-storage/master/LICENSE)
[![Total Downloads](https://poser.pugx.org/dereuromark/cakephp-file-storage/d/total.svg)](https://packagist.org/packages/dereuromark/cakephp-file-storage)
[![Coding Standards](https://img.shields.io/badge/cs-PhpCollective-purple.svg?style=flat-square)](https://github.com/php-collective/code-sniffer)

The **FileStorage** plugin is giving you the possibility to upload and store files in virtually any kind of storage backend. The plugin features the [FlySystem](https://github.com/thephpleague/flysystem) library in a CakePHP fashion and provides a simple way to use the storage adapters.

Storage adapters are a unified interface that allow you to store file data to your local file system, in memory, in a database or into a zip file and remote systems. There is a database table keeping track of what you stored where. You can always write your own adapter or extend and overload existing ones.

This branch is for use with **CakePHP 5.3.4+**. See [version map](https://github.com/dereuromark/cakephp-file-storage/wiki#cakephp-version-map) for details.

## How it works

The whole plugin is build with clear [Separation of Concerns (SoC)](https://en.wikipedia.org/wiki/Separation_of_concerns) in mind: A file is *always* an entry in the `file_storage` table from the app perspective. The table is the *reference* to the real place of where the file is stored and keeps some meta information like mime type, filename, file hash (optional) and size as well. Storing the path to a file inside an arbitrary table along other data is considered as *bad practice* because it doesn't respect SoC from an architecture perspective but many people do it this way for some reason.

You associate the `file_storage` table with your model using the FileStorage model from the plugin via hasOne, hasMany or HABTM. When you upload a file you save it to the FileStorage model through the associations, `Documents.file` for example. The FileStorage model dispatches then file storage specific events, the listeners listening to these events process the file and put it in the configured storage backend using adapters for different backends and build the storage path using a path builder class.

## Admin backend

The plugin ships a self-contained admin backend at `/admin/file-storage`
(dashboard, file listing with bulk delete, storage cleanup UI). It is
**fail-closed by default** — set `FileStorage.adminAccess` (`true` or a
`Closure(\Cake\Http\ServerRequest): bool`) to opt in. The bundled
Bootstrap 5 layout can be replaced with your host app's layout via
`FileStorage.adminLayout`. See the [Admin Backend docs](https://dereuromark.github.io/cakephp-file-storage/admin/).

For background image-variant regeneration from the admin UI, install
[`dereuromark/cakephp-queue`](https://github.com/dereuromark/cakephp-queue);
without it the regenerate buttons render disabled.

> [!NOTE]
> Do not pre-fill the primary key on a FileStorage entity before saving.
> Path generation runs through the `php-collective/file-storage` UUID
> strategy; if a caller hands it a pre-set id, two concurrent saves with
> the same id would race on `fileStorage->store()`. Let the table assign
> the id.

## Documentation

Full documentation lives at **[dereuromark.github.io/cakephp-file-storage](https://dereuromark.github.io/cakephp-file-storage/)**.

A few good entry points:

* [Getting started](https://dereuromark.github.io/cakephp-file-storage/guide/)
* [Quick Start tutorial](https://dereuromark.github.io/cakephp-file-storage/guide/quick-start)
* [Serving files and authorization](https://dereuromark.github.io/cakephp-file-storage/serving/)
* [Configuration reference](https://dereuromark.github.io/cakephp-file-storage/reference/)

The Markdown sources live in the [docs](docs/) directory of this repository.

## Support

For bugs and feature requests, please use the [issues](https://github.com/dereuromark/cakephp-file-storage/issues) section of this repository.

## Contributing

To contribute to this plugin please follow a few basic rules.

* Pull requests must be sent to the branch that reflects the version you want to contribute to.
* [Unit tests](http://book.cakephp.org/5/en/development/testing.html) are required.

cakephp-file-storage

cakephp-file-storage Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

cakephp-file-storage

cakephp-file-storage Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README