oxList Class Reference

Inheritance diagram for oxList:

[legend]

Collaboration diagram for oxList:

[legend]

List of all members.

---

Detailed Description

List manager. Collects list data (eg. from DB), performs list changes updating (to DB), etc.

Public Member Functions
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $oBase)
	offsetUnset ($offset)
	arrayKeys ()
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	count ()
	clear ()
	assign ($aArray)
	reverse ()
	__construct ($sObjectName=null)
	__get ($sName)
	getArray ()
	init ($sObjectName, $sCoreTable=null)
	setAssignCallbackPrepend ($aAssignCallbackPrepend)
	setAssignCallback ($aAssignCallBack)
	getBaseObject ()
	selectString ($sSql)
	setSqlLimit ($iStart, $iRecords)
	setObjectCallback ($aCallbackArray)
	containsFieldValue ($oVal, $sFieldName)
	getList ()
Protected Member Functions
	_getFieldLongName ($sFieldName)
Protected Attributes
	$_aArray = array()
	$_sObjectsInListName = 'oxBase'
	$_sCoreTable = null
	$_sShopID = null
	$_aAssignCallbackPrepend = null
	$_aAssignCallback = null
	$_aSqlLimit = array()
Private Attributes
	$_oBaseObject = null
	$_blValid = true

---

Constructor & Destructor Documentation

oxList.__construct

(

$

sObjectName = null

)

Class Constructor

Parameters:

string

$sObjectName Associated list item object type

Reimplemented in oxAttributeList, oxCategoryList, oxContentList, oxCountryList, oxDeliveryList, oxDeliverySetList, oxDiscountList, oxPaymentList, oxShopList, oxUserList, and oxVendorList.

---

Member Function Documentation

oxList.offsetExists

(

$

offset

)

-----------------------------------------------------------------------------------------------------

Implementation of SPL Array classes functions follows here

----------------------------------------------------------------------------------------------------- implementation of abstract classes for ArrayAccess follow offsetExists for SPL

Parameters:

mixed

$offset SPL array offset

Returns:

boolean

oxList.offsetGet

(

$

offset

)

offsetGet for SPL

Parameters:

mixed

$offset SPL array offset

Returns:

oxBase

oxList.offsetSet	(	$	offset,
		$	oBase
	)

offsetSet for SPL

Parameters:

	mixed	$offset SPL array offset
	oxBase	$oBase Array element

Returns:

null;

oxList.offsetUnset

(

$

offset

)

offsetUnset for SPL

Parameters:

mixed

$offset SPL array offset

Returns:

null;

oxList.arrayKeys

(

)

Returns SPL array keys

Returns:

array

oxList.rewind

(

)

rewind for SPL

Returns:

null;

oxList.current

(

)

current for SPL

Returns:

null;

oxList.key

(

)

key for SPL

Returns:

mixed

oxList.next

(

)

next for SPL

Returns:

null;

oxList.valid

(

)

valid for SPL

Returns:

boolean

oxList.count

(

)

count for SPL

Returns:

integer

oxList.clear

(

)

clears/destroys list contents

Returns:

null;

oxList.assign

(

$

aArray

)

copies a given array over the objects internal array (something like old $myList->aList = $aArray)

Parameters:

array

$aArray array of list items

Returns:

null

oxList.reverse

(

)

returns the array reversed, the internal array remains untouched

Returns:

array

oxList.__get

(

$

sName

)

Backward compatibility method

Parameters:

string

$sName Variable name

Returns:

mixed

Reimplemented in oxCategoryList.

oxList.getArray

(

)

Returns list items array

Returns:

array

oxList.init	(	$	sObjectName,
		$	sCoreTable = null
	)

Inits list table name and object name.

Parameters:

	string	$sObjectName List item object type
	string	$sCoreTable Db table name this list s selected from

Returns:

null;

oxList.setAssignCallbackPrepend

(

$

aAssignCallbackPrepend

)

Sets function to be called on list object before loading it

Parameters:

array

$aAssignCallbackPrepend

Returns:

nill

oxList.setAssignCallback

(

$

aAssignCallBack

)

Sets function to be called on list object before loading it

Parameters:

array

$aAssignCallbackPrepend

Returns:

nill

oxList.getBaseObject

(

)

Initializes or returns existing list template object.

Returns:

oxBase

oxList.selectString

(

$

sSql

)

Selects and SQL, creates objects and assign them

Parameters:

string

$sSql SQL select statement

Returns:

null;

Reimplemented in oxArticleList, and oxCountryList.

oxList.setSqlLimit	(	$	iStart,
		$	iRecords
	)

Sets SQL Limit

Parameters:

	integer	$iStart Start e.g. limit Start,xxxx
	integer	$iRecords Nr of Records e.g. limit xxx,Records

Returns:

null;

oxList.setObjectCallback

(

$

aCallbackArray

)

Set's callback array for lists objects, will be called upon loadind see call_user_func for more info

Parameters:

array

$aCallbackArray Callback array

Returns:

null;

oxList.containsFieldValue	(	$	oVal,
		$	sFieldName
	)

Function checks if there is at least one object in the list which has the given value in the given field

Parameters:

	mixed	$oVal The searched value
	string	$sFieldName The name of the field, give "oxid" will access the classname__oxid field

Returns:

boolean

oxList.getList

(

)

Generic function for getting the list

Returns:

null;

oxList._getFieldLongName

(

$

sFieldName

)

[protected]

Returns field long name

Parameters:

string

$sFieldName Field name

Returns:

string

---

Member Data Documentation

oxList.$_aArray = array() [protected]

oxList.$_oBaseObject = null [private]

oxList.$_blValid = true [private]

oxList.$_sObjectsInListName = 'oxBase' [protected]

Reimplemented in oxArticleList, oxCategoryList, and oxNewslist.

oxList.$_sCoreTable = null [protected]

oxList.$_sShopID = null [protected]

oxList.$_aAssignCallbackPrepend = null [protected]

oxList.$_aAssignCallback = null [protected]

oxList.$_aSqlLimit = array() [protected]

---

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

• core/oxlist.php