SDK
SDK PHP v3.x
1

collection #

Instantiates a new Collection object.


collection(collection, [index]) #

Arguments Type Description
collection string The name of the collection you want to manipulate
index string The name of the index containing the collection

If no index is provided, the factory will take the default index set in the main Kuzzle SDK instance. If no default index has been set, an error is thrown.

The index argument takes precedence over the default index.


Return Value #

Returns a Collection object.

Usage #

Copied to clipboard!
<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
// or using a default index:
$kuzzle = new Kuzzle('localhost', [
  'defaultIndex' => 'some index'
]);
$dataCollection = $kuzzle->collection('collection', 'index');