BxBaseStudioGridAgents Class Reference

Inheritance diagram for BxBaseStudioGridAgents:

Public Member Functions
	__construct ($aOptions, $oTemplate=false)
Public Member Functions inherited from BxBaseStudioGrid
	getJsObject ()
	getModulesSelectOneArray ($sGetItemsMethod, $bShowCustom=true, $bShowSystem=true)
	getModulesSelectOne ($sGetItemsMethod, $bShowCustom=true, $bShowSystem=true)
	getSearchInput ()
Public Member Functions inherited from BxDolStudioGrid
	getSystemName ($sValue)
	getClassName ($sValue)
Public Member Functions inherited from BxBaseGrid
	performActionDisplay ()
	performActionReorder ()
	performActionDelete ()
	performActionEnable ($mixedChecked=null)
	getCode ($isDisplayHeader=true)
	getCodeAPI ($bForceReturn=false)
	decodeDataAPI ($aData)
	getFormBlockAPI ($oForm, $sAction, $iId=0)
	getFormBlockTitleAPI ($sAction, $iId)
	getFormCallBackUrlAPI ($sAction, $iId)
	resetQueryParams ()
Public Member Functions inherited from BxDolGrid
	getObject ()
	addMarkers ($a)
	setBrowseParams ($aBrowseParams)
	setActionCsrfChecking ($bCsrfChecking)
	isActionCsrfCheckingDisabled ()

Protected Member Functions
	_getCellModelId ($mixedValue, $sKey, $aField, $aRow)
	_getCellProfileId ($mixedValue, $sKey, $aField, $aRow)
	_getCellAdded ($mixedValue, $sKey, $aField, $aRow)
	_getActionTune ($sType, $sKey, $a, $isSmall=false, $isDisabled=false, $aRow=[])
	_addJsCss ()
	_isCheckboxDisabled ($aRow)
	_getActionsDisabledBehavior ($aRow)
	_getFormControls ()
	_getId ()
Protected Member Functions inherited from BxBaseStudioGrid
	_getFilterOnChange ()
	_getItem ($sDbMethod='')
	_getIconPreview ($iId, $sIconImage='', $sIcon='')
Protected Member Functions inherited from BxDolStudioGrid
	getModuleTitle ($sName)
	getModules ($bShowCustom=true, $bShowSystem=true)
	_isVisibleGrid ($a)
Protected Member Functions inherited from BxBaseGrid
	_getRowHead ()
	_getRowHeadAPI ()
	_resizeCellAPI ($sKey, $aField, &$aHeader)
	_getCellHeaderDefault ($sKey, $aField)
	_getCellHeaderCheckbox ($sKey, $aField)
	_getCellHeaderWrapper ($sKey, $aField, $sHeader, $sAttr)
	_isRowDisabled ($aRow)
	_isCheckboxSelected ($mixedValue, $sKey, $aField, $aRow)
	_isSwitcherOn ($mixedValue, $sKey, $aField, $aRow)
	_switcherChecked2State ($isChecked)
	_switcherState2Checked ($mixedState)
	_getRowsDataDesign (&$aData)
	_getRowId ($mixedRow)
	_getRowDesign ($mixedRow)
	_getCellDesign ($sKey, $aField, $aRow)
	_getCellCheckbox ($mixedValue, $sKey, $aField, $aRow)
	_getCellSwitcher ($mixedValue, $sKey, $aField, $aRow)
	_getCellOrder ($mixedValue, $sKey, $aField, $aRow)
	_getCellActions ($mixedValue, $sKey, $aField, $aRow)
	_getCellDefault ($mixedValue, $sKey, $aField, $aRow)
	_getActions ($sType, $sActionData=false, $isSmall=false, $isDisabled=false, $isPermanentState=false, $aRow=array())
	_getActionsAPI ($sType)
	_getActionDelete ($sType, $sKey, $a, $isSmall=false, $isDisabled=false, $aRow=array())
	_getActionDefault ($sType, $sKey, $a, $isSmall=false, $isDisabled=false, $aRow=array())
	_getActionDivider ($sType, $sKey, $a, $isSmall=false, $isDisabled=false, $aRow=array())
	_getActionResult ($aResult)
	_getFilterControls ()
	_getFilterControlsAPI ($aFilters=[])
	_getFilterSelectOne ($sFilterName, $sFilterValue, $aFilterValues, $mixedAddSelectOne=true, $bAsArray=false)
	_getFilterDatePicker ($sFilterName, $sFilterValue, $bAsArray=false)
	_getFilterButton ($bAsArray=false)
	_getFilterLabel ($sFilterValue, $bAsArray=false)
	_getSearchInput ($bAsArray=false)
	_getCounter ()
	_limitMaxLength ($mixedValue, $sKey, $aField, $aRow, $isDisplayPopupOnTextOverflow, $bReturnString=true)
	_convertAttrs ($aField, $sAttrName, $sClasses=false, $sStyles=false)
	_updateOrder ($mixedId, $iOrder)
	_delete ($mixedId)
	_enable ($mixedId, $isChecked)
