PHP Driver

Connect your PHP applications to Cloud CMS





Current version: 1.0.1. Released Aug 19, 2019

The Cloud CMS PHP driver is a client library used to facilitate connections to the Cloud CMS API. The driver handles OAuth authentication and token management, HTTPS calls, and provides convenient methods and classes with which to perform content operations. It works against Cloud CMS instances on our SaaS platform as well as on-premise installations.

Installation

To install, run:

composer require cloudcms/cloudcms

Examples

Below are some examples of how you might use this driver:

use CloudCMS\CloudCMS;

// Load configuration from gitana.json file
$config_string = file_get_contents("gitana.json");
$config = json_decode($config_string, true);

// Connect to CloudCMS
$client = new CloudCMS();
$platform = $client->connect($config);

// List Repositories
$repositories => $platform->listRepositories();

// Read Repository
$repository = $platform->readRepository("");

// List Branches
$branches = $repository->listBranches();

// Read Branch
$branch = $repository->readBranch("");

// Read Node
$node = $branch->readNode("");

// Create Node
$obj = array(
    "title" => "Twelfth Night",
    "description" => "An old play"
);
$newNode = $branch->createNode($obj);

// Query Nodes
$query = array(
    "_type" => "store:book"
);
$pagination = array(
    "limit" => 2
);
$queriedNodes = $branch->queryNodes($query, $pagination);

// Find Nodes
$find = array(
    "search" => "Shakespeare",
    "query" => array(
        "_type" => "store:book"
    )
);
$foundNodes = $branch->findNodes($find);
        

Documentation

The PHP driver is a useful library that provides access to the capabilities of Cloud CMS from a programmatic perspective. It is therefore important to first familiarize yourself with the concepts presented in the Cloud CMS Documentation.


Fork the Code

The Cloud CMS PHP driver is 100% open-source (Apache 2.0) and so you're free to fork it, extend it and dig into it to learn about how it works.


Bugs / Problems

If you run into a bug, please create an issue so that we can look at it.
For production support, please contact us at support@cloudcms.com or call us directly.


Support and Terms of Use

The PHP driver is free to use in your applications and projects. It is fully supported by Cloud CMS.