class Listing extends AbstractOrderList implements IOrderList (View source)

Properties

protected int $offset from AbstractOrderList
protected int $limit from AbstractOrderList
protected int $rowCount from AbstractOrderList
protected string $listType from AbstractOrderList
protected string $orderState from AbstractOrderList
protected ArrayIterator $list from AbstractOrderList
protected string $itemClassName from AbstractOrderList
protected QueryBuilder $query
protected IOrderListFilter[] $filter
protected bool $useSubItems

Methods

string
getItemClassName()

No description

$this
setItemClassName(string $className)

No description

createResultItem(array $row)

No description

setListType(string $type)

No description

string
getListType()

No description

string
getOrderState()

No description

setOrderState(string $orderState)

No description

load()

No description

AdapterInterface
getPaginatorAdapter()

Return a fully configured Paginator Adapter from this method.

getItems(int $offset, int $itemCountPerPage)

Returns an collection of items for a page.

int
getOffset()

No description

setLimit(int $limit, int $offset = 0)

No description

int
getLimit()

No description

IOrderListItem
current()

(PHP 5 >= 5.0.0)
Return the current element

void
next()

(PHP 5 >= 5.0.0)
Move forward to next element

mixed
key()

(PHP 5 >= 5.0.0)
Return the key of the current element

bool
valid()

(PHP 5 >= 5.0.0)
Checks if current position is valid

void
rewind()

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

void
seek(int $position)

(PHP 5 >= 5.1.0)
Seeks to a position

int
count()

(PHP 5 >= 5.1.0)
Count elements of an object

bool
offsetExists(mixed $offset)

(PHP 5 >= 5.0.0)
Whether a offset exists

mixed
offsetGet(mixed $offset)

(PHP 5 >= 5.0.0)
Offset to retrieve

void
offsetSet(mixed $offset, mixed $value)

(PHP 5 >= 5.0.0)
Offset to set

void
offsetUnset(mixed $offset)

(PHP 5 >= 5.0.0)
Offset to unset

getQuery()

get select query

setOrder(string $order)

No description

$this
joinPricingRule()

No description

$this
joinPaymentInfo()

No description

$this
joinOrderItemObjects()

No description

$this
joinProduct(int $classId)

No description

$this
joinCustomer(int $classId)

No description

$this
joinItemsAndSubItems(QueryBuilder $select)

join for item / sub items

$this
addSelectField($field)

No description

$this
addFilter(IOrderListFilter $filter)

No description

$this
addCondition(string $condition, string $value = null)

No description

array
getAvailableFilterValues(string $field) deprecated

get all available values that can bee used for filter

mixed
__clone()

When an object is cloned, PHP 5 will perform a shallow copy of all of the object's properties.

bool
useSubItems()

No description

$this
setUseSubItems(bool $useSubItems)

No description

Details

string getItemClassName()

Return Value

string

$this setItemClassName(string $className)

Parameters

string $className

Return Value

$this

protected IOrderListItem createResultItem(array $row)

Parameters

array $row

Return Value

IOrderListItem

IOrderList setListType(string $type)

Parameters

string $type

Return Value

IOrderList

string getListType()

Return Value

string

string getOrderState()

Return Value

string

IOrderList setOrderState(string $orderState)

Parameters

string $orderState

Return Value

IOrderList

AdapterInterface getPaginatorAdapter()

Return a fully configured Paginator Adapter from this method.

Return Value

AdapterInterface

IOrderListItem[] getItems(int $offset, int $itemCountPerPage)

Returns an collection of items for a page.

Parameters

int $offset Page offset
int $itemCountPerPage Number of items per page

Return Value

IOrderListItem[]

int getOffset()

Return Value

int

IOrderList setLimit(int $limit, int $offset = 0)

Parameters

int $limit
int $offset

Return Value

IOrderList

int getLimit()

Return Value

int

IOrderListItem current()

(PHP 5 >= 5.0.0)
Return the current element

Return Value

IOrderListItem

void next()

(PHP 5 >= 5.0.0)
Move forward to next element

Return Value

void Any returned value is ignored.

mixed key()

(PHP 5 >= 5.0.0)
Return the key of the current element

Return Value

mixed scalar on success, or null on failure.

bool valid()

(PHP 5 >= 5.0.0)
Checks if current position is valid

Return Value

bool The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

void rewind()

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

Return Value

void Any returned value is ignored.

void seek(int $position)

(PHP 5 >= 5.1.0)
Seeks to a position

Parameters

int $position The position to seek to.

Return Value

void

int count()

(PHP 5 >= 5.1.0)
Count elements of an object

Return Value

int The custom count as an integer.

The return value is cast to an integer.

bool offsetExists(mixed $offset)

(PHP 5 >= 5.0.0)
Whether a offset exists

Parameters

mixed $offset An offset to check for.

Return Value

bool true on success or false on failure.

<

p> The return value will be casted to boolean if non-boolean was returned.

mixed offsetGet(mixed $offset)

(PHP 5 >= 5.0.0)
Offset to retrieve

Parameters

mixed $offset The offset to retrieve.

Return Value

mixed Can return all value types.

void offsetSet(mixed $offset, mixed $value)

(PHP 5 >= 5.0.0)
Offset to set

Parameters

mixed $offset The offset to assign the value to.
mixed $value The value to set.

Return Value

void

void offsetUnset(mixed $offset)

(PHP 5 >= 5.0.0)
Offset to unset

Parameters

mixed $offset The offset to unset.

Return Value

void

QueryBuilder getQuery()

get select query

Return Value

QueryBuilder

IOrderList setOrder(string $order)

Parameters

string $order

Return Value

IOrderList

$this joinPricingRule()

Return Value

$this

$this joinPaymentInfo()

Return Value

$this

$this joinOrderItemObjects()

Return Value

$this

$this joinProduct(int $classId)

Parameters

int $classId

Return Value

$this

$this joinCustomer(int $classId)

Parameters

int $classId

Return Value

$this

protected $this joinItemsAndSubItems(QueryBuilder $select)

join for item / sub items

Parameters

QueryBuilder $select

Return Value

$this

$this addSelectField($field)

Parameters

$field

Return Value

$this

$this addFilter(IOrderListFilter $filter)

Parameters

IOrderListFilter $filter

Return Value

$this

$this addCondition(string $condition, string $value = null)

Parameters

string $condition
string $value

Return Value

$this

protected array getAvailableFilterValues(string $field) deprecated

deprecated refactoring

get all available values that can bee used for filter

Parameters

string $field

Return Value

array

mixed __clone()

When an object is cloned, PHP 5 will perform a shallow copy of all of the object's properties.

Any properties that are references to other variables, will remain references. Once the cloning is complete, if a __clone() method is defined, then the newly created object's __clone() method will be called, to allow any necessary properties that need to be changed. NOT CALLABLE DIRECTLY.

Return Value

mixed

bool useSubItems()

Return Value

bool

$this setUseSubItems(bool $useSubItems)

Parameters

bool $useSubItems

Return Value

$this