ticket.md

Ticket

We handle most task asynchronously and to follow all tasks we have created a system of ticketing.
A ticket represent a unitary task in our system and will contain the task timings and a current state.

Access

To get a ticket detail you need to call ticket API like so :

<?php
$ticketApi = $session->getMainStore()->getTicketApi();

$ticket = $ticketApi->getOne('abc123def456ghi789');
$ticket->getStatus();

Batch

When an task is requested we create a batch, a batch is a list of ticket of all operation needed for this task.
A batch ID is then returned to the user to be able to retrieve all tickets needed to handle the requested task.

<?php
$ticketApi = $session->getMainStore()->getTicketApi();
$tickets   = $ticketApi->getByBatch('987ihg654fed321cba');

// Check global status of the batch based on all ticket status
if ($tickets->isBeingProcessed()) {
    // wait for all are processed...
}

// Or wait (60 seconds) until all tickets are processed
$processed = $tickets->wait(60);

foreach ($processed as $ticket) {
    $ticket->getStatus();
}