phpDocumentor

GambioHubOrderListGenerator extends GambioHubOrderListGenerator_parent
in package

Class GambioHubOrderListGenerator

Enables order filtering with Gambio Hub modules and the output of gambio hub payment data.

Table of Contents

_createOrderType()  : OrderShippingType|OrderPaymentType
Creates and returns whether an order shipping or payment type instance by the given row data and type argument.
_ordersColumns()  : string
Returns a string for the ::_select() method which contains column names of the orders table.
_setFilterArguments()  : mixed
Filter the order records.

Methods

_createOrderType()

Creates and returns whether an order shipping or payment type instance by the given row data and type argument.

protected _createOrderType(string $type, array<string|int, mixed> $row) : OrderShippingType|OrderPaymentType
Parameters
$type : string

Whether 'shipping' or 'payment', used to determine the expected order type class.

$row : array<string|int, mixed>

Row array with data about the order type.

Tags
throws
InvalidArgumentException
Return values
OrderShippingType|OrderPaymentType

_ordersColumns()

Returns a string for the ::_select() method which contains column names of the orders table.

protected _ordersColumns() : string
Return values
string

_setFilterArguments()

Filter the order records.

protected _setFilterArguments(array<string|int, mixed> $filterParameters[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : mixed

This method contains the filtering logic. It can be overloaded in order to provide a custom filtering logic.

Parameters
$filterParameters : array<string|int, mixed>
$pager : Pager|null = null
$sorters : array<string|int, mixed> = []
Return values
mixed

Search results