Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController:

Public Member Functions
	getListSorting ()

	getListFilter ()

	getViewListSize ()

	render ()

	deleteEntry ()

	buildWhere ()

	getItemList ()

	clearItemList ()

	getItemListBaseObject ()

Protected Member Functions
	_getViewListSize ()

	_getUserDefListSize ()

	_calcListItemsCount ($sql)

	_setCurrentListPosition ($page=null)

	_prepareOrderByQuery ($query=null)

	_buildSelectString ($listObject=null)

	_processFilter ($fieldValue)

	_buildFilter ($value, $isSearchValue)

	_isSearchValue ($fieldValue)

	_prepareWhereQuery ($whereQuery, $fullQuery)

	_changeselect ($query)

	_convertToDBDate ($value, $fieldType)

	_convertDate ($date)

	_convertTime ($fullDate)

	_setListNavigationParams ()

	_setupNavigation ($node)

Protected Attributes
	$_sListClass = null

	$_sListType = 'oxlist'

	$_oList = null

	$_iCurrListPos = 0

	$_iListSize = 0

	$_aWhere = null

	$_blDesc = false

	$_blEmployMultilanguage = null

	$_iOverPos = null

	$_iViewListSize = 0

	$_iDefViewListSize = 50

	$_aCurrSorting = null

	$_sDefSortField = null

	$_aListFilter = null

Detailed Description

Admin selectlist list manager.

Member Function Documentation

◆ _buildFilter()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_buildFilter	(	$value,
		$isSearchValue
	)

protected

Builds part of SQL query

Parameters

string	$value	filter value
bool	$isSearchValue	filter value type, true means surrount search key with ''

Returns: string

◆ _buildSelectString()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_buildSelectString ( $listObject = null )

protected

Builds and returns SQL query string.

Parameters

object $listObject list main object

Returns: string

◆ _calcListItemsCount()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_calcListItemsCount ( $sql )

protected

Calculates list items count

Parameters

string $sql SQL query used co select list items

◆ _changeselect()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_changeselect ( $query )

protected

Override this for individual search in admin.

Parameters

string $query SQL select to change

Returns: string

◆ _convertDate()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_convertDate ( $date )

protected

Converter for date field search. If not full date will be searched.

Parameters

string $date searched date

Returns: string

◆ _convertTime()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_convertTime ( $fullDate )

protected

Converter for datetime field search. If not full time will be searched.

Parameters

string $fullDate searched date

Returns: string

◆ _convertToDBDate()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_convertToDBDate	(	$value,
		$fieldType
	)

protected

Converts date/datetime values to DB scheme (#M1260)

Parameters

string	$value	Field value
string	$fieldType	Field type

Returns: string

◆ _getUserDefListSize()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_getUserDefListSize ( )

protected

Viewable list size getter (used in list_*.php views)

Returns: int

◆ _getViewListSize()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_getViewListSize ( )

protected

Viewable list size getter

Returns: int

◆ _isSearchValue()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_isSearchValue ( $fieldValue )

protected

Checks if filter contains wildcards like %

Parameters

string $fieldValue filter value

Returns: bool

◆ _prepareOrderByQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_prepareOrderByQuery ( $query = null )

protected

Adds order by to SQL query string.

Parameters

string $query sql string

Returns: string

◆ _prepareWhereQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_prepareWhereQuery	(	$whereQuery,
		$fullQuery
	)

protected

Prepares SQL where query according SQL condition array and attaches it to SQL end. For each search value if german umlauts exist, adds them and replaced by spec. char to query

Parameters

array	$whereQuery	SQL condition array
string	$fullQuery	SQL query string

Returns: string

◆ _processFilter()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_processFilter ( $fieldValue )

protected

Prepares SQL where query according SQL condition array and attaches it to SQL end. For each search value if german umlauts exist, adds them and replaced by spec. char to query

Parameters

string $fieldValue Filters

Returns: string

◆ _setCurrentListPosition()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_setCurrentListPosition ( $page = null )

protected

Set current list position

Parameters

string $page jump page string

◆ _setListNavigationParams()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_setListNavigationParams ( )

protected

Set parameters needed for list navigation

◆ _setupNavigation()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::_setupNavigation ( $node )

protected

Sets-up navigation parameters

Parameters

string $node active view id

◆ buildWhere()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::buildWhere ( )

Builds and returns array of SQL WHERE conditions.

Returns: array

◆ clearItemList()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::clearItemList ( )

Clear items list

◆ deleteEntry()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::deleteEntry ( )

Deletes this entry from the database

Returns: null

◆ getItemList()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::getItemList ( )

Returns items list

Returns: oxList

◆ getItemListBaseObject()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::getItemListBaseObject ( )

Returns item list base object

Returns: oxBase|null

◆ getListFilter()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::getListFilter ( )

Returns list filter array

Returns: array

◆ getListSorting()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::getListSorting ( )

Returns sorting fields array

Returns: array

◆ getViewListSize()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::getViewListSize ( )

Returns view list size

Returns: int

◆ render()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::render ( )

Executes parent::render(), sets back search keys to view, sets navigation params

Returns: null

Member Data Documentation

◆ $_aCurrSorting

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_aCurrSorting = null

protected

◆ $_aListFilter

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_aListFilter = null

protected

◆ $_aWhere

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_aWhere = null

protected

◆ $_blDesc

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_blDesc = false

protected

◆ $_blEmployMultilanguage

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_blEmployMultilanguage = null

protected

◆ $_iCurrListPos

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_iCurrListPos = 0

protected

◆ $_iDefViewListSize

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_iDefViewListSize = 50

protected

◆ $_iListSize

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_iListSize = 0

protected

◆ $_iOverPos

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_iOverPos = null

protected

◆ $_iViewListSize

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_iViewListSize = 0

protected

◆ $_oList

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_oList = null

protected

◆ $_sDefSortField

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_sDefSortField = null

protected

◆ $_sListClass

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_sListClass = null

protected

◆ $_sListType

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminListController::$_sListType = 'oxlist'

protected

The documentation for this class was generated from the following file:

/oxideshop-ce/source/Application/Controller/Admin/AdminListController.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _buildFilter()

◆ _buildSelectString()

◆ _calcListItemsCount()

◆ _changeselect()

◆ _convertDate()

◆ _convertTime()

◆ _convertToDBDate()

◆ _getUserDefListSize()

◆ _getViewListSize()

◆ _isSearchValue()

◆ _prepareOrderByQuery()

◆ _prepareWhereQuery()

◆ _processFilter()

◆ _setCurrentListPosition()

◆ _setListNavigationParams()

◆ _setupNavigation()

◆ buildWhere()

◆ clearItemList()

◆ deleteEntry()

◆ getItemList()

◆ getItemListBaseObject()

◆ getListFilter()

◆ getListSorting()

◆ getViewListSize()

◆ render()

Member Data Documentation

◆ $_aCurrSorting

◆ $_aListFilter

◆ $_aWhere

◆ $_blDesc

◆ $_blEmployMultilanguage

◆ $_iCurrListPos

◆ $_iDefViewListSize

◆ $_iListSize

◆ $_iOverPos

◆ $_iViewListSize

◆ $_oList

◆ $_sDefSortField

◆ $_sListClass

◆ $_sListType