Interface InvoiceListGeneratorInterface
Interface InvoiceListGeneratorInterface
Methods summary
public
getInvoiceListByConditions( array $conditions = [], IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
: InvoiceListItemCollection
Returns an invoice list item collection by the given conditions.
The other arguments helps to control fetched data.
Returns an invoice list item collection by the given conditions.
The other arguments helps to control fetched data.
Parameters
$conditions- (Optional) Conditions for tht where clause.
$startIndex- (Optional) Start index for the limit clause.
$maxCount- (Optional) Max count for the limit clause.
$orderBy- (Optional) Sort order of fetched data.
Returns
public
filterInvoiceList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
: InvoiceListItemCollection
Filter invoice list items by the provided parameters.
Filter invoice list items by the provided parameters.
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- Contains the column slug-names and their values.
$startIndex- The start index of the wanted array to be returned (default = null).
$maxCount- Maximum amount of items which should be returned (default = null).
$orderBy- A string which defines how the items should be ordered (default = null).
Returns
Throws
BadMethodCallException
InvalidArgumentException
public
filterInvoiceListCount( array $filterParameters )
: integer
Get the filtered invoice count.
Get the filtered invoice count.
This number is useful for pagination functionality where the app needs to know the number of the filtered rows.
Parameters
Returns
integer
Throws
BadMethodCallException