README

PHP SDK to work with BestCDN.

It contains optional Laravel support.

Currently unstable aka. work in progress, use at your own discretion.

How to install

To add this package to your app

composer require black-bits/bestcdn-sdk-php

Using Laravel you need to publish the config

php artisan vendor:publish --provider="BlackBits\BestCdn\BestCdnServiceProvider"

How to use

Laravel

Using Laravel you can use the SDK in multiple ways.

Using the Facade

$key     = "myPath/myFileName.ext";      // desired path on cdn
$file    = __DIR__ . "/file.ext";        // local absolute path
$respose = BestCdn::putFile($key, $file);

Using Dependency Injection

For example inside a Controller

class FileController extends Controller
{
    public function putFile(Request $request, BestCdn $cdn)
    {
        // ...
        $key     = "myPath/myFileName.ext"; // desired path on cdn
        $file    = __DIR__ . "/file.ext";   // local absolute path
        $respose = $cdn->putFile($key, $file); 
        // ...
    }
}

In other frameworks or standalone PHP

If you do not use the Laravel Framework you need to instantiate the base class with a default config first

$config = [

    'connections' => [
        'default' => [
            "credentials" => [
                "key"    => "YourBestCdnProjectKey",    // required
                "secret" => "YourBestCdnProjectSecret", // required
            ],
            "defaultRequestOptions" => [
                "base_uri" => "https://management.bestcdn.io/", // required - e.g. sandbox(testing) or production endpoint
                "verify"   => true,                             // optional - can be set to false for local testing (does not enforce SSL verification)
            ],
        ],
    ],

    "defaultConnection" => "default", // optional, if you configure multiple connections (multiple projects/testing/production)
];

$cdn     = new BestCdn($config);
$key     = "myPath/myFileName.ext"; // desired path on cdn
$file    = __DIR__ . "/file.ext";   // local absolute path
$respose = $cdn->putFile($key, $file);

Making a request

putFile()

When making a request to store a file on the CDN you need to provide the desired key and a file.

The key represents the sub-path within your project namespace (the public path on the CDN will end in /{project-name}-{customer-name}/{key}).

The file should be an absolute path to a file.

$key     = "myPath/myFileName.md"; // desired path on cdn
$file    = __DIR__ . "/README.md"; // local absolute path
$respose = $cdn->putFile($key, $file);

putFileByUri()

When making a request to store a file on the CDN via URI you need to provide the desired key and a uri. The CDN will download the file from the given URI.

The key represents the sub-path within your project namespace (the public path on the CDN will end in /{project-name}-{customer-name}/{key}).

The uri should be a valid, publicly accessible uri of a file.

$key     = "myPath/myFileName.jpeg";                                           // desired path on cdn
$uri     = "https://static.pexels.com/photos/460797/pexels-photo-460797.jpeg"; // public uri
$respose = $cdn->putFileByUri($key, $uri);

Handling Results

After a successful request you get the response data like this:

var_dump($response->data());

Results in:

array(1) {
  ["cdn_link"]=>
  string(139) "https://staging.master.bestcdn.io/project_1-customer_01/example/image_profile/250x250_10.jpg"
}

To access file properties (like the cdn_link) you can use convenience methods like this:

$response['cdn_link'];
$response->get('cdn_link');

Handling Errors

For error handling we provide a standardised exception as well as default error handling.

You handle common errors like this:

$cdn = new BestCdn($config);

$key  = "myPath/myFileName.md";
$file = __DIR__ . "/README.md";

$result = $cdn->putFile($key, $file);
if ( $result->hasError() ) {
    print $result->statusCode();
    print $result->message();
    // ... abort mission!
}

// ... normal code

Common errors will include routine, non critical errors like trying to get information on or deleting a non existing file.

Exceptions will be thrown if the error needs to be handled (authentication error, etc.).

black-bits / bestcdn-sdk-php

Maintainers

Details