cwhite92 / b2-sdk-php
A SDK for working with B2 cloud storage.
Installs: 114 400
Dependents: 3
Suggesters: 0
Security: 0
Stars: 75
Watchers: 4
Forks: 41
Open Issues: 16
Requires
- php: >=5.5.0
- guzzlehttp/guzzle: ^6.1
Requires (Dev)
- phpunit/phpunit: 4.8.*
This package is not auto-updated.
Last update: 2024-10-26 19:53:39 UTC
README
b2-sdk-php
is a client library for working with Backblaze's B2 storage service. It aims to make using the service as
easy as possible by exposing a clear API and taking influence from other SDKs that you may be familiar with.
Example
This is just a short example, full examples to come on the wiki.
use ChrisWhite\B2\Client; use ChrisWhite\B2\Bucket; $client = new Client('accountId', 'applicationKey'); // Returns a Bucket object. $bucket = $client->createBucket([ 'BucketName' => 'my-special-bucket', 'BucketType' => Bucket::TYPE_PRIVATE // or TYPE_PUBLIC ]); // Change the bucket to private. Also returns a Bucket object. $updatedBucket = $client->updateBucket([ 'BucketId' => $bucket->getId(), 'BucketType' => Bucket::TYPE_PUBLIC ]); // Retrieve an array of Bucket objects on your account. $buckets = $client->listBuckets(); // Delete a bucket. $client->deleteBucket([ 'BucketId' => '4c2b957661da9c825f465e1b' ]); // Upload a file to a bucket. Returns a File object. $file = $client->upload([ 'BucketName' => 'my-special-bucket', 'FileName' => 'path/to/upload/to', 'Body' => 'I am the file content' // The file content can also be provided via a resource. // 'Body' => fopen('/path/to/input', 'r') ]); // Download a file from a bucket. Returns the file content. $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' ]); // Delete a file from a bucket. Returns true or false. $fileDelete = $client->deleteFile([ 'FileId' => $file->getId() // Can also identify the file via bucket and path: // 'BucketName' => 'my-special-bucket', // 'FileName' => 'path/to/file' ]); // Retrieve an array of file objects from a bucket. $fileList = $client->listFiles([ 'BucketId' => '4d2dbbe08e1e983c5e6f0d12' ]);
Installation
Installation is via Composer:
$ composer require cwhite92/b2-sdk-php
Tests
Tests are run with PHPUnit. After installing PHPUnit via Composer:
$ vendor/bin/phpunit
Contributors
Feel free to contribute in any way you can whether that be reporting issues, making suggestions or sending PRs. :)
License
MIT.