Inheritance diagram for ajaxListComponent:

Collaboration diagram for ajaxListComponent:

Public Member Functions
	init ($aColumns=null)
	getColumns ()
	setColumns ($aColumns)
	setName ($sName)
	processRequest ($sFunction=null)
	resetContentCache ()
	resetCounter ($sCounterType, $sValue=null)
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
	_getActionIds ($sId)
	_getQuery ()
	_getDataQuery ($sQ)
	_getCountQuery ($sQ)
	_getSortCol ()
	_getColNames ($sId=null)
	_getIdentColNames ()
	_getVisibleColNames ()
	_getQueryCols ()
	_buildColsQuery ($aIdentCols, $blIdentCols=true)
	_isExtendedColumn ($sColumn)
	_getExtendedColQuery ($sViewTable, $sColumn, $iCnt)
	_getSorting ()
	_getLimit ($iStart)
	_getFilter ()
	_addFilter ($sQ)
	_getAll ($sQ)
	_getSortDir ()
	_getStartIndex ()
	_getTotalCount ($sQ)
	_getDataFields ($sQ)
	_outputResponse ($aData)
	_output ($sOut)
	_getViewName ($sTable)
	_getData ($sCountQ, $sQ)
	_resetContentCache ()

Protected Attributes
	$_aPosDir = array('asc', 'desc')
	$_aColumns = array()
	$_iSqlLimit = 2500
	$_sContainer = null
	$_blAllowExtColumns = false

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

AJAX call processor class

Definition at line 7 of file ajaxlistcomponent.php.

Member Function Documentation

ajaxListComponent::_addFilter ( $sQ )

protected

Adds filter SQL to current query

Parameters

string $sQ query to add filter condition

Returns: string

Reimplemented in actions_main_ajax, attribute_main_ajax, category_main_ajax, manufacturer_main_ajax, vendor_main_ajax, article_bundle_ajax, and actions_article_ajax.

Definition at line 422 of file ajaxlistcomponent.php.

ajaxListComponent::_buildColsQuery	(	$aIdentCols,
		$blIdentCols = `true`
	)

protected

Builds column selection query

Parameters

array	$aIdentCols	columns
bool	$blIdentCols	if true, means ident columns part is build

Returns: string

Definition at line 278 of file ajaxlistcomponent.php.

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 89 of file ajaxlistcomponent.php.

ajaxListComponent::_getAll ( $sQ )

protected

Returns DB records as plain indexed array

Parameters

string $sQ SQL query

Returns: array

Definition at line 438 of file ajaxlistcomponent.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 189 of file ajaxlistcomponent.php.

ajaxListComponent::_getCountQuery ( $sQ )

protected

Return fully formatted query for data records count

Parameters

string $sQ part of initial query

Returns: string

Definition at line 138 of file ajaxlistcomponent.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 statistic_main_ajax.

Definition at line 562 of file ajaxlistcomponent.php.

ajaxListComponent::_getDataFields ( $sQ )

protected

Returns array with DB records

Parameters

string $sQ SQL query

Returns: array

Reimplemented in article_extend_ajax.

Definition at line 502 of file ajaxlistcomponent.php.

ajaxListComponent::_getDataQuery ( $sQ )

protected

Return fully formatted query for data loading

Parameters

string $sQ part of initial query

Returns: string

Definition at line 126 of file ajaxlistcomponent.php.

ajaxListComponent::_getExtendedColQuery	(	$sViewTable,
		$sColumn,
		$iCnt
	)

protected

Returns extended query part for given view/column combination (if variants must be shown in lists and column name is "oxtitle")

Parameters

string	$sViewTable	view name
string	$sColumn	column name
int	$iCnt	column count

Returns: string

Definition at line 326 of file ajaxlistcomponent.php.

ajaxListComponent::_getFilter ( )

protected

Returns part of SQL query for filtering DB data

Returns: string

Definition at line 368 of file ajaxlistcomponent.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 208 of file ajaxlistcomponent.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 355 of file ajaxlistcomponent.php.

ajaxListComponent::_getQuery ( )

protected

Empty function, developer should override this method according requirements

Returns: string

Reimplemented in selectlist_main_ajax, actions_main_ajax, article_accessories_ajax, article_crossselling_ajax, attribute_main_ajax, category_main_ajax, delivery_articles_ajax, discount_articles_ajax, manufacturer_main_ajax, vendor_main_ajax, delivery_users_ajax, deliveryset_users_ajax, discount_users_ajax, usergroup_main_ajax, category_order_ajax, attribute_category_ajax, discount_item_ajax, actions_article_ajax, article_bundle_ajax, article_extend_ajax, delivery_main_ajax, deliveryset_country_ajax, discount_main_ajax, payment_country_ajax, delivery_categories_ajax, discount_categories_ajax, article_selection_ajax, deliveryset_main_ajax, deliveryset_payment_ajax, actions_groups_ajax, article_attribute_ajax, delivery_groups_ajax, deliveryset_groups_ajax, discount_groups_ajax, news_main_ajax, newsletter_selection_ajax, payment_main_ajax, user_main_ajax, voucherserie_groups_ajax, actions_order_ajax, selectlist_order_ajax, shop_default_category_ajax, and attribute_order_ajax.

