dmhendricks/b2-sdk-php

Backblaze的B2存储服务的PHP SDK。

1.3.4 2018-10-23 20:38 UTC

README

GitHub License Latest Version Packagist Build Status Donate WP Engine Twitter

Backblaze B2 SDK for PHP

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

授权请求将被缓存1小时,以避免达到B2 API的限制。

历史与变更

这是基于RunCloudIO版本的一个分支,原始版本由Chris White创建,以下是一些变更:

  • 实现了来自ryanall分支的支持。
  • 在失败时,Client->download()返回null,而不是无效路径。

安装

通过Composer安装

composer require dmhendricks/b2-sdk-php

使用示例

use ChrisWhite\B2\Client;
use ChrisWhite\B2\Bucket;

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

// Returns the base B2 file URL
$client->getDownloadUrl();

// Returns the provided bucket/file prefixed with the B2 base URL
$client->getDownloadUrl([
    'BucketName' => 'my-special-bucket',
    'FileName' => 'path/to/file'
]);

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

/*
 * Retrieve file versions from a bucket. Returns array. Optional parameters:
 *    StartFileName - The first file name to return.
 *    StartFileId - The first file ID to return. startFileName must also be
 *        provided if startFileId is specified.
 *    MaxFileCount - The maximum number of files to return.
 *    Prefix - Files returned will be limited to those with the given prefix.
 *        Defaults to the empty string, which matches all files.
 *    Delimiter - The delimiter character will be used to "break" file names
 *        into folders.
 * @see https://www.backblaze.com/b2/docs/b2_list_file_versions.html
 */
$fileVersions = $client->listFileVersions([
    'BucketId' => '4d2dbbe08e1e983c5e6f0d12',
]);

测试

测试使用PHPUnit运行。安装PHPUnit后

$ vendor/bin/phpunit

变更日志

发布变更记录在Releases页面。

分支:master