chialab/object-storage

A collection of adapters for various object storage services.

v0.1.2 2024-07-19 07:35 UTC

Requires

• php: ~8.1
• aws/aws-sdk-php: ^3.222
• guzzlehttp/promises: ^1.5
• guzzlehttp/psr7: ^2.2
• psr/http-message: ^1.0
• webmozart/assert: ^1.10

Requires (Dev)

• cakephp/cakephp-codesniffer: ^5.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.11
• phpstan/phpstan-phpunit: ^1.4
• phpstan/phpstan-webmozart-assert: ^1.2
• phpunit/phpunit: ^11.2

MIT

• Chialab srl

README

This library provides a PHP implementation for using various object storage backends.

Installation

You can install this library using composer:

composer install chialab/object-storage

To use AWS S3 as a backend storage, the SDK is also needed:

composer install aws/aws-sdk-php

Adapters

The plugin currently provides the following adapters.

You can create other adapters by implementing MultipartUploadInterface.

FilesystemAdapter

This adapter uses the filesystem to store objects.

Takes an ordered array of arguments:

1. path to the root files folder
2. path to the temporary folder where multipart uploads are stored until finalization
3. base for object URLs from which the webserver serves the files
4. an optional umask for created files (defaults to octal 0077)

S3Adapter

This adapter uses an AWS S3 bucket to store objects.

Takes an ordered array of arguments:

1. an Aws\S3\S3Client instance
2. the name of the bucket
3. an optional key prefix to use for all files (defaults to empty)
4. an optional custom base for object URLs (defaults to empty)

InMemoryAdapter

This adapter uses volatile memory to store objects.

Takes only one argument:

1. base for object URLs