/CloudFS-PHP

Primary LanguagePHP

Bitcasa SDK for PHP

The Bitcasa SDK for PHP enables PHP developers to easily work with Bitcasa Cloud Storage Platform and build scalable solutions.

Getting Started

If you have already signed up and obtained your credentials you can get started in minutes.

There are two main methods of getting the CloudFS-PHP SDK.

  1. Cloning the git repository.
$ git clone https://github.com/bitcasa/CloudFS-PHP.git
  1. Adding the CloudFS-PHP SDK package name to composer by editing composer.json.
"require": {
    "bitcasa/cloudfs_sdk": "dev-develop"
  }

For the composer package to run, you should have composer installed.

Using the SDK

Use the credentials you obtained from Bitcasa admin console to create a client session. This session can be used for all future requests to Bitcasa.

$session = new Session($endPoint, $clientId, $clientSecret);
$session->authenticate($username, $password);

Getting the root folder

$root = $session->filesystem()->root();

Getting the contents of root folder

$items = $root->getList();

Creating a sub folder under root folder

$folder = $root->createFolder($folderName);

Uploading a file to a folder

$uploadedFile = $folder->upload($localFilePath, $uploadProgressCallback, Exists::OVERWRITE);

Download a file to a local destination.

$uploadedFile->download($localDestinationPath, $downloadProgressCallback);

Deleting a file or folder

$item->delete();

Create user (for paid accounts only)

$session->setAdminCredentials($adminId, $adminSecret);
$user = $session->createAccount($username, $password, $email, $firstName, $lastName);

Running the Tests

Before running the tests, you should add the API credentials found in your CloudFS account to the file \tests\BaseTest.php

If you used the clone method to download the SDK you should have PHPUnit installed to run the tests. The instructions to download and install PHPUnit can be found at https://phpunit.de/

WARNING!!! Never run the test suite against a production environment. It deletes all the contents of the file system.

To execute the tests go the root source code directory and run:

phpunit

We would love to hear what features or functionality you're interested in, or general comments on the SDK (good and bad - especially bad).