b2-sdk-php - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #llm #golang #machine-learning #rust #docker #nodejs #awesome-list #security #openai #open-source

b2-sdk-php

(★ 74)

SDK for Backblaze's B2 storage service.

File Explorer

Download Latest Version (.zip)

- - B2Exception.php
  - BadJsonException.php
  - BadValueException.php
  - BucketAlreadyExistsException.php
  - BucketNotEmptyException.php
  - FileNotPresentException.php
  - NotFoundException.php
  - ValidationException.php
- - Client.php
- Bucket.php
- Client.php
- ErrorHandler.php
- File.php
- - authorize_account.json
  - bucket_not_empty.json
  - create_bucket_exists.json
  - create_bucket_private.json
  - create_bucket_public.json
  - delete_bucket.json
  - delete_bucket_non_existent.json
  - delete_file.json
  - delete_file_non_existent.json
  - download_by_incorrect_id.json
  - download_by_incorrect_path.json
  - download_content
  - get_file.json
  - get_file_non_existent.json
  - get_upload_url.json
  - list_buckets_0.json
  - list_buckets_3.json
  - list_files_empty.json
  - list_files_page1.json
  - list_files_page2.json
  - update_bucket_to_private.json
  - update_bucket_to_public.json
  - upload.json
- ClientTest.php
- TestHelper.php
.gitignore
.travis.yml
composer.json
LICENSE.md
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/cwhite92/b2-sdk-php

Downloads the entire project code from GitHub to your computer.

cd b2-sdk-php

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

$ composer require cwhite92/b2-sdk-php

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Backblaze B2 SDK for PHP
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/cwhite92/b2-sdk-php/master/LICENSE.md)
[![Latest Version](https://img.shields.io/github/release/cwhite92/b2-sdk-php.svg?style=flat-square)](https://github.com/cwhite92/b2-sdk-php/releases)
[![SensioLabs Rating](https://img.shields.io/sensiolabs/i/d5e44d75-84d2-40c7-b0d4-7f628429e139.svg?style=flat-square)](https://insight.sensiolabs.com/projects/d5e44d75-84d2-40c7-b0d4-7f628429e139)
[![Build Status](https://img.shields.io/travis/cwhite92/b2-sdk-php.svg?style=flat-square)](https://travis-ci.org/cwhite92/b2-sdk-php)

`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.

```php
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:

```bash
$ composer require cwhite92/b2-sdk-php
```

## Tests

Tests are run with PHPUnit. After installing PHPUnit via Composer:

```bash
$ 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.