library backblaze-b2

gliterd/backblaze-b2

PHP SDK for working with backblaze B2 cloud storage.

Backblaze B2 for PHP

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] , _(*1)

backblaze-b2 is the SDK for working with Backblaze's B2 storage service., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require gliterd/backblaze-b2, <sub>(*4)</sub>

## Usage

``` php
use BackblazeB2\Client;
use BackblazeB2\Bucket;

$options = ['auth_timeout_seconds' => seconds];

$client = new Client('accountId', 'applicationKey', $options);

$options is optional. If omitted, the default timeout is 12 hours. The timeout allows for a long lived Client object so that the authorization token does not expire., <sub>(*5)</sub>

ApplicationKey is not supported yet, please use MasterKey only

Returns a bucket details

``` php $bucket = $client->createBucket([ 'BucketName' => 'my-special-bucket', 'BucketType' => Bucket::TYPE_PRIVATE // or TYPE_PUBLIC ]);, <sub>(*6)</sub>

#### Change the bucket Type
``` php
$updatedBucket = $client->updateBucket([
    'BucketId' => $bucket->getId(),
    'BucketType' => Bucket::TYPE_PUBLIC
]);

List all buckets

``` php $buckets = $client->listBuckets();, <sub>(*7)</sub>

#### Delete a bucket
``` php
$client->deleteBucket([
    'BucketId' => 'YOUR_BUCKET_ID'
]);

File Upload

``` php $file = $client->upload([ 'BucketName' => 'my-special-bucket', 'FileName' => 'path/to/upload/to', 'Body' => 'I am the file content', <sub>(*8)</sub>

// The file content can also be provided via a resource.
// 'Body' => fopen('/path/to/input', 'r')

]);, <sub>(*9)</sub>

#### File Download
``` php
$fileContent = $client->download([
    'FileId' => $file->getId()

    // Can also identify the file via bucket and path:
    // 'BucketName' => 'my-special-bucket',
    // 'FileName' => 'path/to/file'

    // Can also save directly to a location on disk. This will cause download() to not return file content.
    // 'SaveAs' => '/path/to/save/location'
]);

File Copy

``` php $copyOfFile = $client->copy([ 'BucketName' => $bucketName, 'FileName' => $path, 'SaveAs' => $newPath,, <sub>(*10)</sub>

// Can also supply BucketId instead of BucketName
// Optional are DestinationBucketName or DestinationBucketId

]);, <sub>(*11)</sub>

#### File Delete
``` php
$fileDelete = $client->deleteFile([
    'FileId' => $file->getId()

    // Can also identify the file via bucket and path:
    // 'BucketName' => 'my-special-bucket',
    // 'FileName' => 'path/to/file'
]);

List all files

``` php $fileList = $client->listFiles([ 'BucketId' => 'YOUR_BUCKET_ID' ]);, <sub>(*12)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

```bash
$ vendor/bin/phpunit

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*13)</sub>

Security

If you discover any security related issues, please email mhetreramesh@gmail.com instead of using the issue tracker., <sub>(*14)</sub>

Credits

• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>