ArangoDB-PHP API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • triagens
    • ArangoDb

Classes

  • AdminHandler
  • AqlUserFunction
  • Autoloader
  • Batch
  • BatchPart
  • BindVars
  • Collection
  • CollectionHandler
  • Connection
  • ConnectionOptions
  • Cursor
  • Database
  • DefaultValues
  • Document
  • DocumentHandler
  • Edge
  • EdgeDefinition
  • EdgeHandler
  • Endpoint
  • Export
  • ExportCursor
  • Graph
  • GraphHandler
  • Handler
  • HttpHelper
  • HttpResponse
  • QueryCacheHandler
  • QueryHandler
  • Statement
  • TraceRequest
  • TraceResponse
  • Transaction
  • Traversal
  • UpdatePolicy
  • UrlHelper
  • Urls
  • User
  • UserHandler
  • ValueValidator
  • Vertex
  • VertexHandler

Exceptions

  • ClientException
  • ConnectException
  • Exception
  • ServerException

Class BatchPart

Provides batch part functionality


Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 1.1
Located at BatchPart.php

Methods summary

public
# __construct( triagens\ArangoDb\Batch $batch, mixed $id, mixed $type, mixed $request, mixed $response, mixed $options )

Constructor

Constructor

Parameters

$batch
the batch object, that this part belongs to
$id
The id of the batch part. TMust be unique and wil be passed to the server in the content-id header
$type
The type of the request. This is to distinguish the different request type in order to return correct results.
$request
The request string
$response
The response string
$options
optional, options like sanitize, that can be passed to the request/response handler.
public triagens\ArangoDb\BatchPart
# setBatch( triagens\ArangoDb\Batch $batch )

Sets the id for the current batch part.

Sets the id for the current batch part.

Parameters

$batch

Returns

triagens\ArangoDb\BatchPart
public triagens\ArangoDb\BatchPart
# setId( mixed $id )

Sets the id for the current batch part.

Sets the id for the current batch part.

Parameters

$id

Returns

triagens\ArangoDb\BatchPart
public mixed
# getId( )

Gets the id for the current batch part.

Gets the id for the current batch part.

Returns

mixed
public triagens\ArangoDb\BatchPart
# setType( mixed $type )

Sets the type for the current batch part.

Sets the type for the current batch part.

Parameters

$type

Returns

triagens\ArangoDb\BatchPart
public mixed
# getType( )

Gets the type for the current batch part.

Gets the type for the current batch part.

Returns

mixed
public triagens\ArangoDb\BatchPart
# setRequest( mixed $request )

Sets the request for the current batch part.

Sets the request for the current batch part.

Parameters

$request

Returns

triagens\ArangoDb\BatchPart
public array
# getRequest( )

Gets the request for the current batch part.

Gets the request for the current batch part.

Returns

array
public triagens\ArangoDb\BatchPart
# setResponse( mixed $response )

Sets the response for the current batch part.

Sets the response for the current batch part.

Parameters

$response

Returns

triagens\ArangoDb\BatchPart
public triagens\ArangoDb\HttpResponse
# getResponse( )

Gets the response for the current batch part.

Gets the response for the current batch part.

Returns

triagens\ArangoDb\HttpResponse
public integer
# getHttpCode( )

Gets the HttpCode for the current batch part.

Gets the HttpCode for the current batch part.

Returns

integer
public mixed
# getProcessedResponse( )

Get the batch part identified by the array key (0...n) or its id (if it was set with nextBatchPartId($id) )

Get the batch part identified by the array key (0...n) or its id (if it was set with nextBatchPartId($id) )

Returns

mixed
$partId

Throws

triagens\ArangoDb\ClientException
ArangoDB-PHP API Documentation API documentation generated by ApiGen