SDK
SDK PHP v3.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

fetchDocument #

Retrieves a single stored document using its unique document ID, and returns it as a Document object.


fetchDocument(documentId, [options], callback) #

ArgumentsTypeDescription
documentIdstringUnique document identifier
optionsJSON ObjectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns a Document object.

Usage #

<?php
use \Kuzzle\Kuzzle;
use \Kuzzle\Document;
$documentId = 'foobar';
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
try {
  $document = $dataCollection->fetchDocument($documentId);
  // $document instanceof Document
}
catch (ErrorException $e) {
}