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.

Definition at line 8 of file oxlist.php.


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.

Definition at line 266 of file oxlist.php.


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

Definition at line 49 of file oxlist.php.

oxList.offsetGet ( offset  ) 

offsetGet for SPL

Parameters:
mixed $offset SPL array offset
Returns:
oxBase

Definition at line 65 of file oxlist.php.

oxList.offsetSet ( offset,
oBase 
)

offsetSet for SPL

Parameters:
mixed $offset SPL array offset
oxBase $oBase Array element
Returns:
null;

Definition at line 82 of file oxlist.php.

oxList.offsetUnset ( offset  ) 

offsetUnset for SPL

Parameters:
mixed $offset SPL array offset
Returns:
null;

Definition at line 105 of file oxlist.php.

oxList.arrayKeys (  ) 

Returns SPL array keys

Returns:
array

Definition at line 115 of file oxlist.php.

oxList.rewind (  ) 

rewind for SPL

Returns:
null;

Definition at line 125 of file oxlist.php.

oxList.current (  ) 

current for SPL

Returns:
null;

Definition at line 135 of file oxlist.php.

oxList.key (  ) 

key for SPL

Returns:
mixed

Definition at line 145 of file oxlist.php.

oxList.next (  ) 

next for SPL

Returns:
null;

Definition at line 155 of file oxlist.php.

oxList.valid (  ) 

valid for SPL

Returns:
boolean

Definition at line 165 of file oxlist.php.

oxList.count (  ) 

count for SPL

Returns:
integer

Definition at line 175 of file oxlist.php.

oxList.clear (  ) 

clears/destroys list contents

Returns:
null;

Definition at line 185 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
Returns:
null

Definition at line 202 of file oxlist.php.

oxList.reverse (  ) 

returns the array reversed, the internal array remains untouched

Returns:
array

Definition at line 212 of file oxlist.php.

oxList.__get ( sName  ) 

Backward compatibility method

Parameters:
string $sName Variable name
Returns:
mixed

Reimplemented in oxCategoryList.

Definition at line 285 of file oxlist.php.

oxList.getArray (  ) 

Returns list items array

Returns:
array

Definition at line 301 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
Returns:
null;

Definition at line 314 of file oxlist.php.

oxList.setAssignCallbackPrepend ( aAssignCallbackPrepend  ) 

Sets function to be called on list object before loading it

Parameters:
array $aAssignCallbackPrepend callback array
Returns:
nill

Definition at line 329 of file oxlist.php.

oxList.setAssignCallback ( aAssignCallBack  ) 

Sets function to be called on list object before loading it

Parameters:
array $aAssignCallBack callback array
Returns:
null

Definition at line 341 of file oxlist.php.

oxList.getBaseObject (  ) 

Initializes or returns existing list template object.

Returns:
oxBase

Definition at line 351 of file oxlist.php.

oxList.selectString ( sSql  ) 

Selects and SQL, creates objects and assign them

Parameters:
string $sSql SQL select statement
Returns:
null;

Reimplemented in oxArticleList, and oxCountryList.

Definition at line 368 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
Returns:
null;

Definition at line 423 of file oxlist.php.

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;

Definition at line 437 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 450 of file oxlist.php.

oxList.getList (  ) 

Generic function for getting the list

Returns:
null;

Definition at line 467 of file oxlist.php.

oxList._getFieldLongName ( sFieldName  )  [protected]

Returns field long name

Parameters:
string $sFieldName Field name
Returns:
string

Definition at line 484 of file oxlist.php.


Member Data Documentation

oxList.$_aArray = array() [protected]

Definition at line 15 of file oxlist.php.

oxList.$_oBaseObject = null [private]

Definition at line 22 of file oxlist.php.

oxList.$_blValid = true [private]

Definition at line 29 of file oxlist.php.

oxList.$_sObjectsInListName = 'oxBase' [protected]

Reimplemented in oxArticleList, oxCategoryList, and oxNewslist.

Definition at line 228 of file oxlist.php.

oxList.$_sCoreTable = null [protected]

Definition at line 235 of file oxlist.php.

oxList.$_sShopID = null [protected]

Definition at line 240 of file oxlist.php.

oxList.$_aAssignCallbackPrepend = null [protected]

Definition at line 247 of file oxlist.php.

oxList.$_aAssignCallback = null [protected]

Definition at line 254 of file oxlist.php.

oxList.$_aSqlLimit = array() [protected]

Definition at line 259 of file oxlist.php.


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

Generated on Thu Dec 4 12:05:27 2008 for OXID eShop CE by  doxygen 1.5.5