hkvstore/richfilemanager-php

PHP connector for RichFilemanager

v2.2.0 2024-09-20 03:01 UTC

Requires

• php: >= 8.1.0
• illuminate/config: 5.4.*|5.5.*|5.6.*|5.7.*|5.8.*|8.*|9.*|10.*|11.*
• illuminate/container: 5.4.*|5.5.*|5.6.*|5.7.*|5.8.*|8.*|9.*|10.*|11.*
• laravel/helpers: ^1.5.0
• symfony/event-dispatcher: ^5.0|^6.0|^7.0
• symfony/http-foundation: ^4.4|^5.0|^6.0|^7.0

MIT

• Pavel Solomienko

• php
• plugin
• filemanager
• connector
• richfilemanager

README

This package is the part of RichFilemanager project.

Requires PHP >= 5.6.4

Introduction

PHP connector provides a flexible way to manage you files at different king of storages. There are 2 storages supported out of the box:

• Local filesystem storage
• AWS S3 storage

Configuration details for each are described below. You create implementation for any other storage that you wish by implementing Api and Storage classes.

Installation

composer require servocoder/richfilemanager-php

NOTE: Most likely you won't have to install PHP connector separately. It's sufficient to run composer of the main package. Check out the installation guide of RichFilemanager main package for PHP connector.

AWS PHP SDK

If you are going to use AWS S3 storage make sure that AWS PHP SDK package version >= 3.18.0 is added to the "require" section of RichFilemanager composer.json file:

{
  "require": {
    "servocoder/richfilemanager-php": "*",
    "aws/aws-sdk-php": "^3.18.0"
  }
}

FYI - Amazon PHP SDK installation guide: https://docs.aws.amazon.com/aws-sdk-php/v3/guide/getting-started/installation.html

Entry point setup

RichFilemanager provides entry point script out of the box, so you don't have to create it from scratch. In this section you can find explanations and examples to setup the entry script.

1. Initiate application.

$app = new \RFM\Application();

1. Create and set storage class instance. Usually you will use a single storage, but it's possible initiate instances for various storages to use both in API. For example, AWS S3 API can use S3 storage instance to manage original files and Local storage to manage image thumbnails. More details in the Configuration section.

// local filesystem storage
$local = new \RFM\Repository\Local\Storage();
$app->setStorage($local);

// AWS S3 storage instance
$s3 = new \RFM\Repository\S3\Storage();
$app->setStorage($s3);

1. Create and set API class instance. You can set only one API instance unlike storage instances.

// local filesystem API
$app->api = new RFM\Api\LocalApi();

OR

// AWS S3 API
$app->api = new RFM\Api\AwsS3Api();

1. Run application.

$app->run();

Documentation

The Wiki pages provide articles that details the following subjects:

• Configuration
• Security concerns
• User storage folder setup
• Debug and Logging
• Integrations
• etc.

MIT LICENSE

Released under the MIT license.