PHPackages                             simplon/gstorage - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. simplon/gstorage

ActiveLibrary[File & Storage](/categories/file-storage)

simplon/gstorage
================

Google Cloud Storage API (service account client)

0.0.9(9y ago)0142MITPHPPHP >=7.1

Since Apr 12Pushed 9y agoCompare

[ Source](https://github.com/fightbulc/simplon_gstorage)[ Packagist](https://packagist.org/packages/simplon/gstorage)[ Docs](https://github.com/fightbulc/simplon_gstorage)[ RSS](/packages/simplon-gstorage/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (1)Versions (10)Used By (0)

```
     _                 _                         _
 ___(_)_ __ ___  _ __ | | ___  _ __     __ _ ___| |_ ___  _ __ __ _  __ _  ___
/ __| | '_ ` _ \| '_ \| |/ _ \| '_ \   / _` / __| __/ _ \| '__/ _` |/ _` |/ _ \
\__ \ | | | | | | |_) | | (_) | | | | | (_| \__ \ || (_) | | | (_| | (_| |  __/
|___/_|_| |_| |_| .__/|_|\___/|_| |_|  \__, |___/\__\___/|_|  \__,_|\__, |\___|
                |_|                    |___/                        |___/
```

Requirements
============

[](#requirements)

You need `Server account credentials` as `JSON` which you can generate within your `Google Console`. You will receive a file which looks like the following example:

```
{
  "type": "service_account",
  "project_id": "foo.bar:api-project-XXXXXXXXXXXXXX",
  "private_key_id": "XXXXXXXXXXXXXX",
  "private_key": "-----BEGIN PRIVATE KEY-----\nXXXXXXXXXXXXXX\n-----END PRIVATE KEY-----\n",
  "client_email": "cloud-storage-web-server@api-project-XXXXXXXXXXXXXX.foo.bar.iam.gserviceaccount.com",
  "client_id": "XXXXXXXXXXXXXX",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/cloud-storage-web-server%40api-project-XXXXXXXXXXXXXX.foo.bar.iam.gserviceaccount.com"
}
```

Setup credentials
=================

[](#setup-credentials)

Gstorage needs your credentials in order to be constructed. For this we need to use the `ServerAccountCredentials` which offers two methods to load our credentials.

Load from params
----------------

[](#load-from-params)

Use `client_email` and `private_key` from your JSON file above for this method.

```
$credentials = (new ServerAccountCredentials())->loadFromParams(
    "cloud-storage-web-server@api-project-XXXXXXXXXXXXXX.foo.bar.iam.gserviceaccount.com",
    "-----BEGIN PRIVATE KEY-----\nXXXXXXXXXXXXXX\n-----END PRIVATE KEY-----\n"
);
```

Load from JSON file
-------------------

[](#load-from-json-file)

Specify the file path for your JSON file. Lets assume we saved our file within the same folder and named it `credentials.json`.

```
$credentials = (new ServerAccountCredentials())->loadFromJsonFile('credentials.json');
```

Instantiate Gstorage class
==========================

[](#instantiate-gstorage-class)

Now all what needs to be done is to use `$credentials`:

```
$gstorage = new Gstorage($credentials);
```

Upload a file
=============

[](#upload-a-file)

Lets upload a file. We will construct an upload object and receive a simple object back.

```
// upload object
$data = new UploadData('YOUR-BUCKET-NAME');

// load file via URL
$data->loadWithFile('https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png');

// upload file
$objectData = $gstorage->upload($data); // ObjectData|null

if ($objectData)
{
    var_dump([
        'bucket'     => $objectData->getBucket(),
        'id'         => $objectData->getFileName(),
        'url_public' => $objectData->getUrlPublic(),
    ]);
}
```

Upload via BLOB
---------------

[](#upload-via-blob)

In case you have the file data already you can upload your data as following:

```
// our blob
$blob = file_get_contents('https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png');

// upload object
$data = new UploadData('YOUR-BUCKET-NAME');

// load file via BLOB
$data->loadWithBlob('google-logo.png', $blob);

// upload file
$objectData = $gstorage->upload($data); // ObjectData|null

if ($objectData)
{
    var_dump([
        'bucket'     => $objectData->getBucket(),
        'id'         => $objectData->getFileName(),
        'url_public' => $objectData->getUrlPublic(),
    ]);
}
```

Delete file
===========

[](#delete-file)

Lets delete the upload from our `Google Logo Blob`:

```
$response = $gstorage->delete(
    new ObjectData('YOUR-BUCKET-NAME', 'google-logo.png')
);

var_dump($response); // true|false
```

Complete example
================

[](#complete-example)

```
$gstorage = new Gstorage(
    (new ServerAccountCredentials())->loadFromJsonFile('credentials.json')
);

// upload object
$data = new UploadData('YOUR-BUCKET-NAME');

// load file via URL
$data->loadWithFile('https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png');

// upload file
$objectData = $gstorage->upload($data); // ObjectData|null

if ($objectData)
{
    var_dump([
        'bucket'     => $objectData->getBucket(),
        'id'         => $objectData->getFileName(),
        'url_public' => $objectData->getUrlPublic(),
    ]);
}
```

License
=======

[](#license)

Cirrus is freely distributable under the terms of the MIT license.

Copyright (c) 2016 Tino Ehrich ()

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

25

—

LowBetter than 35% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~42 days

Recently: every ~85 days

Total

9

Last Release

3392d ago

PHP version history (2 changes)0.0.1PHP >=5.4

0.0.9PHP >=7.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/451061?v=4)[Tino Ehrich](/maintainers/fightbulc)[@fightbulc](https://github.com/fightbulc)

---

Tags

apicdncloudgooglestorageapiclientfilesgoogle cloud storageuploadservice account

### Embed Badge

![Health badge](/badges/simplon-gstorage/health.svg)

```
[![Health](https://phpackages.com/badges/simplon-gstorage/health.svg)](https://phpackages.com/packages/simplon-gstorage)
```

###  Alternatives

[uploadcare/uploadcare-php

Uploadcare PHP integration handles uploads and further operations with files by wrapping Upload and REST APIs.

1052.7M7](/packages/uploadcare-uploadcare-php)[vova07/yii2-fileapi-widget

The FileAPI widget for Yii2 framework.

4966.3k9](/packages/vova07-yii2-fileapi-widget)[jacekbarecki/flysystem-onedrive

OneDrive adapter for the flysystem filesystem abstraction library

2431.0k](/packages/jacekbarecki-flysystem-onedrive)[unclecheese/kickassets

Provides an alternative file management interface for SilverStripe CMS with drag-and-drop, multi-selection, and several other desktop-like UI conventions.

464.0k](/packages/unclecheese-kickassets)[teepluss/cloudinary

Cloudinary API wrapper for Laravel 4

1910.5k](/packages/teepluss-cloudinary)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)