theninthnode/defaqto

PHP package for interacting with the Defaqto.io API.

DefaqtoIO PHP Client

DefaqtoIO PHP Client is a PHP package for using the DefaqtoIO CMS service., _(*1)

Installation

Composer

Add the library to your composer.json file, _(*2)

"theninthnode/defaqto": "dev-master"

Run composer install to get the latest version of the package., _(*3)

Manually

It's recommended that you use Composer, however you can download and install from this repository., _(*4)

Please note. This client requires the Guzzle REST PHP package., _(*5)

Laravel 4

This package comes with a Service Provider and Facade for easy integration with Laravel4., _(*6)

1. Add the following entry to the providers array in config/app.php, _(*7)

   'TheNinthNode\Defaqto\DefaqtoServiceProvider', _(*8)

2. Add the following entry to the aliases array in config/app.php, _(*9)

   'Defaqto' => 'TheNinthNode\Defaqto\Facades\Defaqto',, _(*10)

Usage

1. Register your account at defaqto.io.
2. Log in and create your first app by clicking the "+ Create New App" button.
3. In your new app click "Settings" from the left menu.
4. Take note of the the App ID and Access Token.
5. Create a test page.

After installing the package you can use it like this:, _(*11)

$pages = Defaqto::setup($app_id, $access_token)->get('pages');
var_dump($pages);

NOTE. If you get a class not found error load the class in with:, _(*12)

use TheNinthNode\Defaqto\Defaqto;

OR, _(*13)

$pages = TheNinthNode\Defaqto\Defaqto::setup($app_id, $access_token)->get('pages');

You can use the class with the following syntax:, _(*14)

$html = Defaqto::setup($app_id, $access_token)->get('resource', array('key'=>'value'));

Where resource is one of pages, blocks, variables, blog/posts, blog/categories, blog/tags, blog/authors., _(*15)

The second (optional) param is an array of key=>value pairs known as attributes. ie. array('page_slug'=>'about-us'), _(*16)

Each resource has the following optional params:, _(*17)

• order - field to use for sorting
• dir - direction to sort ASC or DESC
• limit - limit the amount of results
• offset - number of results to skip

There is a third optional param for use with the blog/posts resource. This is an array of resources to exclude (tags, categories, authors), _(*18)

Examples

Pages

resource: pages, _(*19)

Params:, _(*20)

• page_id
• page_slug

To get all pages:, _(*21)

$pages = Defaqto::setup($app_id, $access_token)->get('pages');
var_dump($pages);

To get a page by page_slug, _(*22)

$page = Defaqto::setup($app_id, $access_token)->get('pages', array('page_slug'=>'about-us'));
echo $page['title'];

HTML Blocks

resource: blocks, _(*23)

Params:, _(*24)

• block_id

To get all blocks:, _(*25)

$blocks = Defaqto::setup($app_id, $access_token)->get('blocks');
var_dump($blocks);

To get a block by block_id, _(*26)

$block = Defaqto::setup($app_id, $access_token)->get('blocks', array('block_id'=>1234));
echo $block['content'];

Variables

resource: variables, _(*27)

Params:, _(*28)

• key

To get all variables:, _(*29)

$variables = Defaqto::setup($app_id, $access_token)->get('variables');
var_dump($variables);

To get a variable by it's key, _(*30)

$variable = Defaqto::setup($app_id, $access_token)->get('variables', array('key'=>'pricing'));
echo $variable['value'];

Blog posts

resource: blog/posts, _(*31)

Params:, _(*32)

• post_id
• post_slug
• category_slug
• tag_slug
• status - draft|published (defaults to published)

To get all (published) posts:, _(*33)

$posts = Defaqto::setup($app_id, $access_token)->get('blog/posts');
var_dump($posts);

To get a post by it's post_slug, _(*34)

$post = Defaqto::setup($app_id, $access_token)->get('blog/posts', array('post_slug'=>'hello-world'));
echo $post['title'];

To get all posts by tag (tag_slug), _(*35)

$posts = Defaqto::setup($app_id, $access_token)->get('blog/posts', array('tag_slug'=>'javascript'));
var_dump($posts);

To get all posts without their authors, tags, or categories, _(*36)

$posts = Defaqto::setup($app_id, $access_token)->get('blog/posts', array(), array('authors', 'tags', 'categories'));

Blog categories

resource: blog/categories, _(*37)

Params:, _(*38)

• category_id
• category_slug

To get all categories:, _(*39)

$cats = Defaqto::setup($app_id, $access_token)->get('blog/categories');
var_dump($cats);

To get a category by it's slug, _(*40)

$category = Defaqto::setup($app_id, $access_token)->get('blog/categories', array('category_slug'=>'announcements'));
echo $category['name'];

Blog tags

resource: blog/tags, _(*41)

Params:, _(*42)

• tag_id
• tag_slug

To get all tags:, _(*43)

$tags = Defaqto::setup($app_id, $access_token)->get('blog/tags');
var_dump($tags);

To get a tag by it's slug, _(*44)

$tag = Defaqto::setup($app_id, $access_token)->get('blog/tags', array('tag_slug'=>'javascript'));
echo $tag['name'];

Blog authors

resource: blog/authors, _(*45)

Params:, _(*46)

• author_id
• username

To get all authors:, _(*47)

$authors = Defaqto::setup($app_id, $access_token)->get('blog/authors');
var_dump($authors);

To get an author by their username, _(*48)

$author = Defaqto::setup($app_id, $access_token)->get('blog/authors', array('username'=>'jonesy'));
echo $author['bio'];