oxAdminList Class Reference

Inheritance diagram for oxAdminList:

Collaboration diagram for oxAdminList:

List of all members.

Public Member Functions
	init ()
	render ()
	deleteEntry ()
	buildWhere ()
	getItemList ()
Protected Member Functions
	_getViewListSize ()
	_getUserDefListSize ()
	_setFilterParams ()
	_calcListItemsCount ($sSql)
	_setCurrentListPosition ($sPage=null)
	_prepareOrderByQuery ($sSql=null)
	_buildSelectString ($oListObject=null)
	_processFilter ($sFieldValue)
	_buildFilter ($sVal, $blIsSearchValue)
	_isSearchValue ($sFieldValue)
	_prepareWhereQuery ($aWhere, $sqlFull)
	_changeselect ($sSql)
	_convertToDBDate ($sValue, $sFldType)
	_convertDate ($sDate)
	_convertTime ($sFullDate)
	_setListNavigationParams ()
	_setupNavigation ($sNode)
Protected Attributes
	$_sListClass = null
	$_sListType = 'oxlist'
	$_oList = null
	$_iCurrListPos = 0
	$_iListSize = 0
	$_aWhere = null
	$_sDefSort = null
	$_aSort = array()
	$_blDesc = false
	$_blEmployMultilanguage = null
	$_iOverPos = null
	$_iViewListSize = 0
	$_iDefViewListSize = 50

---

Detailed Description

Admin selectlist list manager.

Definition at line 6 of file oxadminlist.php.

---

Member Function Documentation

oxAdminList._buildFilter	(	$	sVal,
		$	blIsSearchValue
	)			[protected]

Builds part of SQL query

Parameters:

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

Returns:

string

Definition at line 451 of file oxadminlist.php.

oxAdminList._buildSelectString

(

$

oListObject = null

)

[protected]

Builds and returns SQL query string.

Parameters:

object

$oListObject list main object

Returns:

string

Reimplemented in List_Order, List_Review, Order_List, and PriceAlarm_List.

Definition at line 411 of file oxadminlist.php.

oxAdminList._calcListItemsCount

(

$

sSql

)

[protected]

Calculates list items count

Parameters:

string

$sSql SQL query used co select list items

Returns:

null

Reimplemented in List_Order.

Definition at line 289 of file oxadminlist.php.

oxAdminList._changeselect

(

$

sSql

)

[protected]

Override this for individual search in admin.

Parameters:

string

$sSql SQL select to change

Returns:

string

Reimplemented in Article_List.

Definition at line 553 of file oxadminlist.php.

oxAdminList._convertDate

(

$

sDate

)

[protected]

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

Parameters:

string

$sDate searched date

Returns:

string

Definition at line 657 of file oxadminlist.php.

oxAdminList._convertTime

(

$

sFullDate

)

[protected]

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

Parameters:

string

$sFullDate searched date

Returns:

string

Definition at line 693 of file oxadminlist.php.

oxAdminList._convertToDBDate	(	$	sValue,
		$	sFldType
	)			[protected]

Converts date/datetime values to DB scheme (M1260)

Parameters:

	string	$sValue field value
	string	$sFldType field type

Returns:

string

Definition at line 626 of file oxadminlist.php.

oxAdminList._getUserDefListSize

(

)

[protected]

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

Returns:

int

Definition at line 129 of file oxadminlist.php.

oxAdminList._getViewListSize

(

)

[protected]

Viewable list size getter

Returns:

int

Reimplemented in List_Order, List_Review, and List_User.

Definition at line 104 of file oxadminlist.php.

oxAdminList._isSearchValue

(

$

sFieldValue

)

[protected]

Checks if fulter contains wildcards like %

Parameters:

string

$sFieldValue filter value

Returns:

bool

Definition at line 471 of file oxadminlist.php.

oxAdminList._prepareOrderByQuery

(

$

sSql = null

)

[protected]

Adds order by to SQL query string.

Parameters:

string

$sSql sql string

Returns:

string

Reimplemented in List_Order, List_Review, List_User, and Order_List.

Definition at line 337 of file oxadminlist.php.

