kuzzleio / sdk-php

Official php SDK for Kuzzle

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

sdk-php's Issues

Regenerate route file with new and updated http routes

Support Plugins Routes

Hello,

I need to use query() function in SDK PHP to call my custom plugin routes.
To do this I must update routes.json file... I think it's not a good solution.

Perhaps add a method to add custom Routes ?

Cheers,

add callback to KuzzleDataCollection.publishMessage

To follow the new SDK documentation ( https://github.com/kuzzleio/sdk-documentation/pull/75 ), a callback is needed for the KuzzleDataCollection.publishMessage method

Debug mode

Implement a debug mode to retrieve requests history between kuzzle-sdk & kuzzle

Compatibility Matrix

Factory methods and class names refactoring

After a long discussion, we decided to rename some methods and class names in the Kuzzle SDKs.

Class Names

• KuzzleDataCollection 👉 Collection
• KuzzleDataMapping 👉 CollectionMapping

Methods

• dataCollectionFactory 👉 collection
• dataMappingFactory 👉 collectionMapping
• roleFactory 👉 role
• profileFactory 👉 profile
• userFactory 👉 user
• documentFactory 👉 document
• getRole 👉 fetchRole
• getProfile 👉 fetchProfile
• getUser 👉 fetchUser

Subscription Management API

• subscribe/list returns a list of the existing subscription rooms
• admin/removeRooms removes a list of rooms. Takes a mandatory collection name and optionnal array of room IDs.
• join joins a specific room by ID

expose moveDocument

Expose a documentMove method that leverages the write.move API route.

Depends on kuzzleio/kuzzle#462

Problem with insert

Hi,

I have a problem to create a document with PHP-SDK. The exception message is :

"ErrorException' with message '[mapper_parsing_exception] failed to parse".

I have compared data's type with the collection mapping : it's correct. I tried to create my document directly in BO : OK. I tried with a REST request (with POSTMAN) and the document have been created. It's the first time I can't create a document with PHP SDK.
Our JSON

{       
       "id":45,
        "title":"Test daily tip",
        "status":1,"type_message":6,
        "challengeInstanceId":null,
        "theme":"Message de f\u00e9licitations et renforcement",
        "userId":410,
        "date":"2016-08-05 12:25:34",
        "programDate":null,
        "subTheme":"Bilan quotidien",
        "catchPhrase":"accroche test daily tip",
        "addText":"texte test daily tip",
        "body":"did you know test daily tip",
        "messageId":"daily_tip_in_progress",
        "icon":"",
        "fromUserId":null,
        "notifId":null,
        "notifText":null,
        "notifState":null,
        "notifParams":null
}

In PHP :

$this->kuzzle->save($message, $this->container->getParameter('kuzzle.index'));

    /**
     * @param AbstractKuzzleDocument $document
     * @param $index
     * @return AbstractKuzzleDocument
     */
    public function save(AbstractKuzzleDocument $document, $index)
    {
        $collection = $document::getKuzzleCollectionName();
        if (is_null($document->getKuzzleId())) {
            return $this->create($document, $index, $collection);
        }
        return $this->update($document, $index, $collection);
    }

And method create (in a class who override Kuzzle.php from Symfony-bridge) :

    /**
     * Create a document in Kuzzle from object implementing KuzzleDocumentInterface
     *
     * @param KuzzleDocumentInterface $document
     * @param string $index
     * @param string $collection
     * @return KuzzleDocumentInterface
     */
    public function create(KuzzleDocumentInterface $document, $index, $collection)
    {
        if (method_exists($document, 'setId')) {
            $document->setId($this->getUniqueId($index, $collection));
        }
        var_dump($document->toKuzzleDocument());
        return $document::fromKuzzleDocument(parent::createDocument($document->toKuzzleDocument(), $index, $collection)->serialize());
    }

And parent::createDocument() is the method in Symfony-Kuzzle-Bridge.

Thank you

Implement debug mode

Implement a debug mode to retrieve requests history between kuzzle-sdk & kuzzle

Readme lacks of testing instructions

Just as a reminder... Add to the README.md file the instructions to launch unit tests

Add missing getters

Could you add getters for "content" and "headers" attributes of the \Kuzzle\Document class ?

Thanks.

Rename the updateIfExist option

Currently, the Collection.createDocument method allows the updateIfExist option. Which does a document replacement if it exists in Kuzzle's database.

Since this option is misleading, and because we may want to add a createOrUpdate API route later, we propose the following:

• remove the updateIfExist option
• add a ifExist option, taking the following values: error (default), replace

implement queryError event

should be raised when query received an error from kuzzle

Fix scroll action and next on searchResult

See fix for JS SDK: kuzzleio/sdk-javascript#172

Add the new `refresh` option for create/createOrReplace/update/replace/delete routes

linked to kuzzleio/kuzzle#532

Align routing with recent http route changes

Expose the new route users/_createRestricted in the SDK

Rename advancedSearch -> search

Implement the scroll API

Allow to connect to Kuzzle via SSL

For the time being, the php sdk forces an http only connection.

We should give the ability to connect to ssl.
Additional configuration options are very likely to be required too:

At the very minimum:

• ssl version support
• certificate check (CURLOPT_SSL_VERIFYPEER)

Other CURLOPT_SSLxx may also be required.

Adapt to the Request model refactor

See kuzzleio/kuzzle#559 for more details.

body of the Request is the body of the resource, arguments of GET routes are provided in the url (or as query parameters), etc.

should be done at the same time or before #34

Implement unsetJwtToken

unsetJwtToken

• should be called on logout
• should unsubscribe to all active rooms

In SearchResult, previous and next features induce a serious memory leak

implement unsetJwtToken

unsetJwtToken

• should be called on logout
• should unsubscribe to all active rooms

Adapt to the Controller refactor

See kuzzleio/kuzzle#569 for more details.

(adaptation already done in kuzzleio/sdk-javascript#152)

should be done at the same time or after #35

Remove administration-centered methods

Add from and size parameters in the listCollections method

linked to kuzzleio/kuzzle#518

Problem with search after bulk import

I have imported my data into back-office from a bulk import in Postman.

Here's an exemple of document (in JSON format):

{
  "type": "Feature",
  "messier_id": "M1",
  "messier_order": 1,
  "properties": {
    "name": "M1",
    "desig": "NGC 1952",
    "alt": "Crab Nebula",
    "alt_fr": "Nébuleuse du crabe",
    "type": "snr",
    "type_label": "Supernova Remnant",
    "mag": 8.4,
    "const_id": "TAU",
    "dim": "6x4",
    "cl": ""
  },
  "geometry": {
    "type": "Point",
    "coordinates": [
      83.625,
      22.0167
    ]
  }
}

All my documents created with bul aven't got "meta" property. So, with kuzzle-php-sdk, when i make a search(), i have this error :

ContextErrorExceptionNotice: Undefined index: _meta
--
in Collection.php (line 70)

Implement queryError event

should be raised when query received an error from kuzzle

CreateDocument does not generate an id

When using createDocument method, the id is not automatically generated. Instead a string ':_id' is used as ID of document

Expected Behavior

A UUIDV4 as documentID

Current Behavior

string '_id' as documentID

Possible Solution

Steps to Reproduce

1. Setup SDK PHP
2. Get a collection object
3. Try to create a document without providing the second parameter 'id'

Context (Environment)

Kuzzle 1.5
SDK PHP 3.0.4

Move CI to cross-repo doc build & deploy

Like it has been done in the Dart SDK

Branches (not on GitHub Actions)

• master
• 3-dev

fetchAllDocuments handles a "parse exception"

While using fetchAllDocuments, we have following exception from Kuzzle:
"[parse_exception] Failed to derive xcontent"