Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Superbalist/laravel-google-cloud-storage

A Google Cloud Storage filesystem for Laravel
https://github.com/Superbalist/laravel-google-cloud-storage

flysystem flysystem-adapter flysystem-google-cloud-storage google-cloud google-cloud-platform google-cloud-storage google-storage laravel laravel-google-cloud-storage laravel5 laravel5-package php superbalist

Last synced: 3 months ago
JSON representation

A Google Cloud Storage filesystem for Laravel

Lists

README 

        
# laravel-google-cloud-storage



A Google Cloud Storage filesystem for Laravel.



[![Author](http://img.shields.io/badge/[email protected]?style=flat-square)](https://twitter.com/superbalist)

[![Build Status](https://img.shields.io/travis/Superbalist/laravel-google-cloud-storage/master.svg?style=flat-square)](https://travis-ci.org/Superbalist/laravel-google-cloud-storage)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

[![Packagist Version](https://img.shields.io/packagist/v/superbalist/laravel-google-cloud-storage.svg?style=flat-square)](https://packagist.org/packages/superbalist/laravel-google-cloud-storage)

[![Total Downloads](https://img.shields.io/packagist/dt/superbalist/laravel-google-cloud-storage.svg?style=flat-square)](https://packagist.org/packages/superbalist/laravel-google-cloud-storage)



This package is a wrapper bridging [flysystem-google-storage](https://github.com/Superbalist/flysystem-google-storage) into Laravel as an available storage disk.



## Installation



```bash

composer require superbalist/laravel-google-cloud-storage

```



If you are on Laravel 5.4 or earlier, then register the service provider in app.php

```php

'providers' => [

    // ...

    Superbalist\LaravelGoogleCloudStorage\GoogleCloudStorageServiceProvider::class,

]

```



If you are on Laravel 5.5 or higher, composer will have registered the provider automatically for you.



Add a new disk to your `filesystems.php` config



```php

'gcs' => [

    'driver' => 'gcs',

    'project_id' => env('GOOGLE_CLOUD_PROJECT_ID', 'your-project-id'),

    'key_file' => env('GOOGLE_CLOUD_KEY_FILE', null), // optional: /path/to/service-account.json

    'bucket' => env('GOOGLE_CLOUD_STORAGE_BUCKET', 'your-bucket'),

    'path_prefix' => env('GOOGLE_CLOUD_STORAGE_PATH_PREFIX', null), // optional: /default/path/to/apply/in/bucket

    'storage_api_uri' => env('GOOGLE_CLOUD_STORAGE_API_URI', null), // see: Public URLs below

    'visibility' => 'public', // optional: public|private

],

```



### Authentication



The Google Client uses a few methods to determine how it should authenticate with the Google API.



1. If you specify a path in the key `key_file` in  disk config, that json credentials file will be used.

2. If the `GOOGLE_APPLICATION_CREDENTIALS` env var is set, it will use that.

   ```php

   putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');

   ```

3. It will then try load the key file from a 'well known path':

   * windows: %APPDATA%/gcloud/application_default_credentials.json

   * others: $HOME/.config/gcloud/application_default_credentials.json



4. If running in **Google App Engine**, the built-in service account associated with the application will be used.

5. If running in **Google Compute Engine**, the built-in service account associated with the virtual machine instance will be used.

6. If you want to authenticate directly without using a json file, you can specify an array for `key_file` in disk config with this data:

    ```php

    'key_file' => [

        'type' => env('GOOGLE_CLOUD_ACCOUNT_TYPE'),

        'private_key_id' => env('GOOGLE_CLOUD_PRIVATE_KEY_ID'),

        'private_key' => env('GOOGLE_CLOUD_PRIVATE_KEY'),

        'client_email' => env('GOOGLE_CLOUD_CLIENT_EMAIL'),

        'client_id' => env('GOOGLE_CLOUD_CLIENT_ID'),

        'auth_uri' => env('GOOGLE_CLOUD_AUTH_URI'),

        'token_uri' => env('GOOGLE_CLOUD_TOKEN_URI'),

        'auth_provider_x509_cert_url' => env('GOOGLE_CLOUD_AUTH_PROVIDER_CERT_URL'),

        'client_x509_cert_url' => env('GOOGLE_CLOUD_CLIENT_CERT_URL'),

    ],

    ```



### Public URLs



The adapter implements a `getUrl($path)` method which returns a public url to a file.

>**Note:** Method available for Laravel 5.2 and higher. If used on 5.1, it will throw an exception.



```php

$disk = Storage::disk('gcs');

$url = $disk->url('folder/my_file.txt');

>>> http://storage.googleapis.com/bucket-name/folder/my_file.txt

```



If you configure a `path_prefix` in your config:

```php

$disk = Storage::disk('gcs');

$url = $disk->url('folder/my_file.txt');

>>> http://storage.googleapis.com/bucket-name/path-prefix/folder/my_file.txt

```



If you configure a custom `storage_api_uri` in your config:

```php

$disk = Storage::disk('gcs');

$url = $disk->url('folder/my_file.txt');

>>> http://your-custom-domain.com/bucket-name/path-prefix/folder/my_file.txt

```



For a custom domain (storage api uri), you will need to configure a CNAME DNS entry pointing to `storage.googleapis.com`.



Please see https://cloud.google.com/storage/docs/xml-api/reference-uris#cname for further instructions.



## Usage



```php

$disk = Storage::disk('gcs');



// create a file

$disk->put('avatars/1', $fileContents);



// check if a file exists

$exists = $disk->exists('file.jpg');



// get file modification date

$time = $disk->lastModified('file1.jpg');



// copy a file

$disk->copy('old/file1.jpg', 'new/file1.jpg');



// move a file

$disk->move('old/file1.jpg', 'new/file1.jpg');



// get url to file

$url = $disk->url('folder/my_file.txt');



// Set the visibility of file to public

$disk->setVisibility('folder/my_file.txt', 'public');



// See https://laravel.com/docs/5.3/filesystem for full list of available functionality

```