Definition at line 114 of file ajaxlistcomponent.php.

ajaxListComponent::_getQueryCols ( )

protected

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

Returns: string

Reimplemented in discount_item_ajax.

Definition at line 262 of file ajaxlistcomponent.php.

ajaxListComponent::_getSortCol ( )

protected

Returns column id to sort

Returns: int

Definition at line 170 of file ajaxlistcomponent.php.

ajaxListComponent::_getSortDir ( )

protected

Checks user input and returns SQL sorting direction key

Returns: string

Definition at line 457 of file ajaxlistcomponent.php.

ajaxListComponent::_getSorting ( )

protected

Formats and returns part of SQL query for sorting

Returns: string

Reimplemented in actions_main_ajax, category_order_ajax, actions_order_ajax, selectlist_order_ajax, and attribute_order_ajax.

Definition at line 343 of file ajaxlistcomponent.php.

ajaxListComponent::_getStartIndex ( )

protected

Returns position from where data must be loaded

Returns: int

Definition at line 472 of file ajaxlistcomponent.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 484 of file ajaxlistcomponent.php.

ajaxListComponent::_getViewName ( $sTable )

protected

Return the view name of the given table if a view exists, otherwise the table name itself

Parameters

string $sTable table name

Returns: string

Definition at line 549 of file ajaxlistcomponent.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 227 of file ajaxlistcomponent.php.

ajaxListComponent::_isExtendedColumn ( $sColumn )

protected

Checks if current column is extended (currently checks if variants must be shown in lists and column name is "oxtitle")

Parameters

string $sColumn column name

Returns: bool

Definition at line 305 of file ajaxlistcomponent.php.

ajaxListComponent::_output ( $sOut )

protected

Echoes given string

Parameters

string $sOut string to echo

Definition at line 537 of file ajaxlistcomponent.php.

ajaxListComponent::_outputResponse ( $aData )

protected

Outputs JSON encoded data

Parameters

array $aData data to output

Definition at line 512 of file ajaxlistcomponent.php.

ajaxListComponent::_resetContentCache ( )

protected

Resets cache.

Definition at line 668 of file ajaxlistcomponent.php.

ajaxListComponent::getColumns ( )

Gets columns array.

Returns: array

Definition at line 65 of file ajaxlistcomponent.php.

ajaxListComponent::init ( $aColumns = null )

Initializes AJAX columns.

Parameters

array $aColumns Array of DB table columns which are loaded from DB.

Deprecated:: since v5.1.1 (2013.10.24); must be replaced with setColumns if needed

Definition at line 53 of file ajaxlistcomponent.php.

ajaxListComponent::processRequest ( $sFunction = null )

AJAX call processor function

Parameters

string $sFunction name of action to execute (optional)

Definition at line 148 of file ajaxlistcomponent.php.

ajaxListComponent::resetContentCache ( )

Reset output cache

Definition at line 623 of file ajaxlistcomponent.php.

ajaxListComponent::resetCounter	(	$sCounterType,
		$sValue = `null`
	)

Resets counters values from cache. Resets price category articles, category articles, vendor articles, manufacturer articles count.

Parameters

string	$sCounterType	counter type
string	$sValue	reset value

Definition at line 640 of file ajaxlistcomponent.php.

ajaxListComponent::setColumns ( $aColumns )

Sets columns array.

Parameters

array $aColumns columns array

Definition at line 75 of file ajaxlistcomponent.php.

ajaxListComponent::setName ( $sName )

AJAX container name setter

Parameters

string $sName name of container

Definition at line 104 of file ajaxlistcomponent.php.

Member Data Documentation

ajaxListComponent::$_aColumns = array()

protected

Definition at line 22 of file ajaxlistcomponent.php.

ajaxListComponent::$_aPosDir = array('asc', 'desc')

protected

Definition at line 15 of file ajaxlistcomponent.php.

ajaxListComponent::$_blAllowExtColumns = false

protected

Definition at line 44 of file ajaxlistcomponent.php.

ajaxListComponent::$_iSqlLimit = 2500

protected

Definition at line 29 of file ajaxlistcomponent.php.

ajaxListComponent::$_sContainer = null

protected

Definition at line 36 of file ajaxlistcomponent.php.

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

application/controllers/admin/ajaxlistcomponent.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation