On Page ® PHP library

With this library you can easy query your data using an On Page ® API token.

Installation

composer config repositories.onpage vcs 'https://github.com/onpage-dev/onpage-php.git'
composer require onpage-dev/onpage-php:^v1.1

To update to the latest version, you can launch

composer require onpage-dev/onpage-php:^v1.1

Of course, remember to include the composer autoload:

<?php
require 'vendor/autoload.php';

Usage

Setup

$api = new \OnPage\Api('acme-inc', $api_token);

Get structure information

// Retrieve info about the schema:
echo $api->schema->label;

// Retrieve a resource given its name or ID
$res = $api->schema->resource('products');
foreach ($res->fields() as $field) {
    echo "$field->label\n";
    echo "$field->name\n";
    echo "$field->type\n";
    echo "$field->is_multiple\n";
    echo "$field->is_translatable\n";
}

Query your data

// Retrieve all records of a resource (returns a laravel collection of \OnPage\Thing)
$products = $api->schema->query('products')->all();
foreach ($products as $prod) {
    // ...
}

// Get only the first item
$prod = $api->query('products')->first();

Filters and deletions

// Retrieve all records of a resource (returns a laravel collection of \OnPage\Thing)
$api->query('products')
    ->where('_id', 42) // = is the default operator
    ->first();

// Other filters
$api->query('products')
    ->where('name', 'like', 'shoes') // you can specify a different operator
    ->where('category.name', 'Nike') // you can query relations
    ->where('dimension', '>', 10) // you get it
    ->all(); // returns a collection with all your records


// You can just smply delete data the same way:
$api->query('products')
    ->where(...)
    ->delete();

Get thing values

Use the val() function to get the first value in a field. Use the values() function to get all values in a field as a collection.

$cat = $api->query('categories')->first();
echo $cat->val('name');
echo $cat->val('dimension');
echo $cat->val('description', 'zh'); // you can specify a language

// Or set the default language
$api->schema->lang = 'zh';
echo $cat->val('name'); // 再见

// The values function is useful for multivalue fields, it will return a laravel collection of values.
echo $cat->values('bullet_points')->implode('; ');

Files

For image and file fields, the returned value will be an instance of \OnPage\File::class. To get a file or image url use the ->link() function. The link will point to the original file.

# original size
$product->val('specsheet')->name // icecream-spec.pdf
$product->val('specsheet')->token // R417C0YAM90RF
$product->val('specsheet')->link() // https://acme-inc.onpage.it/api/storage/R417C0YAM90RF?name=icecream-spec.pdf

To turn images into a thumbnail add an array of options as shown below:

# maintain proportions width 200px
$product->val('cover_image')->link(['x' => 200])

# maintain proportions height 100px
$product->val('cover_image')->link(['y' => 100])

# crop image to width 200px and height 100px
$product->val('cover_image')->link(['x' => 200, 'y' => 100])

# maintain proportions and contain in a rectangle of width 200px and height 100px
$product->val('cover_image')->link(['x' => 200, 'y' => 100, 'contain' => true])

# convert the image to png (default is jpg)
$product->val('cover_image')->link(['x' => 200, 'format' => 'png'])

Other utilities

// Speed things up by only loading some fields
$api->query('products')->loadFields(['title'])->all();

// Get a mapping between two fields or a field and the thing ID
$api->query('products')->map('code');
// [ 'MYSKU100' => 1827, 'MYSKU101' => 1828, ... ]

$api->query('products')->map('code', 'title');
// [ 'MYSKU100' => 'Apples', 'MYSKU101' => 'Bananas', ... ]

Get thing relations

$cat = $api->query('categories')->first();
$subcategories = $cat->rel('subcategories');
foreach ($subcategories as $subcategory) {
    echo $subcategory->val('name');
}

// You can also get nested relations in one shot
$products = $cat->rel('subcategories.products');

Preload thing relations

$cat = $api->query('categories')
    ->with('subcategories')
    ->first();
$subcategories = $cat->rel('subcategories');
foreach ($subcategories as $subcategory) {
    echo $subcategory->val('name');
}

// You can also preload nested subcategories
$cat = $api->query('categories')
    ->with('subcategories.articles.colors')
    ->first();

Creating things

$resource = $api->resource('categories');
$writer = $resource->writer();

$foo = $writer->createThing();
$foo->set('name', 'Mr. Foo');
$foo->set('description', 'Default language description');
$foo->set('description', 'Custom language description', 'fr'); // you can specify language

$pat = $writer->createThing();
$pat->set('name', 'Mr. Pat');

// Save all the edits at once using the save method
$writer->save();

Updating a record

$cat = $api->query('categories' ->first();

$editor = $cat->editor();
$editor->set('name', 'Mr. Foo');
$editor->set('description', 'Default language description');
$editor->set('description', 'Custom language description', 'fr'); // you can specify language
$editor->save();

Updating many things with one single call

$resource = $api->resource('categories');
$writer = $resource->writer();

$foo = $writer->createThing();
$foo->set('name', 'Mr. Foo');
$foo->set('description', 'Default language description');
$foo->set('description', 'Custom language description', 'fr'); // you can specify language

$pat = $writer->createThing();
$pat->set('name', 'Mr. Pat');

// Save all the edits at once using the save method
$writer->save();