Class OrderListGenerator


				
				 public 
				
				

				__construct( CI_DB_query_builder $db, PaymentTitleProvider $paymentTitleProvider, ShippingTitleProvider $shippingTitleProvider )

OrderListGenerator Constructor


				
				 public 
				
				

				getOrderListByConditions( string|array $conditions = [], IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

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.

Link

http://www.codeigniter.com/user_guide/database/query_builder.html#looking-for-specific-data

Implementation of

OrderListGeneratorInterface::getOrderListByConditions()


				
				 public 
				
				

				filterOrderList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

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 - totalWeight => orders.order_total_weight

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

Throws

BadMethodCallException
InvalidArgumentException

Implementation of

OrderListGeneratorInterface::filterOrderList()


				
				 public 
				
				

				filterOrderListCount( array $filterParameters )
				

				: integer

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

Implementation of

OrderListGeneratorInterface::filterOrderListCount()


				
				 public 
				
				

				getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: mixed

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

Throws

InvalidArgumentException
If the result rows contain invalid values.

Implementation of

OrderListGeneratorInterface::getOrderListByKeyword()


				
				 public 
				
				

				getOrderListByKeywordCount( StringType $keyword )
				

				: integer

Get count of orders filtered by keyword


				
				 public 
				
				

				getOrderListCount( void )
				

				: integer

Get the total count of all orders


				
				 protected 
				
				

				_select( void )
				

				: OrderListGenerator

Execute the select and join methods.


				
				 protected 
				
				

				_setKeywordWhereClause( StringType $keyword )


				
				 protected 
				
				

				_ordersColumns( void )
				

				: string

Returns a string for the ::_select() method which contains column names of the orders table.


				
				 protected 
				
				

				_ordersStatusColumns( void )
				

				: string

Returns a string for the ::_select() method which contains column names of the orders status table.


				
				 protected 
				
				

				_ordersTotalColumns( void )
				

				: string

Returns a string for the ::_select() method which contains column names of the orders total table.


				
				 protected 
				
				

				_addressColumns( string $type )
				

				: string

Returns a string for the ::_select() method which contains column names of the orders table for address data.


				
				 protected 
				
				

				_customersStatusColumns( void )
				

				: string

Returns a string for the ::_select() method which contains fallback customer status name if no value is set in the orders table.


				
				 protected 
				
				

				_invoicesColumns( void )
				

				: string

Returns a string for the ::_select() method which contains fallback implosion of all invoice IDs of the order if no value is set in the orders table.


				
				 protected 
				
				

				_createOrderAddressBlockByRow( string $type, array $row )
				

				: OrderAddressBlock

Creates an order address block object by the given type and row_array (looped result of CIDB::result_array())

Parameters

$type: Whether delivery or billing.
$row: Array which contain data about an order result row.

Returns

OrderAddressBlock

Throws

BadMethodCallException


				
				 protected 
				
				

				_limit( IntType $startIndex = null, IntType $maxCount = null )
				

				: OrderListGenerator

Add limit configuration to the database object.


				
				 protected 
				
				

				_order( StringType $orderBy = null )
				

				: OrderListGenerator

Set the order by clause of the query.


				
				 protected 
				
				

				_group( void )
				

				: OrderListGenerator

Execute the group by statement.


				
				 protected 
				
				

				_prepareCollection( array $result )
				

				: OrderListItemCollection

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

Throws

InvalidArgumentException


				
				 protected 
				
				

				_createOrderPaymentType( array $row )
				

				: OrderPaymentType

Creates and returns an order payment type instance by the given row data.


				
				 protected 
				
				

				_createOrderShippingType( array $row )
				

				: OrderShippingType

Creates and returns an order shipping type instance by the given row data.


				
				 protected 
				
				

				_createOrderType( string $type, array $row )
				

				: OrderShippingType|OrderPaymentType

Creates and returns whether an order shipping or payment type instance by the given row data and type argument.

Parameters

$type: Whether 'shipping' or 'payment', used to determine the expected order type class.
$row: Row array with data about the order type.

Returns

OrderShippingType|OrderPaymentType

Throws

InvalidArgumentException


				
				 protected 
				
				

				_getPaymentOrShippingTitle( string $method, string $type )
				

				: string

Returns the title of the given payment or shipping title.


				
				 protected 
				
				

				_createMemoCollectionByCustomersId( integer $customersId )
				

				: CustomerMemoCollection

Creates and returns a customer memo collection by the given customers id.


				
				 protected 
				
				

				_createTrackingLinksByOrderId( integer $orderId )
				

				: StringCollection

Creates and returns a string collection which contains the tracking links of the order.


				
				 protected 
				
				

				_createWithdrawalIdsByOrderId( integer $orderId )
				

				: IdCollection

Creates and returns a ID collection which contains the withdrawal ids of the order.


				
				 protected 
				
				

				_createInvoiceNumberCollectionByOrderId(  $orderId )
				

				: StringCollection

Creates and returns a string collection which contains the invoice numbers of the order


				
				 protected 
				
				

				_filter( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: CI_DB_result

Filter the order records.

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

CI_DB_result


				
				 protected 
				
				

				_setFilterArguments( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListGeneratorInterface

Set the where clauses for the filtered order records query.

This method contains the filtering logic. It can be overloaded in order to provide a custom filtering logic.

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

OrderListGeneratorInterface
Same instance for chained method calls.

Throws

BadMethodCallException

Class OrderListGenerator

Methods summary

Parameters

Parameters

Returns

Throws

Link

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Throws

Parameters

Returns

Returns

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Constants summary

Properties summary