No Matches
BxDolView Class Reference
Inheritance diagram for BxDolView:
BxDolObject BxDolFactory iBxDolReplaceable BxBaseView BxTemplView

Public Member Functions

 actionGetViewedBy ()
 actionGetUsers ()
 doView ()
 isAllowedView ($isPerformAction=false)
 isAllowedViewView ($isPerformAction=false)
 isAllowedViewViewViewers ($isPerformAction=false)
- 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)
 getElementAPI ($aParams=[])
 getCounterAPI ($aParams=[])
 getQueryObject ()
 checkAction ($sAction, $isPerformAction=false)
 checkActionErrorMsg ($sAction)
 onObjectDelete ($iObjectId=0)

Static Public Member Functions

static getObjectInstance ($sSys, $iId, $iInit=true)
static & getSystems ()
static onAuthorDelete ($iAuthorId)
- Static Public Member Functions inherited from BxDolObject
static pruning ()

Protected Member Functions

 __construct ($sSystem, $iId, $iInit=true, $oTemplate=false)
 _getIconDo ()
 _getTitleDo ()
- 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 ()

Additional Inherited Members

- Protected Attributes inherited from BxDolObject
 $_oTemplate = null
 $_oQuery = null
 $_bApi = false
 $_iId = 0
 $_sSystem = ''
 $_aSystem = array()
 $_aMarkers = array ()
 $_sTmplContentElementBlock = ''
 $_sTmplContentElementInline = ''
 $_sTmplContentDoActionLabel = ''
 $_sTmplContentCounter = ''
 $_sTmplContentCounterLabel = ''

Detailed Description

Track any object views automatically

Add record to sys_object_view table to track object views, to record view just create this class instance with your object id, for example:

BxDolView::getObjectInstance('my_system', 25); // 25 - is object id
static getObjectInstance($sSys, $iId, $iInit=true)
Definition BxDolView.php:71

Description of sys_object_view table fields:

`name` - system name, it is better to use unique module prefix here, lowercase and all spaces are underscored
`table_track` - table to track views
`period` - period in secs to update next views, default is 86400(1 day)
`is_on` - is the system activated
`trigger_table` - table where you need to update views field
`trigger_field_id` - table field id to unique determine object
`trigger_field_count` - table field where total view number is stored
`class_name` - your custom class name, if you overrride default class
`class_file` - your custom class path

Structure of the track table is the following:

CREATE TABLE `my_views_track` (
`object_id` int(11) NOT NULL default '0', -- this field type must be exact as your object id type
`viewer_id` int(11) NOT NULL default '0', -- viewer profile id
`viewer_nip` int(11) unsigned NOT NULL default '0', -- viewer ip address to track guest views
`date` int(11) NOT NULL default '0', -- timestamp of last recorded view
KEY `id` (`object_id`,`viewer_id`,`viewer_nip`)

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from BxDolObject.

Member Function Documentation

◆ _getIconDo()

BxDolView::_getIconDo ( )

Internal functions

◆ getObjectInstance()

static BxDolView::getObjectInstance ( $sSys,
$iInit = true )

get votes object instanse

$sSysview object name
$iIdassociated content id, where vote is available
$iInitperform initialization
null on error, or ready to use class instance

◆ getSystems()

static & BxDolView::getSystems ( )

Reimplemented from BxDolObject.

◆ isAllowedView()

BxDolView::isAllowedView ( $isPerformAction = false)

Permissions functions

Note. The 'view' action is performed automatically and therefore the manual action is not allowed.

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