BxDolVote Class Reference

Inheritance diagram for BxDolVote:

Public Member Functions
	getObjectAuthorId ($iObjectId=0)
	isUndo ()
	getType ()
	getMinValue ()
	getMaxValue ()
	getStatCounter ()
	getStatRate ()
	getSocketName ()
	actionVote ()
	vote ($aVoteData=[], $aRequestParamsData=[])
	actionGetVotedBy ()
	isAllowedVote ($isPerformAction=false)
	msgErrAllowedVote ()
	isAllowedVoteView ($isPerformAction=false)
	msgErrAllowedVoteView ()
	isAllowedVoteViewVoters ($isPerformAction=false)
	msgErrAllowedVoteViewVoters ()
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, $oTemplate=false)
static &	getSystems ()
static	onAuthorDelete ($iAuthorId)
Static Public Member Functions inherited from BxDolObject
static	pruning ()

Protected Member Functions
	__construct ($sSystem, $iId, $iInit=true, $oTemplate=false)
	_isDuplicate ($iObjectId, $iAuthorId, $iAuthorIp, $bVoted)
	_isCount ($aVote=array())
	_isAllowedVoteByObject ($aObject)
	_getVoteData ()
	_putVoteData ($iObjectId, $iAuthorId, $iAuthorIp, $aData, $bPerformUndo)
	_returnVoteData ($iObjectId, $iAuthorId, $iAuthorIp, $aData, $bVoted, $aParams=[])
	_returnVoteDataForSocket ($aData, $aMask=[])
	_prepareRequestParamsData ($aParams, $aParamsAdd=array())
	_getVote ($iObjectId=0, $bForceGet=false)
	_isVote ($iObjectId=0, $bForceGet=false)
	_getTrack ($iObjectId, $iAuthorId)
	_getIconDo ($bVoted)
	_getImageDo ($bVoted)
	_getEmojiDo ($bVoted)
	_getTitleDo ($bVoted)
	_getTitleDoBy ($aParams=[])
	_useIconAs ($aParams=[])
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())
	_getTmplContentElementBlock ()
	_getTmplContentElementInline ()
	_getTmplContentDoAction ()
	_getTmplContentDoActionLabel ()
	_getTmplContentCounter ()
	_getTmplContentCounterLabel ()

Protected Attributes
	$_sType
	$_aVote
	$_aElementDefaults
	$_aElementDefaultsApi
	$_aElementParamsApi
Protected Attributes inherited from BxDolObject
	$_oTemplate = null
	$_oQuery = null
	$_bApi = false
	$_iId = 0
	$_sSystem = ''
	$_aSystem = array()
	$_aMarkers = array ()
	$_sTmplContentElementBlock = ''
	$_sTmplContentElementInline = ''
	$_sTmplContentDoAction
	$_sTmplContentDoActionLabel = ''
	$_sTmplContentCounter = ''
	$_sTmplContentCounterLabel = ''

Detailed Description

Vote for any content

Related classes:

• BxDolVoteQuery - vote database queries
• BxBaseVote - vote base representation
• BxTemplVote - custom template representation

AJAX vote for any content. Stars and Plus based representations are supported.

To add vote section to your feature you need to add a record to 'sys_objects_vote' table:

• ID - autoincremented id for internal usage
• Name - your unique module name, with vendor prefix, lowercase and spaces are underscored
• TableMain - table name where summary votigs are stored
• TableTrack - table name where each vote is stored
• PostTimeout - number of seconds to not allow duplicate vote
• MinValue - min vote value, 1 by default
• MaxValue - max vote value, 5 by default
• IsUndo - is Undo enabled for Plus based votes
• IsOn - is this vote object enabled
• TriggerTable - table to be updated upon each vote
• TriggerFieldId - TriggerTable table field with unique record id, primary key
• TriggerFieldRate - TriggerTable table field with average rate
• TriggerFieldRateCount - TriggerTable table field with votes count
• ClassName - your custom class name, if you overrride default class
• ClassFile - your custom class path

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

Example of usage

To get Star based vote you need to have different values for MinValue and MaxValue (for example 1 and 5) and IsUndo should be equal to 0. To get Plus(Like) based vote you need to have equal values for MinValue and MaxValue (for example 1) and IsUndo should be equal to 1. After filling the other paramenters in the table you can show vote in any place, using the following code:

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

Memberships/ACL:

• vote

Alerts(hooks)

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

• rate - comment was posted
  • $iObjectId - entry id
  • $iSenderId - rater user id
  • $aExtra['rate'] - rate

Constructor & Destructor Documentation

__construct()

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

protected

Reimplemented from BxDolObject.

Member Function Documentation

_getIconDo()

BxDolVote::_getIconDo ( $bVoted )

protected

Reimplemented in BxPollsVoteSubentries.

_isAllowedVoteByObject()

BxDolVote::_isAllowedVoteByObject ( $aObject )

protected

Reimplemented in BxBaseModTextVotePollAnswers.

_isDuplicate()

BxDolVote::_isDuplicate ( $iObjectId, $iAuthorId, $iAuthorIp, $bVoted )

protected

Internal functions

Reimplemented in BxDolVoteLikes, BxDolVoteReactions, and BxDolVoteStars.

_isVote()

BxDolVote::_isVote ( $iObjectId = 0, $bForceGet = false )

protected

Reimplemented in BxDolVoteReactions.

_prepareRequestParamsData()

BxDolVote::_prepareRequestParamsData ( $aParams, $aParamsAdd = array() )

protected

Reimplemented from BxDolObject.

actionVote()

BxDolVote::actionVote

(

)

Actions functions

getObjectInstance()

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

static

get votes object instanse

Parameters

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

Returns

null on error, or ready to use class instance

getSystems()

static & BxDolVote::getSystems ( )

static

Reimplemented from BxDolObject.

isAllowedVote()

BxDolVote::isAllowedVote

(

$isPerformAction = false

)

Permissions functions

Reimplemented in BxBaseModTextVotePollAnswers, BxMarketVoteReactions, BxMarketVoteStars, and BxPollsVoteSubentries.

isUndo()

BxDolVote::isUndo

(

)

Interface functions for outer usage

vote()

BxDolVote::vote	(		$aVoteData = [],
			$aRequestParamsData = [] )

Hooks:

'vote', 'undo' - hook on cancel vote

• $unit_name - equals vote
• $action - equals undo
• $object_id - vote id
• $sender_id - profile_id for vote'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

    'vote', 'undo' - hook on cancel vote

Hooks:

'vote', 'do' - hook on new vote

• $unit_name - equals vote
• $action - equals do
• $object_id - vote id
• $sender_id - profile_id for vote'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

    'vote', 'do' - hook on new vote

---

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

• inc/classes/BxDolVote.php