OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax:

Public Member Functions
	getColumns ()
	setColumns ($aColumns)
	setName ($sName)
	processRequest ($function=null)
	resetArtSeoUrl ($aArtIds, $aCatIds=null)
	resetContentCache ()
	resetCounter ($sCounterType, $sValue=null)

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 ()
	_resetCaches ()

Protected Attributes
	$_aPosDir = ['asc', 'desc']
	$_aColumns = []
	$_iSqlLimit = 2500
	$_sContainer = null
	$_blAllowExtColumns = false

Detailed Description

AJAX call processor class

Member Function Documentation

_addFilter()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_addFilter (   $sQ )

protected

Adds filter SQL to current query

Parameters

string

$sQ

query to add filter condition

Returns

string

_buildColsQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_getActionIds()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_getAll()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getAll (   $sQ )

protected

Returns DB records as plain indexed array

Parameters

string

$sQ

SQL query

Returns

array

_getColNames()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_getCountQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getCountQuery (   $sQ )

protected

Return fully formatted query for data records count

Parameters

string

$sQ

part of initial query

Returns

string

_getData()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_getDataFields()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getDataFields (   $sQ )

protected

Returns array with DB records

Parameters

string

$sQ

SQL query

Returns

array

_getDataQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getDataQuery (   $sQ )

protected

Return fully formatted query for data loading

Parameters

string

$sQ

part of initial query

Returns

string

_getExtendedColQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_getFilter()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getFilter ( )

protected

Returns part of SQL query for filtering DB data

Returns

string

_getIdentColNames()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getIdentColNames ( )

protected

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

Returns

array

_getLimit()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getLimit (   $iStart )

protected

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

Parameters

int

$iStart

start position

Returns

string

_getQuery()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getQuery ( )

protected

Empty function, developer should override this method according requirements

Returns

string

_getQueryCols()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getQueryCols ( )

protected

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

Returns

string

_getSortCol()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getSortCol ( )

protected

Returns column id to sort

Returns

int

_getSortDir()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getSortDir ( )

protected

Checks user input and returns SQL sorting direction key

Returns

string

_getSorting()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getSorting ( )

protected

Formats and returns part of SQL query for sorting

Returns

string

_getStartIndex()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getStartIndex ( )

protected

Returns position from where data must be loaded

Returns

int

_getTotalCount()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getTotalCount (   $sQ )

protected

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

Parameters

string

$sQ

SQL query

Returns

int

_getViewName()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_getVisibleColNames()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_getVisibleColNames ( )

protected

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

Returns

array

_isExtendedColumn()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_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

_output()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_output (   $sOut )

protected

Echoes given string

Parameters

string

$sOut

string to echo

_outputResponse()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_outputResponse (   $aData )

protected

Outputs JSON encoded data

Parameters

array

$aData

data to output

_resetCaches()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_resetCaches ( )

protected

Resets output caches

_resetContentCache()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::_resetContentCache ( )

protected

Resets content cache.

getColumns()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::getColumns

(

)

Gets columns array.

Returns

array

processRequest()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::processRequest

(

$function = null

)

AJAX call processor function

Parameters

string

$function

name of action to execute (optional)

resetArtSeoUrl()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::resetArtSeoUrl	(		$aArtIds,
			$aCatIds = null
	)

Marks article seo url as expired

Parameters

array	$aArtIds	article id's
array	$aCatIds	ids if categories, which must be removed from oxseo

Returns

null

resetContentCache()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::resetContentCache

(

)

Reset output cache

resetCounter()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::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

setColumns()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::setColumns

(

$aColumns

)

Sets columns array.

Parameters

array

$aColumns

columns array

setName()

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::setName

(

$sName

)

AJAX container name setter

Parameters

string

$sName

name of container

Member Data Documentation

$_aColumns

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::$_aColumns = []

protected

$_aPosDir

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::$_aPosDir = ['asc', 'desc']

protected

$_blAllowExtColumns

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::$_blAllowExtColumns = false

protected

$_iSqlLimit

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::$_iSqlLimit = 2500

protected

$_sContainer

OxidEsales\EshopCommunity\Application\Controller\Admin\ListComponentAjax::$_sContainer = null

protected

---

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

• /oxideshop-ce/source/Application/Controller/Admin/ListComponentAjax.php