bcarrella / backblaze-b2

用于操作B2云存储的SDK。

dev-master 2024-05-14 17:06 UTC

This package is auto-updated.

Last update: 2024-09-24 16:38:36 UTC


README

Software License Latest Version Build Status

backblaze-b2 是用于操作Backblaze的B2存储服务的客户端库。它通过提供一个清晰的API并借鉴您可能熟悉的其他SDK,旨在使使用此服务尽可能简单。

此包将缓存授权请求1小时,以避免从B2收到API限制。

此版本与主密钥和应用密钥兼容,以及版本2(见下文)。

示例

这只是简短的示例,更完整的示例将在wiki上提供。

use obregonco\B2\Client;
use obregonco\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
]);

// 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'
]);

// Create a new access key.
$capabilities = new Capabilities()
$key = $client->createKey($accountId, $name, new Capabilities(
    [Capabilities::DELETE_BUCKETS,
    Capabilities::LIST_ALL_BUCKET_NAMES,
    Capabilities::READ_BUCKETS]
));

$keyId = $key->getKeyId();
$applicationKeyId = $key->getApplicationKey();

// Delete an existing access key.
try {
    $client->deleteKey($keyId);
} catch (RequestException $e) {
    // $e->getCode()
}

安装

安装通过Composer完成

$ composer require obregonco/backblaze-b2

测试

测试使用PHPUnit运行。通过Composer安装PHPUnit(开发中)

$ vendor/bin/phpunit

贡献者

请随时以任何方式贡献,无论是报告问题、提出建议还是发送PR。:)

许可

LGPL。