phpDocumentor

InvoiceListGeneratorInterface
in

Interface InvoiceListGeneratorInterface

Tags
category

System

subpackage

Interfaces

Table of Contents

filterInvoiceList()  : InvoiceListItemCollection
Filter invoice list items by the provided parameters.
filterInvoiceListCount()  : int
Get the filtered invoice count.
getInvoiceListByConditions()  : InvoiceListItemCollection
Returns an invoice list item collection by the given conditions.

Methods

filterInvoiceList()

Filter invoice list items by the provided parameters.

public filterInvoiceList(array<string|int, mixed> $filterParameters[, IntType|null $startIndex = null ][, IntType|null $maxCount = null ][, StringType|null $orderBy = null ]) : InvoiceListItemCollection

The following slug names need to be used:

  • invoiceNumber => invoices.invoice_number
  • invoiceDate => invoices.invoice_date
  • sum => invoices.total_sum
  • customer => invoices.billing_firstname invoices.billing_lastname
  • group => invoices.customer_status_name
  • countryIsoCode => invoices.billing_country_iso_code_2
  • orderNumber => invoices.order_id
  • orderDate => invoices.order_date_purchased
  • paymentMethod => invoices.payment_class
  • status => orders_status.orders_status_name
Parameters
$filterParameters : array<string|int, mixed>

Contains the column slug-names and their values.

$startIndex : IntType|null = null

The start index of the wanted array to be returned (default = null).

$maxCount : IntType|null = null

Maximum amount of items which should be returned (default = null).

$orderBy : StringType|null = null

A string which defines how the items should be ordered (default = null).

Tags
throws
BadMethodCallException
throws
InvalidArgumentException
Return values
InvoiceListItemCollection —

filterInvoiceListCount()

Get the filtered invoice count.

public filterInvoiceListCount(array<string|int, mixed> $filterParameters) : int

This number is useful for pagination functionality where the app needs to know the number of the filtered rows.

Parameters
$filterParameters : array<string|int, mixed>
Tags
throws
BadMethodCallException
Return values
int —

getInvoiceListByConditions()

Returns an invoice list item collection by the given conditions.

public getInvoiceListByConditions([array<string|int, mixed> $conditions = [] ][, IntType|null $startIndex = null ][, IntType|null $maxCount = null ][, StringType|null $orderBy = null ]) : InvoiceListItemCollection

The other arguments helps to control fetched data.

Parameters
$conditions : array<string|int, mixed> = []

(Optional) Conditions for tht where clause.

$startIndex : IntType|null = null

(Optional) Start index for the limit clause.

$maxCount : IntType|null = null

(Optional) Max count for the limit clause.

$orderBy : StringType|null = null

(Optional) Sort order of fetched data.

Return values
InvoiceListItemCollection —

Search results