BxBaseReport Class Reference

Inheritance diagram for BxBaseReport:

Public Member Functions
	__construct ($sSystem, $iId, $iInit=true, $oTemplate=false)
	report ($aParams=[])
	getJsObjectName ()
	getJsScript ($bDynamicMode=false)
	getJsClick ()
	getCounter ($aParams=[])
	getCounterAPI ($aParams=[])
	getElementBlock ($aParams=array())
	getElementInline ($aParams=array())
	getElement ($aParams=array())
	getElementAPI ($aParams=[])
	getReportedByWithComments ($sObjectNotes)
	getPerformedByAPI ($aParams=[])
Public Member Functions inherited from BxDolReport
	isUndo ()
	getBaseUrl ()
	getStatCounter ()
	getCountByStatus ($iStatus)
	getSocketName ()
	actionReport ()
	actionClearReport ()
	actionGetReportedBy ()
	isAllowedReport ($isPerformAction=false)
	msgErrAllowedReport ()
	isAllowedReportView ($isPerformAction=false)
	changeStatusReport ($iStatus, $iAuthorId, $sCmtText)
	msgErrAllowedReportView ()
Public Member Functions inherited from BxDolObject
	init ($iId)
	getSystemId ()
	getSystemName ()
	getSystemInfo ()
	getId ()
	setId ($iId)
	isEnabled ()
	isPerformed ($iObjectId, $iAuthorId, $iAuthorIp=0)
	getVote ($iObjectId=0, $bForceGet=false)
	getTrack ($iObjectId, $iAuthorId)
	getConditions ($sMainTable, $sMainField)
	getConditionsTrack ($sMainTable, $sMainField, $iAuthorId=0)
	getSqlParts ($sMainTable, $sMainField)
	getSqlPartsTrack ($sMainTable, $sMainField, $iAuthorId=0)
	getSqlPartsTrackAuthor ($sMainTable, $sMainField, $iObjectId=0)
	addMarkers ($aMarkers)
	getQueryObject ()
	checkAction ($sAction, $isPerformAction=false)
	checkActionErrorMsg ($sAction)
	onObjectDelete ($iObjectId=0)

Protected Member Functions
	_getDoReport ($aParams=array())
	_getCounterLabel ($iCount)
	_getLabelDoReport ($aParams=array())
	_getReportedBy ()
	_returnReportData ($iObjectId, $iAuthorId, $iReportId, $aData, $bPerformed)
	_returnReportDataForSocket ($aData, $aMask=[])
	_isShowDoReport ($aParams, $isAllowedReport, $isAllowedReportView, $bCount)
	_isShowCounter ($aParams, $isAllowedReport, $isAllowedReportView, $bCount)
Protected Member Functions inherited from BxDolReport
	_isCount ($aVote=array())
	_getReport ($iObjectId=0, $bForceGet=false)
	_isReport ($iObjectId=0, $bForceGet=false)
	_getTrack ($iObjectId, $iAuthorId)
	_getIconDoReport ($bPerformed)
	_getTitleDoReport ($bPerformed)
	_getFormObject ()
Protected Member Functions inherited from BxDolObject
	_getAuthorId ()
	_getAuthorPassword ()
	_getAuthorIp ()
	_getAuthorInfo ($iAuthorId=0)
	_getAuthorObject ($iAuthorId=0)
	_trigger ()
	_triggerValue ($iValue)
	_replaceMarkers ($mixed)
	_prepareParamsData ($aParams)
	_getRequestParamsData ($aKeys=array())
	_prepareRequestParamsData ($aParams, $aParamsAdd=array())
	_getTmplContentElementBlock ()
	_getTmplContentElementInline ()
	_getTmplContentDoAction ()
	_getTmplContentDoActionLabel ()
	_getTmplContentCounter ()
	_getTmplContentCounterLabel ()

Protected Attributes
	$_bCssJsAdded
	$_sJsObjClass
	$_sJsObjName
	$_sStylePrefix
	$_aHtmlIds
	$_aElementDefaults
	$_aElementDefaultsApi
	$_aElementParamsApi
Protected Attributes inherited from BxDolReport
	$_oTemplate
	$_bUndo
	$_sBaseUrl
	$_sObjectCmts
	$_sFormObject
	$_sFormDisplayPost
	$_sTypesPreList
	$_aTypes
	$_aReport
Protected Attributes inherited from BxDolObject
	$_oTemplate = null
	$_oQuery = null
	$_bApi = false
	$_iId = 0
	$_sSystem = ''
	$_aSystem = array()
	$_aMarkers = array ()
	$_sTmplContentElementBlock = ''
	$_sTmplContentElementInline = ''
	$_sTmplContentDoAction
	$_sTmplContentDoActionLabel = ''
	$_sTmplContentCounter = ''
	$_sTmplContentCounterLabel = ''

Additional Inherited Members
Static Public Member Functions inherited from BxDolReport
static	getObjectInstance ($sSys, $iId, $iInit=true, $oTemplate=false)
static &	getSystems ()
static	onAuthorDelete ($iAuthorId)
Static Public Member Functions inherited from BxDolObject
static	pruning ()

Detailed Description

See also

BxDolReport

Constructor & Destructor Documentation

__construct()

BxBaseReport::__construct	(		$sSystem,
			$iId,
			$iInit = true,
			$oTemplate = false )

Reimplemented from BxDolReport.

Member Function Documentation

_getDoReport()

BxBaseReport::_getDoReport ( $aParams = array() )

protected

Internal methods.

getCounterAPI()

BxBaseReport::getCounterAPI

(

$aParams = []

)

Reimplemented from BxDolObject.

getElementAPI()

BxBaseReport::getElementAPI

(

$aParams = []

)

Reimplemented from BxDolObject.

report()

BxBaseReport::report

(

$aParams = []

)

Hooks:

'favorite', 'favorite' - hook on add new object to favorites lists or remove object from favorites lists

• $unit_name - equals report
• $action - equals undo
• $object_id - report id
• $sender_id - profile_id for report's author
• $extra_params - array of additional params with the following array keys:
  • object_system - [string] system name, ex: bx_posts
  • object_id - [int] reported object id
  • object_author_id - [int] author's profile_id for reported object_id

    HOOKS

    'favorite', 'favorite' - hook on add new object to favorites lists or remove object from favorites lists

Hooks:

'favorite', 'favorite' - hook on add new object to favorites lists

• $unit_name - equals report
• $action - equals do
• $object_id - report id
• $sender_id - profile_id for report's author
• $extra_params - array of additional params with the following array keys:
  • object_system - [string] system name, ex: bx_posts
  • object_id - [int] reported object id
  • object_author_id - [int] author's profile_id for reported object_id
  • type - [string] report type
  • text - [bool] report text

    HOOKS

    'favorite', 'favorite' - hook on add new object to favorites lists

---

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

• template/scripts/BxBaseReport.php