Inheritance diagram for BxDolReport:

Public Member Functions
	isUndo ()

	actionReport ()

	isAllowedReport ($isPerformAction=false)

Public Member Functions inherited from BxDolObject
	getConditions ($sMainTable, $sMainField)

	getQueryObject ()

	checkAction ($sAction, $isPerformAction=false)

	onObjectDelete ($iObjectId=0)

Static Public Member Functions
static	getObjectInstance ($sSys, $iId, $iInit=true, $oTemplate=false)

Protected Member Functions
	_isCount ($aVote=array())

Protected Member Functions inherited from BxDolObject
	_getAuthorId ()

	_trigger ()

	_triggerValue ($iValue)

	_replaceMarkers ($mixed)

Detailed Description

Report any content

Related classes:

BxDolReportQuery - report database queries
BxBaseReport - report base representation
BxTemplReport - custom template representation

AJAX report for any content.

To add report section to your feature you need to add a record to 'sys_objects_report' table:

id - autoincremented id for internal usage
name - your unique module name, with vendor prefix, lowercase and spaces are underscored
table_main - table name where summary reports are stored
table_track - table name where each report is stored
is_on - is this report object enabled
base_url - base URL for reported object
trigger_table - table to be updated upon each report
trigger_field_id - trigger_table table field with unique record id, primary key
trigger_field_author - trigger_table table field with author
trigger_field_count - trigger_table table field with reports count
class_name - your custom class name, if you overrride default class
class_file - your custom class path

You can refer to BoonEx modules for sample record in this table.

Example of usage

You can show report in any place, using the following code:

$o = BxDolReport::getObjectInstance('system object name', $iYourEntryId);
if (!$o->isEnabled()) 
    return '';
echo $o->getElementBlock();

Memberships/ACL:

report
report view

Alerts(hooks)

Alerts type/unit - every module has own type/unit, it equals to ObjectName. The following alerts are rised:

type: 'object name', action: doReport
type: report, action: do

Member Function Documentation

◆ _isCount()

BxDolReport::_isCount ( $aVote = array() )

protected

Internal functions

◆ actionReport()

BxDolReport::actionReport ( )

Actions functions

◆ getObjectInstance()

static BxDolReport::getObjectInstance	(	$sSys,
		$iId,
		$iInit = `true`,
		$oTemplate = `false`
	)

static

get reports object instanse

Parameters

$sSys	report object name
$iId	associated content id, where report is available
$iInit	perform initialization

Returns: null on error, or ready to use class instance

◆ isAllowedReport()

BxDolReport::isAllowedReport ( $isPerformAction = false )

Permissions functions

◆ isUndo()

BxDolReport::isUndo ( )

Interface functions for outer usage

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

inc/classes/BxDolReport.php

Public Member Functions

Static Public Member Functions

Protected Member Functions