oxAdminList._prepareWhereQuery	(	$	aWhere,
		$	sqlFull
	)			[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	$aWhere SQL condition array
	string	$sqlFull SQL query string

Returns:

string

Reimplemented in Actions_List, Article_List, Content_List, List_Order, List_Review, Order_List, and User_List.

Definition at line 494 of file oxadminlist.php.

oxAdminList._processFilter

(

$

sFieldValue

)

[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

$sFieldValue Filters

Returns:

string

Definition at line 434 of file oxadminlist.php.

oxAdminList._setCurrentListPosition

(

$

sPage = null

)

[protected]

Set current list position

Parameters:

string

$sPage jump page string

Returns:

null

Definition at line 313 of file oxadminlist.php.

oxAdminList._setFilterParams

(

)

[protected]

Sets view filter data

• aViewData['where'] containts filter data like $object->oxarticles__oxtitle = filter_value
• aViewData['whereparam'] contains string which can be later used in url. and looks like &where[oxarticles.oxtitle]=_filter_value_&art_category=_filter_categry_;

Returns:

null

Reimplemented in List_Review.

Definition at line 232 of file oxadminlist.php.

oxAdminList._setListNavigationParams

(

)

[protected]

Set parameters needed for list navigation

Returns:

null

Definition at line 733 of file oxadminlist.php.

oxAdminList._setupNavigation

(

$

sNode

)

[protected]

Sets-up navigation parameters

Parameters:

string

$sNode active view id

Returns:

null

Reimplemented from oxAdminView.

Reimplemented in Dynscreen, Newsletter_Send, and PriceAlarm_Send.

Definition at line 819 of file oxadminlist.php.

oxAdminList.buildWhere

(

)

Builds and returns array of SQL WHERE conditions.

Returns:

array

Reimplemented in Article_List, PriceAlarm_List, and Shop_List.

Definition at line 564 of file oxadminlist.php.

oxAdminList.deleteEntry

(

)

Deletes this entry from the database

Returns:

null

Reimplemented in Article_List, Language_List, Shop_List, User_List, and VoucherSerie_List.

Definition at line 266 of file oxadminlist.php.

oxAdminList.getItemList

(

)

Returns items list

Returns:

oxlist

Definition at line 856 of file oxadminlist.php.

oxAdminList.init

(

)

Executes parent.init(), loads list items

Returns:

null

Reimplemented from oxAdminView.

Reimplemented in Adminlinks_List, Attribute_List, Category_List, Delivery_List, DeliverySet_List, Discount_List, List_User, Manufacturer_List, News_List, SelectList_List, Shop_List, User_List, Vendor_List, and Wrapping_List.

Definition at line 146 of file oxadminlist.php.

oxAdminList.render

(

)

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

Returns:

null

Reimplemented from oxAdminView.

Reimplemented in Actions_List, AdminGuestbook_List, Article_List, Category_List, Content_List, Country_List, Dynscreen_List, Language_List, List_Order, List_Review, List_User, Newsletter_Send, Order_List, PriceAlarm_List, PriceAlarm_Send, Shop_List, UserGroup_List, and Wrapping_List.

Definition at line 198 of file oxadminlist.php.

---

Member Data Documentation

oxAdminList.$_aSort = array() [protected]

Definition at line 62 of file oxadminlist.php.

oxAdminList.$_aWhere = null [protected]

Definition at line 48 of file oxadminlist.php.

oxAdminList.$_blDesc = false [protected]

Reimplemented in AdminGuestbook_List, Country_List, and Order_List.

Definition at line 69 of file oxadminlist.php.

oxAdminList.$_blEmployMultilanguage = null [protected]

Definition at line 76 of file oxadminlist.php.

oxAdminList.$_iCurrListPos = 0 [protected]

Definition at line 34 of file oxadminlist.php.

oxAdminList.$_iDefViewListSize = 50 [protected]

Definition at line 97 of file oxadminlist.php.

oxAdminList.$_iListSize = 0 [protected]

Definition at line 41 of file oxadminlist.php.

oxAdminList.$_iOverPos = null [protected]

Definition at line 83 of file oxadminlist.php.

oxAdminList.$_iViewListSize = 0 [protected]

Definition at line 90 of file oxadminlist.php.

oxAdminList.$_oList = null [protected]

Definition at line 27 of file oxadminlist.php.

oxAdminList.$_sDefSort = null [protected]

Reimplemented in Actions_List, AdminGuestbook_List, Country_List, Language_List, News_List, Newsletter_List, Order_List, Payment_List, PriceAlarm_List, Shop_List, User_List, and UserGroup_List.

Definition at line 55 of file oxadminlist.php.

oxAdminList.$_sListClass = null [protected]

Reimplemented in Actions_List, AdminGuestbook_List, Adminlinks_List, Article_List, Attribute_List, Category_List, Content_List, Country_List, Delivery_List, DeliverySet_List, Discount_List, List_Review, Manufacturer_List, News_List, Newsletter_List, Order_List, Payment_List, PriceAlarm_List, SelectList_List, Shop_List, Statistic_List, User_List, UserGroup_List, Vendor_List, VoucherSerie_List, and Wrapping_List.

Definition at line 13 of file oxadminlist.php.

oxAdminList.$_sListType = 'oxlist' [protected]

Reimplemented in Article_List, Category_List, Content_List, Delivery_List, DeliverySet_List, Discount_List, List_Review, News_List, and User_List.

Definition at line 20 of file oxadminlist.php.

---

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

• admin/oxadminlist.php