Protected Member Functions inherited from BxDolGrid
	__construct ($aOptions)
	_replaceMarkers ()
	_getData ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage)
	_getDataArray ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage)
	_getDataSql ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage)
	_getDataSqlCounter ($sQuery, $sFilter)
	_modifyDataSqlWhereClause ($sQuery, $sFilter, &$sOrderByFilter)
	_getDataSqlWhereClause ($sFilter, &$sOrderByFilter)
	_getDataSqlOrderClause ($sOrderByFilter, $sOrderField, $sOrderDir, $bFieldsOnly=false)
	_getCellData ($sKey, $aField, $aRow)
	_cmp ($r1, $r2)
	_genMethodName ($s)
	_getFilterValue ()
	_getOrderFields ($bTranslatable=false)
	_getOrderFieldsTranslatable ()
	_getOrderValue ()

Additional Inherited Members
Static Public Member Functions inherited from BxDolGrid
static	getObjectInstance ($sObject, $oTemplate=false)
Static Public Member Functions inherited from iBxDolFactoryObject
static	getObjectInstance ($sObject)
Public Attributes inherited from BxDolStudioGrid
	$oDb
Protected Attributes inherited from BxDolStudioGrid
	$sParamsDivider
Protected Attributes inherited from BxBaseGrid
	$_oTemplate
	$_oFunctions
	$_aPopupOptions = false
	$_aQueryAppend = []
	$_aQueryAppendExclude = false
	$_aQueryAppendExcludeApi = false
	$_aQueryReset = false
	$_aConfirmMessages = false
	$_bSelectAll = false
	$_isDisplayPopupOnTextOverflow = true
Protected Attributes inherited from BxDolGrid
	$_bIsApi
	$_aMarkers = array ()
	$_sObject
	$_aOptions
	$_aBrowseParams
	$_sDefaultSortingOrder = 'ASC'
	$_iTotalCount = 0
	$_bActionCsrfChecking

Constructor & Destructor Documentation

__construct()

BxBaseStudioGridAgents::__construct	(		$aOptions,
			$oTemplate = false )

Reimplemented from BxTemplStudioGrid.

Member Function Documentation

_addJsCss()

BxBaseStudioGridAgents::_addJsCss ( )

protected

Reimplemented from BxBaseGrid.

_getActionsDisabledBehavior()

BxBaseStudioGridAgents::_getActionsDisabledBehavior ( $aRow )

protected

Determine how actions are disabled when whole row is disabled.

Parameters

$aRow

row array

Returns

null - disable/enable actions when row is disabled/enabled, true - actions are always disabled, false - actions are always enabled

Reimplemented from BxBaseGrid.

_isCheckboxDisabled()

BxBaseStudioGridAgents::_isCheckboxDisabled ( $aRow )

protected

Check if the checkbox is disabled.

Parameters

$aRow

row array

Returns

boolean

Reimplemented from BxBaseGrid.

---

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

• studio/template/scripts/BxBaseStudioGridAgents.php