Manager
Class manages of orders's archiving, restoring entries from database
Table of Contents
Constants
Methods
- archiveByOptions() : Result
- Archive orders that are selected by module's settings.
- archiveOnAgent() : string
- Used in agents. Manage execution of agent.
- archiveOrders() : Result
- Archive orders by filter
- delete() : DeleteResult
- Delete archived order with archived basket items.
- getBasketFieldNames() : array<string|int, mixed>
- getBasketItemById() : Result
- Get entry of basket item from archive by id.
- getBasketList() : Result
- Get entries of basket items from archive.
- getById() : Result
- Get entry of order from archive by entry's id.
- getList() : Result
- getOrderFieldNames() : array<string|int, mixed>
- returnArchivedOrder() : Order
- Return Archive\Order object restored from archive
Constants
SALE_ARCHIVE_VERSION
public
mixed
SALE_ARCHIVE_VERSION
= 2
Methods
archiveByOptions()
Archive orders that are selected by module's settings.
public
static archiveByOptions([int $limit = null ][, int $timeExecution = null ]) : Result
Used in agents.
Parameters
- $limit : int = null
-
Limit the selection orders.
- $timeExecution : int = null
-
Limits the maximum execution time.
Tags
Return values
ResultarchiveOnAgent()
Used in agents. Manage execution of agent.
public
static archiveOnAgent(int $limit[, int $maxTime = null ]) : string
Parameters
- $limit : int
-
Limit the selection orders.
- $maxTime : int = null
-
Maximum execution time of agent.
Tags
Return values
stringarchiveOrders()
Archive orders by filter
public
static archiveOrders([array<string|int, mixed> $filter = array() ][, int $limit = null ][, int $timeExecution = null ]) : Result
Parameters
- $filter : array<string|int, mixed> = array()
-
Filter the selection.
- $limit : int = null
-
Limit the selection orders.
- $timeExecution : int = null
-
Limits the maximum execution time.
Tags
Return values
Result —$result
delete()
Delete archived order with archived basket items.
public
static delete(int $id) : DeleteResult
Parameters
- $id : int
Tags
Return values
DeleteResultgetBasketFieldNames()
public
static getBasketFieldNames() : array<string|int, mixed>
Return values
array<string|int, mixed>getBasketItemById()
Get entry of basket item from archive by id.
public
static getBasketItemById(int $id) : Result
Parameters
- $id : int
Tags
Return values
ResultgetBasketList()
Get entries of basket items from archive.
public
static getBasketList([array<string|int, mixed> $parameters = array() ]) : Result
Parameters
- $parameters : array<string|int, mixed> = array()
Tags
Return values
ResultgetById()
Get entry of order from archive by entry's id.
public
static getById(int $id) : Result
Parameters
- $id : int
Return values
ResultgetList()
public
static getList([array<string|int, mixed> $parameters = array() ]) : Result
Parameters
- $parameters : array<string|int, mixed> = array()
Return values
ResultgetOrderFieldNames()
public
static getOrderFieldNames() : array<string|int, mixed>
Return values
array<string|int, mixed>returnArchivedOrder()
Return Archive\Order object restored from archive
public
static returnArchivedOrder(int $id) : Order
Parameters
- $id : int
-
Entity's id.