Class OrderListGenerator

Class OrderListGenerator

OrderListGenerator implements OrderListGeneratorInterface

Package: Order
Category: System
Located at CoreServices/Order/OrderListGenerator.inc.php

Methods summary

`public`	# `__construct( CI_DB_query_builder $db )` OrderListGenerator Constructor OrderListGenerator Constructor Parameters `$db`
`public OrderListItemCollection`	# `getOrderListByConditions( 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` Associative array which holds the CI_DB_query_builder conditions (default empty array). `$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` Implementation of `OrderListGeneratorInterface::getOrderListByConditions()`
`public mixed`	# `getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )` Filter records by a single keyword string. Filter 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 mixed Implementation of `OrderListGeneratorInterface::getOrderListByKeyword()`
`protected OrderListGenerator`	# `_select( )` Execute the select and join methods. Execute the select and join methods. Returns `OrderListGenerator` Returns the instance object for method chaining.
`protected OrderListGenerator`	# `_limit( IntType $startIndex = null, IntType $maxCount = null )` Add limit configuration to the database object. Add limit configuration to the database object. Parameters `$startIndex` `$maxCount` Returns `OrderListGenerator` Returns the instance object for method chaining.
`protected OrderListGenerator`	# `_order( StringType $orderBy = null )` Set the order by clause of the query. Set the order by clause of the query. Parameters `$orderBy` Returns `OrderListGenerator` Returns the instance object for method chaining.
`protected OrderListGenerator`	# `_group( )` Execute the group by statement. Execute the group by statement. Returns `OrderListGenerator` Returns the instance object for method chaining.
`protected OrderListItemCollection`	# `_prepareCollection( array $result )` Prepare the OrderListItemCollection object. Prepare the OrderListItemCollection object. This method will prepare the collection object which is going to be returned by both the "get" and "filter" methods. The following values are required to be present in each row of the $result parameter: - orders_id - customers_id - customers_firstname - customers_lastname - date_purchased - payment_class - payment_method - shipping_class - shipping_method - orders_status_id - orders_status_name - total_sum Parameters `$result` Contains the order data. Returns `OrderListItemCollection`

Properties summary

`protected CI_DB_query_builder`	`$db`	#