ajaxListComponent Class Reference

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

List of all members.


Detailed Description

AJAX call processor class

Definition at line 34 of file oxajax.php.


Public Member Functions

 __construct ($aColumns)
 setName ($sName)
 processRequest ($sFunction=null)

Protected Member Functions

 _getActionIds ($sId)
 _getQuery ()
 _getSortCol ()
 _getColNames ($sId=null)
 _getIdentColNames ()
 _getVisibleColNames ()
 _getQueryCols ()
 _getSorting ()
 _getLimit ($iStart)
 _getFilter ()
 _addFilter ($sQ)
 _getAll ($sQ)
 _getSortDir ()
 _getStartIndex ()
 _getTotalCount ($sQ)
 _getDataFields ($sQ)
 _outputResponse ($aData)
 _getData ($sCountQ, $sQ)

Protected Attributes

 $_aPosDir = array( 'asc', 'desc' )
 $_aColumns = array()
 $_iSqlLimit = 2500

Constructor & Destructor Documentation

ajaxListComponent.__construct ( aColumns  ) 

Constructor class, initializes AJAX columns

Parameters:
array $aColumns Array of DB table columns which are loaded from DB
Returns:
null

Definition at line 64 of file oxajax.php.


Member Function Documentation

ajaxListComponent._getActionIds ( sId  )  [protected]

Required data fields are returned by indexes/position in _aColumns array. This method translates "table_name.col_name" into index definition and fetches request data according to it. This is usefull while using AJAX across versions.

Parameters:
string $sId "table_name.col_name"
Returns:
array

Definition at line 78 of file oxajax.php.

ajaxListComponent.setName ( sName  ) 

AJAX container name setter

Parameters:
string $sName name of container
Returns:
null

Definition at line 95 of file oxajax.php.

ajaxListComponent._getQuery (  )  [protected]

ajaxListComponent.processRequest ( sFunction = null  ) 

AJAX call processor function

Parameters:
string $sFunction name of action to execute (optional)
Returns:
null

Definition at line 117 of file oxajax.php.

ajaxListComponent._getSortCol (  )  [protected]

Returns column id to sort

Returns:
int

Definition at line 137 of file oxajax.php.

ajaxListComponent._getColNames ( sId = null  )  [protected]

Returns array of cotainer DB cols which must be loaded. If id is not passed - all possible containers cols will be returned

Parameters:
string $sId container id (optional)
Returns:
array

Definition at line 156 of file oxajax.php.

ajaxListComponent._getIdentColNames (  )  [protected]

Returns array of identifiers which are used as identifiers for specific actions in AJAX and further in this processor class

Returns:
array

Definition at line 175 of file oxajax.php.

ajaxListComponent._getVisibleColNames (  )  [protected]

Returns array of col names which are requested by AJAX call and will be fetched from DB

Returns:
array

Definition at line 191 of file oxajax.php.

ajaxListComponent._getQueryCols (  )  [protected]

Formats and returns chunk of SQL query string with definition of fields to load from DB

Returns:
string

Reimplemented in ajaxComponent, ajaxComponent, ajaxComponent, ajaxComponent, ajaxComponent, ajaxComponent, ajaxComponent, ajaxComponent, and ajaxComponent.

Definition at line 224 of file oxajax.php.

ajaxListComponent._getSorting (  )  [protected]

Formats and returns part of SQL query for sorting

Returns:
string

Reimplemented in ajaxComponent, ajaxComponent, ajaxComponent, ajaxComponent, and ajaxComponent.

Definition at line 257 of file oxajax.php.

ajaxListComponent._getLimit ( iStart  )  [protected]

Returns part of SQL query for limiting number of entries from DB

Parameters:
int $iStart start position
Returns:
string

Definition at line 272 of file oxajax.php.

ajaxListComponent._getFilter (  )  [protected]

Returns part of SQL query for filtering DB data

Returns:
string

Definition at line 285 of file oxajax.php.

ajaxListComponent._addFilter ( sQ  )  [protected]

Adds filter SQL to current query

Parameters:
string $sQ query to add filter condition
Returns:
string

Reimplemented in ajaxComponent.

Definition at line 327 of file oxajax.php.

ajaxListComponent._getAll ( sQ  )  [protected]

Returns DB records as plain indexed array

Parameters:
string $sQ SQL query
Returns:
array

Definition at line 342 of file oxajax.php.

ajaxListComponent._getSortDir (  )  [protected]

Checks user input and returns SQL sorting direction key

Returns:
string

Definition at line 360 of file oxajax.php.

ajaxListComponent._getStartIndex (  )  [protected]

Returns position from where data must be loaded

Returns:
int

Definition at line 375 of file oxajax.php.

ajaxListComponent._getTotalCount ( sQ  )  [protected]

Returns amount of records which can be found according to passed SQL query

Parameters:
string $sQ SQL query
Returns:
int

Definition at line 387 of file oxajax.php.

ajaxListComponent._getDataFields ( sQ  )  [protected]

Returns array with DB records

Parameters:
string $sQ SQL query
Returns:
array

Reimplemented in ajaxComponent.

Definition at line 405 of file oxajax.php.

ajaxListComponent._outputResponse ( aData  )  [protected]

Outputs JSON encoded data

Parameters:
array $aData data to output
Returns:
null

Definition at line 417 of file oxajax.php.

ajaxListComponent._getData ( sCountQ,
sQ 
) [protected]

Formats data array which later will be processed by _outputResponse method

Parameters:
string $sCountQ count query
string $sQ data load query
Returns:
array

Reimplemented in ajaxComponent.

Definition at line 441 of file oxajax.php.


Member Data Documentation

ajaxListComponent.$_aPosDir = array( 'asc', 'desc' ) [protected]

Definition at line 41 of file oxajax.php.

ajaxListComponent.$_aColumns = array() [protected]

Definition at line 48 of file oxajax.php.

ajaxListComponent.$_iSqlLimit = 2500 [protected]

Definition at line 55 of file oxajax.php.


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

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