Inheritance diagram for OxidEsales\EshopCommunity\Core\Model\ListModel:

Collaboration diagram for OxidEsales\EshopCommunity\Core\Model\ListModel:

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 ($sql, array $parameters=[])

	add ($oObject)

	assignArray ($aData)

	setSqlLimit ($iStart, $iRecords)

	containsFieldValue ($oVal, $sFieldName)

	getList ()

Protected Member Functions
	_assignElement ($oListObject, $aDbFields)

	_getFieldLongName ($sFieldName)

Protected Attributes
	$_aArray = []

	$_blRemovedActive = false

	$_sObjectsInListName = 'oxBase'

	$_sCoreTable = null

	$_sShopID = null

	$_aSqlLimit = []

Private Attributes
	$_oBaseObject = null

	$_blValid = true

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\Model\ListModel::__construct ( $sObjectName = null )

Class Constructor

Parameters

string $sObjectName Associated list item object type

Member Function Documentation

◆ __get()

OxidEsales\EshopCommunity\Core\Model\ListModel::__get ( $sName )

Backward compatibility method

Parameters

string $sName Variable name

Returns: mixed

◆ _assignElement()

OxidEsales\EshopCommunity\Core\Model\ListModel::_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

BaseModel	$oListObject	List object (the one derived from BaseModel)
array	$aDbFields	An array holding db field values (normally the result of \OxidEsales\Eshop\Core\DatabaseProvider::Execute())

◆ _getFieldLongName()

OxidEsales\EshopCommunity\Core\Model\ListModel::_getFieldLongName ( $sFieldName )

protected

Returns field long name

Parameters

string $sFieldName Field name

Returns: string

◆ add()

OxidEsales\EshopCommunity\Core\Model\ListModel::add ( $oObject )

Add an entry to object array.

Parameters

object $oObject Object to be added.

◆ arrayKeys()

OxidEsales\EshopCommunity\Core\Model\ListModel::arrayKeys ( )

Returns SPL array keys

Returns: array

◆ assign()

OxidEsales\EshopCommunity\Core\Model\ListModel::assign ( $aArray )

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

Parameters

array $aArray array of list items

◆ assignArray()

OxidEsales\EshopCommunity\Core\Model\ListModel::assignArray ( $aData )

Assign data from array to list

Parameters

array $aData data for list

◆ clear()

OxidEsales\EshopCommunity\Core\Model\ListModel::clear ( )

clears/destroys list contents

◆ containsFieldValue()

OxidEsales\EshopCommunity\Core\Model\ListModel::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

◆ count()

OxidEsales\EshopCommunity\Core\Model\ListModel::count ( )

count for SPL

Returns: integer

◆ current()

OxidEsales\EshopCommunity\Core\Model\ListModel::current ( )

current for SPL

Returns: null;

◆ getArray()

OxidEsales\EshopCommunity\Core\Model\ListModel::getArray ( )

Returns list items array

Returns: array

◆ getBaseObject()

OxidEsales\EshopCommunity\Core\Model\ListModel::getBaseObject ( )

Initializes or returns existing list template object.

Returns: BaseModel

◆ getList()

OxidEsales\EshopCommunity\Core\Model\ListModel::getList ( )

Generic function for loading the list

Returns: null;

◆ init()

OxidEsales\EshopCommunity\Core\Model\ListModel::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

◆ key()

OxidEsales\EshopCommunity\Core\Model\ListModel::key ( )

key for SPL

Returns: mixed

◆ next()

OxidEsales\EshopCommunity\Core\Model\ListModel::next ( )

next for SPL

◆ offsetExists()

OxidEsales\EshopCommunity\Core\Model\ListModel::offsetExists ( $offset )

Implementation of SPL Array classes functions follows here

implementation of abstract classes for ArrayAccess followoffsetExists for SPL

Parameters

mixed $offset SPL array offset

Returns: boolean

◆ offsetGet()

