Flysystem adapter for Google Cloud Storage
This package contains a Google Cloud Storage driver for Flysystem.
Notice
This package is a fork from superbalist/flysystem-google-cloud-storage. Changes include:
- PHP 8 only
- merged random open PRs from Superbalist's package
Support us
We invest a lot of resources into creating best in class open source packages . You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/flysystem-google-cloud-storage
Authentication
Before you can use the package, you'll need to authenticate with Google. When possible, the credentials will be auto-loaded by the Google Cloud Client.
- The client will first look at the GOOGLE_APPLICATION_CREDENTIALS env var. You can use
putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');to set the location of your credentials file. - The client will look for the credentials file at the following paths:
- Windows:
%APPDATA%/gcloud/application_default_credentials.json - MacOS/Unix:
$HOME/.config/gcloud/application_default_credentials.json
- Windows:
- If running in Google App Engine, Google Compute Engine or GKE, the built-in service account associated with the app, instance or cluster will be used.
Using this in a Kubernetes cluster? Take a look at Workload Identity.
Usage
Here's an example that shows you have you can call the various functions to manipulate files on Google Cloud.
use Google\Cloud\Storage\StorageClient;
use League\Flysystem\Filesystem;
use Spatie\GoogleCloudStorageAdapter\GoogleCloudStorageAdapter;
$storageClient = new StorageClient([
'projectId' => 'your-project-id',
// The credentials can manually be specified by passing in a keyFilePath.
// 'keyFilePath' => '/path/to/service-account.json',
]);
$bucket = $storageClient->bucket('your-bucket-name');
$adapter = new GoogleCloudStorageAdapter($storageClient, $bucket);
$filesystem = new Filesystem($adapter);
$filesystem->write('path/to/file.txt', 'contents');
$filesystem->update('path/to/file.txt', 'new contents');
$contents = $filesystem->read('path/to/file.txt');
$exists = $filesystem->has('path/to/file.txt');
$filesystem->delete('path/to/file.txt');
$filesystem->rename('filename.txt', 'newname.txt');
$filesystem->copy('filename.txt', 'duplicate.txt');
$filesystem->deleteDir('path/to/directory');
See https://flysystem.thephpleague.com/v1/docs/usage/filesystem-api/ for full list of available functionality
Using a custom storage URI
You can configure this adapter to use a custom storage URI. Read more about configuring a custom domain for Google Cloud Storage here.
When using a custom storage URI, the bucket name will not prepended to the file path:
use Google\Cloud\Storage\StorageClient;
use League\Flysystem\Filesystem;
use Spatie\GoogleCloudStorageAdapter\GoogleCloudStorageAdapter;
$storageClient = new StorageClient([
'projectId' => 'your-project-id',
]);
$bucket = $storageClient->bucket('your-bucket-name');
$adapter = new GoogleCloudStorageAdapter($storageClient, $bucket);
// URI defaults to "https://storage.googleapis.com":
$filesystem = new Filesystem($adapter);
$filesystem->getUrl('path/to/file.txt');
// "https://storage.googleapis.com/your-bucket-name/path/to/file.txt"
// Using custom storage uri:
$adapter->setStorageApiUri('http://example.com');
$filesystem = new Filesystem($adapter);
$filesystem->getUrl('path/to/file.txt');
// "http://example.com/path/to/file.txt"
// You can also prefix the file path if needed:
$adapter->setStorageApiUri('http://example.com');
$adapter->setPathPrefix('extra-folder/another-folder/');
$filesystem = new Filesystem($adapter);
$filesystem->getUrl('path/to/file.txt');
// "http://example.com/extra-folder/another-folder/path/to/file.txt"
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Alex Vanderbist
- All Contributors
- Superbalist for the initial package
License
The MIT License (MIT). Please see License File for more information.
1 May 8, 2022
31.1k Jan 8, 2023
2 Mar 18, 2022
16 May 23, 2022
517 Dec 29, 2022
489 Dec 22, 2022
0 Nov 3, 2021
3 Nov 19, 2021
27 Jun 4, 2022
88 Dec 16, 2022
281 Nov 10, 2022
907 Jan 8, 2023
2 Nov 3, 2021
12 Dec 11, 2022
3 Aug 20, 2022
804 Dec 19, 2022
3 Jun 17, 2022
70 Dec 22, 2022
492 Feb 4, 2022
0 Nov 3, 2021
3 Nov 19, 2021
27 Jun 4, 2022
2 Nov 3, 2021
70 Dec 22, 2022
12 Dec 14, 2022
9 Oct 21, 2022
1 Feb 3, 2022
17k Jan 7, 2023