BxBaseGrid Class Reference

Inheritance diagram for BxBaseGrid:

Public Member Functions
	__construct ($aOptions, $oTemplate)
	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)

Protected Member Functions
	_getRowHead ()
	_getRowHeadAPI ()
	_getCellHeaderDefault ($sKey, $aField)
	_getCellHeaderCheckbox ($sKey, $aField)
	_getCellHeaderWrapper ($sKey, $aField, $sHeader, $sAttr)
	_isRowDisabled ($aRow)
	_getActionsDisabledBehavior ($aRow)
	_isCheckboxDisabled ($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=[])
	_getCounter ()
	_limitMaxLength ($mixedValue, $sKey, $aField, $aRow, $isDisplayPopupOnTextOverflow, $bReturnString=true)
	_convertAttrs ($aField, $sAttrName, $sClasses=false, $sStyles=false)
	_updateOrder ($mixedId, $iOrder)
	_delete ($mixedId)
	_enable ($mixedId, $isChecked)
	_addJsCss ()
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)
	_getDataSqlWhereClause ($sFilter, &$sOrderByFilter)
	_getDataSqlOrderClause ($sOrderByFilter, $sOrderField, $sOrderDir, $bFieldsOnly=false)
	_getCellData ($sKey, $aField, $aRow)
	_cmp ($r1, $r2)
	_genMethodName ($s)
	_isVisibleGrid ($a)
	_getFilterValue ()
	_getOrderValue ()

Protected Attributes
	$_oTemplate
	$_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

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)

Detailed Description

Grid representation.

See also

BxDolGrid

Member Function Documentation

_addJsCss()

BxBaseGrid::_addJsCss ( )

protected

Reimplemented in BxAntispamGridDNSBL, BxAntispamGridIpTable, and BxOAuthGrid.

_getActionsDisabledBehavior()

BxBaseGrid::_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 in BxBaseStudioAgentsAutomators, BxBaseStudioAgentsHelpers, BxBaseStudioAgentsProviders, BxBaseStudioFormsFields, and BxBaseStudioNavigationItems.

_isCheckboxDisabled()

BxBaseGrid::_isCheckboxDisabled ( $aRow )

protected

Check if the checkbox is disabled.

Parameters

$aRow

row array

Returns

boolean

Reimplemented in BxAccntGridAdministration, BxBaseStudioAgentsAutomators, BxBaseStudioAgentsHelpers, BxBaseStudioAgentsProviders, BxNtfsGridSettingsAdministration, BxSpacesGridAdministration, and BxSpacesGridCommon.

_isCheckboxSelected()

BxBaseGrid::_isCheckboxSelected ( $mixedValue, $sKey, $aField, $aRow )

protected

Is checkbox checked by default ? By default no one checkbox is selected.

Returns

boolean

_isRowDisabled()

BxBaseGrid::_isRowDisabled ( $aRow )

protected

Check if the whole row is disabled. When row is disabled - checkbox is not selectable, actions aren't clickable and text is grayed out. By default all rows aren't disabled.

Parameters

$aRow

row array

Returns

boolean

Reimplemented in BxBaseModTextGridCommon, BxDolStudioPermissionsActions, BxDolStudioRolesActions, and BxTimelineGridCommon.

_isSwitcherOn()

BxBaseGrid::_isSwitcherOn ( $mixedValue, $sKey, $aField, $aRow )

protected

Is switcher on by default ? By default no one switcher is on.

Returns

boolean

_switcherChecked2State()

BxBaseGrid::_switcherChecked2State ( $isChecked )

protected

Convert switcher checked status to the actual value ?

Returns

boolean

Reimplemented in BxBaseModGroupsGridAdministration, BxBaseModProfileGridAdministration, BxBaseModTextGridAdministration, BxBaseStudioFormsCategories, BxDolCmtsGridAdministration, BxDolStudioPermissionsLevels, BxFdbGridQuestions, and BxTimelineGridManageTools.

_switcherState2Checked()

BxBaseGrid::_switcherState2Checked ( $mixedState )

protected

Convert switcher value to checked(boolean) value ?

Returns

boolean

Reimplemented in BxBaseModGeneralGridAdministration, BxBaseModGroupsGridAdministration, BxBaseStudioFormsCategories, BxDolCmtsGridAdministration, BxDolStudioPermissionsLevels, BxFdbGridQuestions, and BxTimelineGridManageTools.

getCodeAPI()

BxBaseGrid::getCodeAPI

(

$bForceReturn = false

)

Get grid code API.

Returns

array

Reimplemented in BxBaseModGroupsGridinvites, BxPaymentGridCart, and BxPaymentGridCarts.

resetQueryParams()

BxBaseGrid::resetQueryParams

(

)

Reset query params, like filter and page number

---

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

• template/scripts/BxBaseGrid.php