mizbanpaytakht / backblaze-b2
An SDK for working with B2 cloud storage.
Requires
- php: >=7.0.0
- ext-json: *
- guzzlehttp/guzzle: ^6.5 || ^7.0
- illuminate/cache: >=5.1.0
- illuminate/container: >=5.1.0
- illuminate/filesystem: >=5.1.0
- illuminate/support: >=5.1.0
README
backblaze-b2
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.
This package will cache authorization request for 1 hour so that you won't receive API Limit from B2.
This version works with both master key and application key, and version 2 (look below).
Example
This is just a short example, full examples to come on the wiki.
use mizbanpaytakht\B2\Client; use mizbanpaytakht\B2\Bucket; $client = new Client('accountId', [ 'keyId' => 'your-key-id', // optional if you want to use master key (account Id) 'applicationKey' => 'your-application-key', ]); $client->version = 2; // By default will use version 1 $client->domainAliases = [ // When you want to use your own domains (using CNAME) 'f0001.backblazeb2.com' => 'alias01.mydomain.com', ]; $client->largeFileLimit = 3000000000; // Lower limit for using large files upload support. Default: 3GB // Returns a Bucket object. $bucket = $client->createBucket([ 'BucketName' => 'my-special-bucket', 'BucketType' => Bucket::TYPE_PRIVATE // or TYPE_PUBLIC ]); // Create a new Key. $bucket = $client->createKey([ 'capabilities' => ['listKeys', 'writeKeys', 'deleteKeys', 'listAllBucketNames', 'listBuckets', 'readBuckets', 'writeBuckets', 'deleteBuckets', 'readBucketRetentions', 'writeBucketRetentions', 'readBucketEncryption', 'writeBucketEncryption', 'listFiles', 'readFiles', 'shareFiles', 'writeFiles', 'deleteFiles', 'readFileLegalHolds', 'writeFileLegalHolds', 'readFileRetentions', 'writeFileRetentions','bypassGovernance'], 'keyName' => 'Key-Name', 'bucketId' => $bucket->getId(), 'namePrefix' => 'Prefix', ]); // 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->deleteFileFromArray([ '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->listFilesFromArray([ 'BucketId' => '4d2dbbe08e1e983c5e6f0d12' ]);
Installation
Installation is via Composer:
$ composer require mizbanpaytakht/backblaze-b2
Tests
Tests are run with PHPUnit. After installing PHPUnit via Composer (under development):
$ vendor/bin/phpunit
Contributors
Feel free to contribute in any way you can whether that be reporting issues, making suggestions or sending PRs. :)
License
LGPL.