Provides batch part functionality

package ArangoDBClient
since 1.1

 Methods

Constructor

__construct(\ArangoDBClient\Batch $batch, mixed $id, mixed $type, mixed $request, mixed $response, mixed $options) 

Parameters

$batch

\ArangoDBClient\Batch

the batch object, that this part belongs to

$id

mixed

The id of the batch part. TMust be unique and wil be passed to the server in the content-id header

$type

mixed

The type of the request. This is to distinguish the different request type in order to return correct results.

$request

mixed

The request string

$response

mixed

The response string

$options

mixed

optional, options like sanitize, that can be passed to the request/response handler.

Gets the HttpCode for the current batch part.

getHttpCode() : integer

Returns

integer

Gets the id for the current batch part.

getId() : mixed

Returns

mixed

Get the batch part identified by the array key (0.

getProcessedResponse() : mixed

..n) or its id (if it was set with nextBatchPartId($id) )

Exceptions

\ArangoDBClient\ClientException

Returns

mixed$partId

Gets the request for the current batch part.

getRequest() : array

Returns

array

Gets the response for the current batch part.

getResponse() : \ArangoDBClient\HttpResponse

Returns

\ArangoDBClient\HttpResponse

Gets the type for the current batch part.

getType() : mixed

Returns

mixed

Sets the id for the current batch part.

setBatch(\ArangoDBClient\Batch $batch) : \ArangoDBClient\BatchPart

Parameters

$batch

\ArangoDBClient\Batch

Returns

\ArangoDBClient\BatchPart

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
Inherited

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\DocumentClassable

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
Inherited

Parameters

$class

string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

Sets the id for the current batch part.

setId(mixed $id) : \ArangoDBClient\BatchPart

Parameters

$id

mixed

Returns

\ArangoDBClient\BatchPart

Sets the request for the current batch part.

setRequest(mixed $request) : \ArangoDBClient\BatchPart

Parameters

$request

mixed

Returns

\ArangoDBClient\BatchPart

Sets the response for the current batch part.

setResponse(mixed $response) : \ArangoDBClient\BatchPart

Parameters

$response

mixed

Returns

\ArangoDBClient\BatchPart

Sets the type for the current batch part.

setType(mixed $type) : \ArangoDBClient\BatchPart

Parameters

$type

mixed

Returns

\ArangoDBClient\BatchPart

Return an array of cursor options

getCursorOptions() : array

Returns

array- array of options

 Properties

 

Document class to use

$_documentClass : string

Default

'\ArangoDBClient\Document'
 

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'
 

The batch that this instance is part of

$_batch : \ArangoDBClient\Batch

Default

 

An array of BatchPartCursor options

$_cursorOptions : array

Default

array()
 

An array of BatchPartCursor options

$_id : array

Default

 

An array of BatchPartCursor options

$_request : array

Default

array()
 

An array of BatchPartCursor options

$_response : \ArangoDBClient\HttpResponse

Default

array()
 

An array of BatchPartCursor options

$_type : array

Default