CSMessageQueueBatch
in package
implements
IteratorAggregate
This class defines the CSMessageQueueBatch API
It provides the general implementation / interface of message queue batches.
Tags
Interfaces, Classes and Traits
- IteratorAggregate
Table of Contents
- __construct() : void
- Instantiates the current batch object with an id and the corresponding message ids.
- getBatchId() : string
- Returns the current batch id.
- getIterator() : mixed
- IteratorAggregate interface method.
Methods
__construct()
Instantiates the current batch object with an id and the corresponding message ids.
public
__construct(string $sBatchId, array<string|int, mixed> $aIds) : void
Parameters
- $sBatchId : string
-
The current batch id.
- $aIds : array<string|int, mixed>
-
The list of message ids belonging to this batch.
Tags
Return values
void —getBatchId()
Returns the current batch id.
public
getBatchId() : string
Tags
Return values
string —The current batch id.
getIterator()
IteratorAggregate interface method.
public
getIterator() : mixed
Note: Return type will change to Traversable.