Provides batching functionality
| package | ArangoDBClient |
|---|---|
| since | 1.1 |
__construct(\ArangoDBClient\Connection $connection, array $options = array())
To disable this, pass startCapture=>false inside the options array parameter
\ArangoDBClient\Connectionthat this batch class will monitor for requests in order to batch them. Connection parameter is mandatory.
arrayAn array of options for Batch construction. See below for options:
Options are :
activate() : \ArangoDBClient\Batch
\ArangoDBClient\Batch$thisappend(mixed $method, mixed $request) : \ArangoDBClient\HttpResponse
mixedmixed\ArangoDBClient\ClientException |
|---|
\ArangoDBClient\HttpResponsecountParts() : integer
integer$countgetActive(\ArangoDBClient\Connection $connection) : \ArangoDBClient\Batch
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
\ArangoDBClient\Connection
\ArangoDBClient\BatchgetBatchParts() : array
array$_batchPartsgetConnection() : \ArangoDBClient\Connection
\ArangoDBClient\ConnectiongetConnectionCaptureMode(\ArangoDBClient\Connection $connection) : boolean
\ArangoDBClient\Connection
booleangetPart(mixed $partId) : mixed
..n) or its id (if it was set with nextBatchPartId($id) )
mixedthe batch part id. Either it's numeric key or a given name.
\ArangoDBClient\ClientException |
|---|
mixed$batchPartgetPartResponse(mixed $partId) : mixed
..n) or its id (if it was set with nextBatchPartId($id) )
mixedthe batch part id. Either it's numeric key or a given name.
\ArangoDBClient\ClientException |
|---|
mixed$partIdgetProcessedPartResponse(mixed $partId) : mixed
..n) or its id (if it was set with nextBatchPartId($id) )
mixedthe batch part id. Either it's numeric key or a given name.
\ArangoDBClient\ClientException |
|---|
mixed$partIdisActive() : boolean
booleanisCapturing() : boolean
booleannextBatchPartCursorOptions(mixed $batchPartCursorOptions) : \ArangoDBClient\Batch
mixed
\ArangoDBClient\BatchnextBatchPartId(mixed $batchPartId) : \ArangoDBClient\Batch
mixed
\ArangoDBClient\Batchprocess() : \ArangoDBClient\HttpResponse | \ArangoDBClient\Batch
\ArangoDBClient\ClientException |
|
|---|---|
\ArangoDBClient\Exception |
\ArangoDBClient\HttpResponse\ArangoDBClient\Batch- Batch if processing of the batch was successful or the HttpResponse object in case of a failure. A successful process just means that tha parts were processed. Each part has it's own response though and should be checked on its own.setActive() : \ArangoDBClient\Batch
\ArangoDBClient\Batch$thissetCapture(boolean $state) : \ArangoDBClient\Batch
boolean
\ArangoDBClient\Batch$thissetConnection(\ArangoDBClient\Connection $connection) : \ArangoDBClient\Batch
\ArangoDBClient\Connection
\ArangoDBClient\BatchsetDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
stringDocument class to use
\ArangoDBClient\DocumentClassablesetEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
stringEdge class to use
\ArangoDBClient\DocumentClassablesplitWithContentIdKey(mixed $pattern, mixed $string) : array
mixed
mixed
\ArangoDBClient\ClientException |
|---|
array$array - Array of batch-partsstartCapture() : \ArangoDBClient\Batch
see ArangoDBClient\Batch::stopCapture()
\ArangoDBClient\BatchstopCapture() : \ArangoDBClient\Batch
see Batch::startCapture()
\ArangoDBClient\ClientException |
|---|
\ArangoDBClient\BatchgetCursorOptions() : array
array- array of optionssetBatchRequest(boolean $state) : \ArangoDBClient\Batch
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
boolean
\ArangoDBClient\Batch$_batchResponse : \ArangoDBClient\HttpResponse
$_documentClass : string
'\ArangoDBClient\Document'$_edgeClass : string
'\ArangoDBClient\Edge'$_batchPartCursorOptions : array
array()$_batchParts : array
array()$_connection : \ArangoDBClient\Connection
$_nextBatchPartId : integer | string
$_nextId : integer | string
0$_processed : boolean
false$_sanitize : boolean
false