arquivei/flysystem-php

Arquivei Flysystem Adapters.

5.0.1 2024-03-11 19:27 UTC

Requires

• php: ^8.0
• google/cloud-storage: ^1.10
• guzzlehttp/guzzle: ^7.0.1
• illuminate/filesystem: ^9.0
• illuminate/support: ^9.0
• league/flysystem: ^1.0
• league/flysystem-aws-s3-v3: ^1.0
• league/flysystem-cached-adapter: ^1.0

MIT

• Flysystem
• arquivei

README

Google Cloud Storage and Amazon S3 adapters for php.

This project is based-on League\Flysystem [http://flysystem.thephpleague.com/docs/].

Version Compatibility

Installation

composer require arquivei/flysystem-php:1.0.0

How to use

Using with Google Cloud Storage

require_once ('vendor/autoload.php');

$gcsStorage = new \Arquivei\Flysystems\ArquiveiStorage\Adapters\GoogleCloudStorage(
    new \Google\Cloud\Storage\StorageClient([
        'projectId' => 'my-project',
        'keyFilePath' => './auth.json'
    ])
);

$gcsStorage->setBucket('my-bucket');

$gcsStorage->putObject('data', '2019/key/');

Using with Amazon Aws S3

$awsStorage = new \Arquivei\Flysystems\ArquiveiStorage\Adapters\AmazonAwsStorage(
    new \Aws\S3\S3Client([
        'key' => 'my-key',
        'secret' => 'my-secret',
        'region' => 'my-region',
        'version' => 'my-version'
    ])
);

$awsStorage->setBucket('my-bucket');

$awsStorage->putObject('data', '2019/key/');

Using with Laravel

The first step you need to do is register the service provider in app.php

'providers' => [
    Arquivei\Flysystems\GoogleCloudStorage\GoogleCloudStorageProvider::class,
]

Then, create the config in filesystem.php

'gcs' => [
    'driver' => 'gcs',
    'project_id' => env('GOOGLE_CLOUD_PROJECT_ID', 'your-project-id'),
    'key_file' => env('GOOGLE_CLOUD_KEY_FILE', null),
    'bucket' => env('GOOGLE_CLOUD_STORAGE_BUCKET', 'your-bucket'),
    'path_prefix' => env('GOOGLE_CLOUD_STORAGE_PATH_PREFIX', null),
    'storage_api_uri' => env('GOOGLE_CtestingLOUD_STORAGE_API_URI', null), 
    'visibility' =>  env('GOOGLE_CLOUD_STORAGE_API_URI', 'private'), 
],

You must need an adapter like:

class IlluminateStorageAdapter
{

    private $storage;

    public function __construct()
    {
        $client = \Storage::cloud()
            ->getDriver()
            ->getAdapter()
            ->getClient();

        if ($client instanceof StorageClient) {
            $this->storage = new GoogleCloudStorage($client);
        }

        if ($client instanceof S3Client) {
            $this->storage = new AmazonAwsStorage($client);
        }

        if((!$client instanceof StorageClient) && (!$client instanceof S3Client)){
            throw new StorageNotFoundException();
        }
    }

    public function setBucket(String $bucket) : IlluminateStorageAdapter
    {
        $this->storage->setBucket($bucket);
        return $this;
    }

    public function setBasePath(String $basePath) : IlluminateStorageAdapter
    {
        $this->storage->setBasePath($basePath);
        return $this;
    }

    public function getObjectAsync(array $keys): array
    {
        return $this->storage->getObjectAsync($keys);
    }

    public function putObject(String $data, String $key, String $acl = "private") : String
    {
        return $this->storage->putObject($data, $key, $acl);
    }
}

Maintainers

André Lázari [e-mail]

Thales Castro [e-mail]