OxidEsales\EshopCommunity\Core\Model\ListModel::offsetGet ( $offset )

offsetGet for SPL

Parameters

mixed $offset SPL array offset

Returns: BaseModel

◆ offsetSet()

OxidEsales\EshopCommunity\Core\Model\ListModel::offsetSet	(	$offset,
		$oBase
	)

offsetSet for SPL

Parameters

mixed	$offset	SPL array offset
BaseModel	$oBase	Array element

◆ offsetUnset()

OxidEsales\EshopCommunity\Core\Model\ListModel::offsetUnset ( $offset )

offsetUnset for SPL

Parameters

mixed $offset SPL array offset

◆ prev()

OxidEsales\EshopCommunity\Core\Model\ListModel::prev ( )

previous / first array element

Returns: mixed

◆ reverse()

OxidEsales\EshopCommunity\Core\Model\ListModel::reverse ( )

returns the array reversed, the internal array remains untouched

Returns: array

◆ rewind()

OxidEsales\EshopCommunity\Core\Model\ListModel::rewind ( )

rewind for SPL

◆ selectString()

OxidEsales\EshopCommunity\Core\Model\ListModel::selectString	(		$sql,
		array	$parameters = `[]`
	)

Convert results of the given select statement into objects and store them in _aArray.

Developers are encouraged to use prepared statements like this: $sql = 'SELECT * FROM mytable WHERE oxid = ?'; $parameters = ['MYOXID'] selectString($sql, $parameters)

Parameters

string	$sql	SQL select statement or prepared statement
array	$parameters	Parameters to be used in a prepared statement

◆ setBaseObject()

OxidEsales\EshopCommunity\Core\Model\ListModel::setBaseObject ( $oObject )

Sets base object for list.

Parameters

object $oObject Base object

◆ setSqlLimit()

OxidEsales\EshopCommunity\Core\Model\ListModel::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

◆ valid()

OxidEsales\EshopCommunity\Core\Model\ListModel::valid ( )

valid for SPL

Returns: boolean

Member Data Documentation

◆ $_aArray

array OxidEsales\EshopCommunity\Core\Model\ListModel::$_aArray = []

protected

Array of objects (some object list).

◆ $_aSqlLimit

OxidEsales\EshopCommunity\Core\Model\ListModel::$_aSqlLimit = []

protected

◆ $_blRemovedActive

bool OxidEsales\EshopCommunity\Core\Model\ListModel::$_blRemovedActive = false

protected

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

◆ $_blValid

boolean OxidEsales\EshopCommunity\Core\Model\ListModel::$_blValid = true

private

Flag if array is ok or not

◆ $_oBaseObject

OxidEsales\EshopCommunity\Core\Model\ListModel::$_oBaseObject = null

private

◆ $_sCoreTable

OxidEsales\EshopCommunity\Core\Model\ListModel::$_sCoreTable = null

protected

◆ $_sObjectsInListName

OxidEsales\EshopCommunity\Core\Model\ListModel::$_sObjectsInListName = 'oxBase'

protected

◆ $_sShopID

OxidEsales\EshopCommunity\Core\Model\ListModel::$_sShopID = null

protected

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

/oxideshop-ce/source/Core/Model/ListModel.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ _assignElement()

◆ _getFieldLongName()

◆ add()

◆ arrayKeys()

◆ assign()

◆ assignArray()

◆ clear()

◆ containsFieldValue()

◆ count()

◆ current()

◆ getArray()

◆ getBaseObject()

◆ getList()

◆ init()

◆ key()

◆ next()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ prev()

◆ reverse()

◆ rewind()

◆ selectString()

◆ setBaseObject()

◆ setSqlLimit()

◆ valid()

Member Data Documentation

◆ $_aArray

◆ $_aSqlLimit

◆ $_blRemovedActive

◆ $_blValid

◆ $_oBaseObject

◆ $_sCoreTable

◆ $_sObjectsInListName

◆ $_sShopID