Interface OrderListGeneratorInterface

Interface OrderListGeneratorInterface

Direct known implementers

OrderListGenerator

Package: Order\Interfaces
Category: System
Located at Services/Core/Order/Interfaces/OrderListGeneratorInterface.inc.php

Methods summary

`public OrderListItemCollection`	# `getOrderListByConditions( string\|array $conditions = array(), IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )` Get Order List Items Get Order List Items Returns an order list item collection. Parameters `$conditions` Provide a WHERE clause string or an associative array (actually any parameter that is acceptable by the "where" method of the CI_DB_query_builder method). `$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 `OrderListItemCollection` Throws InvalidArgumentException If the result rows contain invalid values.
`public OrderListItemCollection`	# `getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )` Filters records by a single keyword string. Filters records by a single keyword string. Parameters `$keyword` Keyword string to be used for searching in order records. `$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 `OrderListItemCollection` Order list item collection.
`public OrderListItemCollection`	# `filterOrderList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )` Filter order list items by the provided parameters. Filter order list items by the provided parameters. The following slug names need to be used: - number => orders.orders_id - customer => orders.customers_lastname orders.customers_firstname - group => orders.customers_status_name - sum => orders_total.value - payment => orders.payment_method - shipping => orders.shipping_method - countryIsoCode => orders.delivery_country_iso_code_2 - date => orders.date_purchased - 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 `OrderListItemCollection`
`public integer`	# `filterOrderListCount( array $filterParameters )` Get the filtered orders count. Get the filtered orders count. This number is useful for pagination functionality where the app needs to know the number of the filtered rows. Parameters `$filterParameters` Returns integer Throws BadMethodCallException