DataService/Batch.php

Show:

inherited

Classes
- \Batch
- \OperationEnum

Table of Contents

Package: Default

\Batch
jump to top

Package: Default

This class contains code for Batch Processing.

Properties

array $batchRequests

batch requests

Details

Type: array

array $batchResponses

batch responses

Details

Type: array

array $intuitBatchItemResponses

Intuit batch item responses list.

Details

Type: array

\IEntitySerializer $responseSerializer

serializer to be used.

Details

Type: \IEntitySerializer

\IRestHandler $restHandler

rest handler object.

Details

Type: \IRestHandler

\ServiceContext $serviceContext

service context object.

Details

Type: \ServiceContext

Methods

AddEntity( $entity, $id, $operation) : void

Adds the specified query.

Parameters

Name	Type	Description
$entity
$id
$operation

AddQuery(string $query, string $id) : void

Adds the specified query.

Parameters

Name	Type	Description
$query	string	IDS query.
$id	string	unique batchitem id.

Count() : integer

Gets the count.

Returns

Type	Description
integer	count

Execute() : void

This method executes the batch request.

IntuitBatchResponse(string $id) : void

Gets the IntuitBatchResponse with the specified id.

Parameters

Name	Type	Description
$id	string	unique batchitem id

IterateFaultAndPrepareException( $fault) : \IdsException

Prepare IdsException out of Fault object.

Parameters

Name	Type	Description
$fault

Returns

Type	Description
\IdsException	IdsException object.

ProcessBatchItemResponse( $oneXmlObj) : \IntuitBatchResponse

process batch item response

Parameters

Name	Type	Description
$oneXmlObj

Returns

Type	Description
\IntuitBatchResponse	IntuitBatchResponse object.

ReadOnlyCollection() : void

Gets list of entites in case ResponseType is Report.

Remove( $id) : void

Removes batchitem with the specified batchitem id.

Parameters

Name	Type	Description
$id

RemoveAll() : void

Remove all the batchitem requests.

__construct( $serviceContext, $restHandler) : void

Initializes a new instance of the Batch class.

Parameters

Name	Type	Description
$serviceContext		The service context.
$restHandler		The rest handler.

applyAttributes(\IntuitBatchResponse $batchResponse, \SimpleXMLElement $simpleXML) : void

Maps some values from the response xml to the result instance object

Parameters

Name	Type	Description
$batchResponse	\IntuitBatchResponse
$simpleXML	\SimpleXMLElement

arrayToMessageAndCode( $array) : void

Parameters

Name	Type	Description
$array

collectErrors( $fault) : void

Parameters

Name	Type	Description
$fault

getRestHandler() : \SyncRestHandler

Returns handler to communicate with service

Returns

Type	Description
\SyncRestHandler

verifyFault( $fault) : void

Parameters

Name	Type	Description
$fault

\OperationEnum
jump to top

Package: Default

Describes operations that can be included in a batch

Constants

string 
                create
                = "create"

create Operation

create: string

create

string 
                update
                = "update"

update Operation

update: string

update

string 
                sparseupdate
                = "sparse update"

sparse update Operation

sparseupdate: string

sparseupdate

string 
                delete
                = "delete"

delete Operation

delete: string

delete

string 
                void
                = "void"

void Operation

void: string

void

string 
                query
                = "query"

query Operation

query: string

query

string 
                report
                = "report"

report Operation

report: string

report

DataService/Batch.php

\Batchjump to top

Properties

Methods

\OperationEnumjump to top

Constants

\Batch
jump to top

\OperationEnum
jump to top