kuzzleio/kuzzle-sdk

Official PHP SDK for Kuzzle

, _(*1)

Official Kuzzle PHP SDK

About Kuzzle

A backend software, self-hostable and ready to use to power modern apps., _(*2)

You can access the Kuzzle repository on Github, _(*3)

• SDK Documentation
• Installation
• Basic usage
• Running tests
• License

SDK Documentation

The complete SDK documentation is available here, _(*4)

Installation

This SDK can be used in any project using composer:, _(*5)

composer require kuzzleio/kuzzle-sdk

Basic usage

<?php

use \Kuzzle\Kuzzle;
use \Kuzzle\Document;

$kuzzle = new Kuzzle('localhost');
$collection = $kuzzle->collection('bar', 'foo');

$firstDocument = new Document($collection, 'john', ['name' => 'John', 'age' => 42]);
$secondDocument = new Document($collection, 'michael', ['name' => 'Michael', 'age' => 36]);

$firstDocument->save(['refresh' => 'wait_for']);
$secondDocument->save(['refresh' => 'wait_for']);

$result = $collection->search(['sort' => [['age' => 'asc']]]);
foreach ($result->getDocuments() as $document) {
    $content = $document->getContent();
    echo "Name: {$content['name']}, age: {$content['age']}\n";
}

Running Tests

php ./vendor/bin/phpcs -p -n --standard=PSR2 src
php ./vendor/bin/phpunit

License

Apache 2, _(*6)