https://github.com/googleapis/google-cloud-php-storage

https://github.com/googleapis/google-cloud-php-storage

Last synced: about 8 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/googleapis/google-cloud-php-storage
• Owner: googleapis
• License: apache-2.0
• Created: 2017-02-28T00:52:32.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T23:17:35.000Z (21 days ago)
• Last Synced: 2024-12-24T14:40:34.858Z (9 days ago)
• Language: PHP
• Size: 1020 KB
• Stars: 326
• Watchers: 56
• Forks: 30
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Google Cloud Storage for PHP

> Idiomatic PHP client for [Cloud Storage](https://cloud.google.com/storage/).

[![Latest Stable Version](https://poser.pugx.org/google/cloud-storage/v/stable)](https://packagist.org/packages/google/cloud-storage) [![Packagist](https://img.shields.io/packagist/dm/google/cloud-storage.svg)](https://packagist.org/packages/google/cloud-storage)

* [API documentation](https://cloud.google.com/php/docs/reference/cloud-storage/latest)

**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googleapis/google-cloud-php). Any

support requests, bug reports, or development contributions should be directed to

that project.

Allows world-wide storage and retrieval of any amount of data at any time. You can use Cloud Storage for a range of

scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download.

### Installation

To begin, install the preferred dependency manager for PHP, [Composer](https://getcomposer.org/).

Now install this component:

```sh

$ composer require google/cloud-storage

```

### Authentication

Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information

on authenticating your client. Once authenticated, you'll be ready to start making requests.

### Sample

```php

require 'vendor/autoload.php';

use Google\Cloud\Storage\StorageClient;

$storage = new StorageClient();

$bucket = $storage->bucket('my_bucket');

// Upload a file to the bucket.

$bucket->upload(

    fopen('/data/file.txt', 'r')

);

// Using Predefined ACLs to manage object permissions, you may

// upload a file and give read access to anyone with the URL.

$bucket->upload(

    fopen('/data/file.txt', 'r'),

    [

        'predefinedAcl' => 'publicRead'

    ]

);

// Download and store an object from the bucket locally.

$object = $bucket->object('file_backup.txt');

$object->downloadToFile('/data/file_backup.txt');

```

### Stream Wrapper

```php

require 'vendor/autoload.php';

use Google\Cloud\Storage\StorageClient;

$storage = new StorageClient();

$storage->registerStreamWrapper();

$contents = file_get_contents('gs://my_bucket/file_backup.txt');

```

### Debugging

Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md)

for more information about the debugging tools.

### Version

This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in

any minor or patch releases. We will address issues and requests with the highest priority.

### Next Steps

1. Understand the [official documentation](https://cloud.google.com/storage/docs).

2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/).