elemeno/elemeno

Elemeno CMS PHP API Wrapper

Elemeno

The official PHP client for Elemeno, an API based CMS. Use this module to easily integrate your content created on Elemeno into your PHP projects., _(*1)

Create an account and get started for free at https://elemeno.io, _(*2)

Requirements

• A minimum of PHP 5.5.0
• Composer must be installed

Installation

If Composer is installed globally:, _(*3)

composer require elemeno/elemeno:~0.1

If Composer is installed locally:, _(*4)

php composer.phar require elemeno/elemeno:~0.1

Elemeno Documentation

API documentation is available at http://docs.elemeno.io, _(*5)

Usage

If you haven't already, you must include the following line when using Composer:, _(*6)

require_once 'vendor/autoload.php';

You can then create a new Elemeno Client with the following:, _(*7)

// Create a new Elemeno Client with your unique API key
$elemeno = new \Elemeno\Client('123e4567-e89b-12d3-a456-426655440000');

Note: API keys can be created in settings, _(*8)

Example Usage

 [
            '$title' => [
                '$contains' => 'pie'
            ]
        ],
        'sort' => [
            '$datePublished' => 'ASC'
        ],
        'page' => 1,
        'size' => 20
    ];

    print_r($elemeno->getCollectionItems('recipes', $options));
?>

API Overview

Singles

$elemeno->getSingles([$options])

$options = [
    'sort' => [
        '$dateUpdated' => 'DESC'
    ],
    'page' => 1,
    'size' => 20
];

print_r($elemeno->getSingles($options));

$elemeno->getSingle($singleSlug)

print_r($elemeno->getSingle('about'));

Collections

$elemeno->getCollections([$options])

$options = [
    'sort' => [
        '$dateCreated' => 'DESC'
    ],
    'page' => 1,
    'size' => 20
];

print_r($elemeno->getCollections($options));

$elemeno->getCollection($collectionSlug)

print_r($elemeno->getCollection('recipes'));

$elemeno->getCollectionItems($collectionSlug, [$options])

$options = [
    'filters' => [
        '$title' => [
            '$contains' => 'pie'
        ]
    ],
    'sort' => [
        '$datePublished' => 'ASC'
    ],
    'page' => 1,
    'size' => 20
];

print_r($elemeno->getCollectionItems('recipes', $options));

$elemeno->getCollectionItem($collectionSlug, $itemSlug, [$options])

$elemeno->getCollectionItem(
    'recipes',   // collectionSlug
    'apple-pie'  // itemSlug
);

or byId:, _(*9)

$options = [
    'byId' => true
];

$elemeno->getCollectionItem(
    'recipes',                               // collectionSlug
    '281cf9b2-b355-11e6-b10e-5b3ff757fea2',  // itemId
    $options
);