oxAdminList Class Reference

Inheritance diagram for oxAdminList:
[legend]
Collaboration diagram for oxAdminList:
[legend]

List of all members.


Detailed Description

Admin selectlist list manager.

Definition at line 7 of file oxadminlist.php.


Public Member Functions

 __construct ()
 init ()
 render ()
 isOx ($oObject)
 deleteEntry ()
 buildWhere ()

Protected Member Functions

 _calcListItemsCount ($sSql)
 _setCurrentListPosition ($sPage=null)
 _prepareOrderByQuery ($sSql=null)
 _buildSelectString ($oListObject=null)
 _processFilter ($sFieldValue)
 _buildFilter ($sVal, $blIsSearchValue)
 _isSearchValue ($sFieldValue)
 _prepareWhereQuery ($aWhere, $sqlFull)
 _changeselect ($sSql)
 _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

Constructor & Destructor Documentation

oxAdminList.__construct (  ) 

Calls parent constructor and sets list size parameters

Returns:
null

Reimplemented from oxAdminView.

Definition at line 91 of file oxadminlist.php.


Member Function Documentation

oxAdminList.init (  ) 

Executes parent.init(), loads list items

Returns:
null

Reimplemented from oxAdminView.

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

Definition at line 116 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 AdminGuestbook_List, Article_List, Category_List, Content_List, Country_List, Dynscreen_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 170 of file oxadminlist.php.

oxAdminList.isOx ( oObject  ) 

Checks if object ID's first two chars are 'o' and 'x'. Returns same object

Parameters:
object $oObject Object to check.
Returns:
object

Definition at line 218 of file oxadminlist.php.

oxAdminList.deleteEntry (  ) 

Deletes this entry from the database

Returns:
null

Reimplemented in Article_List, Shop_List, User_List, and VoucherSerie_List.

Definition at line 233 of file oxadminlist.php.

oxAdminList._calcListItemsCount ( sSql  )  [protected]

Calculates list items count

Parameters:
string $sSql SQL query used co select list items
Returns:
null

Definition at line 256 of file oxadminlist.php.

oxAdminList._setCurrentListPosition ( sPage = null  )  [protected]

Set current list position

Parameters:
string $sPage jump page string
Returns:
null

Definition at line 278 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 302 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, List_User, Order_List, and PriceAlarm_List.

Definition at line 376 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:
array $aWhere SQL condition array
string $sqlFull SQL query string
Returns:
string

Definition at line 400 of file oxadminlist.php.

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 415 of file oxadminlist.php.

oxAdminList._isSearchValue ( sFieldValue  )  [protected]

Checks if fulter contains wildcards like %

Parameters:
string $sFieldValue filter value
Returns:
bool

Definition at line 435 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 Article_List, Content_List, List_Review, List_User, and User_List.

Definition at line 457 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 512 of file oxadminlist.php.

oxAdminList.buildWhere (  ) 

Builds and returns array of SQL WHERE conditions.

Returns:
array

Reimplemented in Article_List, List_Review, Order_List, PriceAlarm_List, and Shop_List.

Definition at line 523 of file oxadminlist.php.

oxAdminList._setListNavigationParams (  )  [protected]

Set parameters needed for list navigation

Returns:
null

Definition at line 569 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 657 of file oxadminlist.php.


Member Data Documentation

oxAdminList.$_sListClass = null [protected]

oxAdminList.$_sListType = 'oxlist' [protected]

Reimplemented from oxView.

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

Definition at line 21 of file oxadminlist.php.

oxAdminList.$_oList = null [protected]

Definition at line 28 of file oxadminlist.php.

oxAdminList.$_iCurrListPos = 0 [protected]

Definition at line 35 of file oxadminlist.php.

oxAdminList.$_iListSize = 0 [protected]

Definition at line 42 of file oxadminlist.php.

oxAdminList.$_aWhere = null [protected]

Definition at line 49 of file oxadminlist.php.

oxAdminList.$_sDefSort = null [protected]

oxAdminList.$_aSort = array() [protected]

Definition at line 63 of file oxadminlist.php.

oxAdminList.$_blDesc = false [protected]

Reimplemented in AdminGuestbook_List, Country_List, and Order_List.

Definition at line 70 of file oxadminlist.php.

oxAdminList.$_blEmployMultilanguage = null [protected]

Definition at line 77 of file oxadminlist.php.

oxAdminList.$_iOverPos = null [protected]

Definition at line 84 of file oxadminlist.php.


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

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