kuzzleio/kuzzle-sdk

This package is abandoned and no longer maintained. No replacement package was suggested.

Official PHP SDK for Kuzzle

3.0.7 2019-09-16 14:03 UTC

Requires

• php: >=5.4
• ext-curl: *
• ramsey/uuid: ^3.4

Requires (Dev)

• phpdocumentor/phpdocumentor: 2.9.0
• phpunit/phpunit: 4.8.*
• squizlabs/php_codesniffer: 2.*

Apache-2.0

• The Kuzzle Team

README

Official Kuzzle PHP SDK

About Kuzzle

A backend software, self-hostable and ready to use to power modern apps.

You can access the Kuzzle repository on Github

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

SDK Documentation

The complete SDK documentation is available here

Installation

This SDK can be used in any project using composer:

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