Inheritance diagram for oxList:

Collaboration diagram for oxList:

Public Member Functions
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $oBase)
	offsetUnset ($offset)
	arrayKeys ()
	rewind ()
	current ()
	key ()
	prev ()
	next ()
	valid ()
	count ()
	clear ()
	assign ($aArray)
	reverse ()
	__construct ($sObjectName=null)
	__get ($sName)
	getArray ()
	init ($sObjectName, $sCoreTable=null)
	getBaseObject ()
	setBaseObject ($oObject)
	selectString ($sSql)
	add ($oObject)
	assignArray ($aData)
	setSqlLimit ($iStart, $iRecords)
	containsFieldValue ($oVal, $sFieldName)
	getList ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_assignElement ($oListObject, $aDbFields)
	_getFieldLongName ($sFieldName)

Protected Attributes
	$_aArray = array()
	$_blRemovedActive = false
	$_sObjectsInListName = 'oxBase'
	$_sCoreTable = null
	$_sShopID = null
	$_aSqlLimit = array()

Private Attributes
	$_oBaseObject = null
	$_blValid = true

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

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

Definition at line 7 of file oxlist.php.

Constructor & Destructor Documentation

oxList::__construct ( $sObjectName = null )

Class Constructor

Parameters

string $sObjectName Associated list item object type

Reimplemented in oxCategoryList.

Definition at line 277 of file oxlist.php.

Member Function Documentation

oxList::__get ( $sName )

Backward compatibility method

Parameters

string $sName Variable name

Returns: mixed

Reimplemented in oxCategoryList.

Definition at line 296 of file oxlist.php.

oxList::_assignElement	(	$oListObject,
		$aDbFields
	)

protected

Executes assign() method on list object. This method is called in loop in oxList::selectString(). It is if you want to execute any functionality on every list ELEMENT after it is fully loaded (assigned).

Parameters

oxBase	$oListObject	List object (the one derived from oxBase)
array	$aDbFields	An array holding db field values (normally the result of oxDb::Execute())

Reimplemented in oxSimpleVariantList.

Definition at line 482 of file oxlist.php.

oxList::_getFieldLongName ( $sFieldName )

protected

Returns field long name

Parameters

string $sFieldName Field name

Returns: string

Definition at line 494 of file oxlist.php.

oxList::add ( $oObject )

Add an entry to object array.

Parameters

object $oObject Object to be added.

Definition at line 391 of file oxlist.php.

oxList::arrayKeys ( )

Returns SPL array keys

Returns: array

Definition at line 124 of file oxlist.php.

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

Definition at line 227 of file oxlist.php.

oxList::assignArray ( $aData )

Assign data from array to list

Parameters

array $aData data for list

Definition at line 405 of file oxlist.php.

oxList::clear ( )

clears/destroys list contents

Definition at line 212 of file oxlist.php.

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

Definition at line 445 of file oxlist.php.

oxList::count ( )

count for SPL

Returns: integer

Definition at line 204 of file oxlist.php.

oxList::current ( )

current for SPL

Returns: null;

Definition at line 143 of file oxlist.php.

oxList::getArray ( )

Returns list items array

Returns: array

Definition at line 308 of file oxlist.php.

oxList::getBaseObject ( )

Initializes or returns existing list template object.

Returns: oxBase

Definition at line 332 of file oxlist.php.

oxList::getList ( )

Generic function for loading the list

Returns: null;

Definition at line 462 of file oxlist.php.

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

Definition at line 319 of file oxlist.php.

oxList::key ( )

key for SPL

Returns: mixed

Definition at line 153 of file oxlist.php.

oxList::next ( )

next for SPL

Definition at line 178 of file oxlist.php.

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

Definition at line 57 of file oxlist.php.

oxList::offsetGet ( $offset )

offsetGet for SPL

Parameters

mixed $offset SPL array offset

Returns: oxBase

Definition at line 73 of file oxlist.php.

oxList::offsetSet	(	$offset,
		$oBase
	)

offsetSet for SPL

Parameters

mixed	$offset	SPL array offset
oxBase	$oBase	Array element

Definition at line 88 of file oxlist.php.

oxList::offsetUnset ( $offset )

offsetUnset for SPL

Parameters

mixed $offset SPL array offset

Definition at line 109 of file oxlist.php.

oxList::prev ( )

previous / first array element

Returns: mixed

Definition at line 163 of file oxlist.php.

oxList::reverse ( )

returns the array reversed, the internal array remains untouched

Returns: array

Definition at line 237 of file oxlist.php.

oxList::rewind ( )

rewind for SPL

Definition at line 132 of file oxlist.php.

oxList::selectString ( $sSql )

Selects and SQL, creates objects and assign them

Parameters

string $sSql SQL select statement

Reimplemented in oxArticleList.

Definition at line 358 of file oxlist.php.

oxList::setBaseObject ( $oObject )

Sets base object for list.

Parameters

object $oObject Base object

Definition at line 348 of file oxlist.php.

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

Definition at line 431 of file oxlist.php.

oxList::valid ( )

valid for SPL

Returns: boolean

Definition at line 194 of file oxlist.php.

Member Data Documentation

array oxList::$_aArray = array()

protected

Array of objects (some object list).

Definition at line 15 of file oxlist.php.

oxList::$_aSqlLimit = array()

protected

Definition at line 270 of file oxlist.php.

bool oxList::$_blRemovedActive = false

protected

Save the state, that active element was unset needed for proper foreach iterator functionality

Definition at line 23 of file oxlist.php.

boolean oxList::$_blValid = true

private

Flag if array is ok or not

Definition at line 37 of file oxlist.php.

oxList::$_oBaseObject = null

private

Definition at line 30 of file oxlist.php.

oxList::$_sCoreTable = null

protected

Definition at line 260 of file oxlist.php.

oxList::$_sObjectsInListName = 'oxBase'

protected

Definition at line 253 of file oxlist.php.

oxList::$_sShopID = null

protected

Definition at line 265 of file oxlist.php.

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

core/oxlist.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation