phpDocumentor

InvoicesOverviewColumns
in package

Class InvoicesOverviewColumns

This class contains the definition of the invoices overview columns. Use it in every controller that needs the column definition.

This class can be overloaded and more table columns can be added.

Tags
category

System

subpackage

Invoices

Table of Contents

$columns  : array<string|int, mixed>
$db  : CI_DB_query_builder
$noValuePlaceholder  : string
__construct()  : mixed
OrdersOverviewColumns constructor
_getGroupOptions()  : array<string|int, mixed>
Get the customer group filtering options.
_getPaymentOptions()  : array<string|int, mixed>
Get the payment method filtering options.
_getStatusOptions()  : array<string|int, mixed>
Get the order status filtering options.
getColumns()  : DataTableColumnCollection
Get the DataTableColumnCollection of the table.
serializeColumns()  : array<string|int, mixed>
Get the column definitions in a plain array.
_getCountryOptions()  : array<string|int, mixed>
Get the country filtering options.
_getMultiSelectOptions()  : array<string|int, mixed>
Convert the option to [value, text] arrays.

Properties

Methods

__construct()

OrdersOverviewColumns constructor

public __construct(CI_DB_query_builder $db) : mixed

Overload this method and append the $columns array with new column definitions.

Parameters
$db : CI_DB_query_builder

Will be used for database operations.

Tags
throws
InvalidArgumentException
Return values
mixed

_getGroupOptions()

Get the customer group filtering options.

public _getGroupOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

_getPaymentOptions()

Get the payment method filtering options.

public _getPaymentOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

_getStatusOptions()

Get the order status filtering options.

public _getStatusOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

serializeColumns()

Get the column definitions in a plain array.

public serializeColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>

_getCountryOptions()

Get the country filtering options.

protected _getCountryOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

_getMultiSelectOptions()

Convert the option to [value, text] arrays.

protected _getMultiSelectOptions(array<string|int, mixed> $options) : array<string|int, mixed>

The result of this method can be given back to multi_select widgets. If an option has different value and text then the first entry must always be the value and the second the text to be displayed.

Parameters
$options : array<string|int, mixed>

Contains the options of the multi_select widget.

Return values
array<string|int, mixed>

Search results