README

The Providers class offers a seamless integration experience with a range of popular object storage providers. Designed to work hand-in-hand with the s3-signing library, this class provides an effortless mechanism to fetch correct endpoints based on the provider and region, enhancing the power and flexibility of your applications.

Key Features:

Extensive Provider Support: This library encompasses a broad array of object storage providers, including AWS, Linode, CloudFlare R2, Wasabi, Backblaze, and DigitalOcean.
Dynamic Endpoint Fetching: Automatically retrieve the appropriate endpoints for a chosen provider and region, eliminating manual lookup.
Endpoint Verification: Ensure that your endpoints are accurate and up-to-date with the built-in verification system.
Flexible Configuration Options: Beyond just regions, the class supports inputs like account IDs, making it adaptable to various use-cases.
Retrieve Providers & Regions: Conveniently obtain a list of supported providers and regions, making plugin updates or app extensions a breeze.
Region Existence Check: Validate if a specific region exists within a provider, preventing potential errors in applications.
Up-to-Date JSON Support: The library sources providers and regions from an up-to-date JSON file. However, for customized needs, users have the flexibility to pass in their own JSON file or a structured PHP array to override default details.

Supported Providers

Amazon S3 (AWS)
CloudFlare R2
DigitalOcean Spaces
Linode Object Storage
Wasabi Cloud Storage
Backblaze B2 Cloud Storage

Minimum Requirements

PHP: 7.4 or later

Installation

To integrate the S3 Providers Library into your project, use Composer:

composer require arraypress/s3-providers

Including the Vendor Library

Include the Composer autoloader in your project to access the library:

require_once __DIR__ . '/vendor/autoload.php';

Initialization

Loading providers from a default JSON file:

$registry = new ArrayPress\S3\Registry();

Loading providers from a specific JSON file:

$registry = new ArrayPress\S3\Registry( '/path/to/providers.json' );

Initializing with a predefined array of provider data:

$provider_data = [
    "gcp" => [
        "label" => "Google Cloud Platform",
        //... other provider data, check providers.json for required format
    ]
];
$registry = new ArrayPress\S3\Providers( $provider_data );

Fetching All Providers

$all_providers = $registry->getProviders();

Fetching Provider Options

$all_providers = $registry->getProviderOptions();

Note: More examples will be added soon.

Contributions

Contributions to this library are highly appreciated. Raise issues on GitHub or submit pull requests for bug fixes or new features. Share feedback and suggestions for improvements.

License

This library is licensed under the GNU General Public License v2.0.

arraypress / s3-providers

Maintainers

Details