PHP SDK v2 (Beta)

Important
The PHP SDK v2 is currently in BETA. There may be minor changes to parameter names or other implementation details before the general access release. We invite you to try it out. We would appreciate any feedback via our support team.

Overview

Cloudinary is a cloud-based service that provides an end-to-end image and video management solution. The PHP SDK provides simple, yet comprehensive image and video manipulation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing PHP application.

This guide relates to the BETA version of the Cloudinary PHP SDK v2.

For details on all new features and fixes from previous versions, see the CHANGELOG.

Note
See the PHP SDK Migration guide for more information on migrating to version 2 of the PHP SDK. For information on the previous version of the PHP SDK, see the PHP SDK 1 documentation.

Quick example: Transformations

The following Cloudinary URL and corresponding PHP SDK code delivers the image below in an https delivery URL, including all of the following transformations:

  • Thumbnail crop to a size of 150x150 pixels using face detection gravity to automatically determine the location for the crop
  • Rounded corners with a 20 pixel radius
  • Sepia effect
  • Overlay of the Cloudinary logo on the southeast corner (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness, and partial transparency (opacity = 60%)
  • Rotated by 10 degrees
  • Converted to and delivered in PNG format (the originally uploaded image was a JPG)
Copy to clipboard
$cloudinary->image('front_face.png')
  ->resize(Resize::thumbnail(150, 150)->gravity(Gravity::face()))
  ->roundCorners(20)
  ->effect(Effect::sepia())
  ->overlay(
      Source::image('cloudinary_icon')
        ->adjust(Adjust::brightness(100))
        ->adjust(Adjust::opacity(60))
        ->resize(Resize::scale(50)),
      Position::southEast()->x(5)->y(5)
  )
  ->rotate(10);

// Output: https://res.cloudinary.com/demo/image/upload/c_thumb,g_face,h_150,w_150/r_20/e_sepia/l_cloudinary_icon/e_brightness:100/o_60/c_scale,w_50/fl_layer_apply,g_south_east,x_5,y_5/a_10/front_face.png

sample transformation

Quick example: File upload

The following PHP code uploads the dog.mp4 video to the specified account sub-folder using the public_id, my_dog. The video will overwrite the existing my_dog video if it exists. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.

Copy to clipboard
(new UploadApi())->upload('dog.mp4', [
  'folder' => 'my_folder/my_sub_folder/', 
  'public_id' => 'my_dog', 
  'overwrite' => true, 
  'notification_url' => 'https://mysite.example.com/notify_endpoint', 
  'resource_type' => 'video']);

PHP library features

  • Build URLs for image and video manipulations
  • PHP view helper tags for embedding and transforming images
  • API wrappers: file upload, administration, sprite generation and more
  • Server-side file upload + direct unsigned file upload from the browser using the jQuery plugin

PHP capitalization and data type guidelines

When using the PHP SDK, keep these guidelines in mind:

  • Properties names: camelCase. For example: publicId
  • Classes: PascalCase. For example: ImageTag
  • Pass parameter data as: array

Installation

Composer installation

Use Composer to manage your PHP library dependency, and install Cloudinary's PHP library directly from the Packagist repository.

  1. Update your composer.json file as follows:

    Copy to clipboard
    {
      "require": {
        "cloudinary/cloudinary_php": "2.0.0-beta"
      }
    }
  2. Automatically install dependencies including Cloudinary's PHP package:

    Copy to clipboard
    php composer.phar install

Configuration

To use the Cloudinary PHP library, you have to configure at least your cloud_name. Your api_key and api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your account-specific configuration credentials in the Dashboard page of the account console.

Setting the configuration parameters can be done either programmatically in each call to a Cloudinary method or you can set them globally using either an environment variable or the Configuration::instance method. You can optionally configure the required cloud_name, api_key, and api_secret by defining the CLOUDINARY_URL environment variable. The configuration URL is available in the Dashboard page of the account console. When using Cloudinary through a PaaS add-on (e.g., AppFog), this environment variable is automatically defined in your deployment environment. For example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name?

In addition to the required parameters, you can define a number of optional configuration parameters if relevant.

Here's an example of setting configuration parameters globally in your PHP application using an instance of the Configuration class:

Copy to clipboard
use Cloudinary\Configuration\Configuration;

// configure globally via a JSON object


Configuration::instance([
  'account' => [
    'cloud_name' => 'my_cloud_name', 
    'api_key' => 'my_key', 
    'api_secret' => 'my_secret'],
  'url' => [
    'secure' => true]]);


//  Or configure programatically

$config = Configuration::instance();
$config->account->cloudName = 'my_cloud_name';
$config->account->apiKey = 'my_key';
$config->account->apiSecret = 'my_secret';
$config->url->secure = true;

You can also configure the parameters via the environment variable, for example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name?url[secure]=true&account[cname]=my_site.com

If you require multiple instances, you can use the Cloudinary object to configure each instance, for example:

Copy to clipboard
use Cloudinary\Configuration\Configuration;

// configure an instance via a JSON object

$cloudinary = new Cloudinary([
  'account' => [
    'cloud_name' => 'my_cloud_name',
    'api_key'  => 'my_key',
    'api_secret' => 'my_secret',
  'url' => [
    'secure' => true]]]);


//  Or configure programatically

$config = new Configuration();
$config->account->cloudName = 'my_cloud_name';
$config->account->apiKey = 'my_key';
$config->account->apiSecret = 'my_secret';
$config->url->secure = true;
$cloudinary = new Cloudinary($config);

You can also configure parameters for an instance via environment variable, for example:

Copy to clipboard
$cloudinary = new Cloudinary('cloudinary://my_key:my_secret@my_cloud_name?url[secure]=true&account[cname]=my_site.com')

Related topics