BxBaseFavorite Class Reference

Inheritance diagram for BxBaseFavorite:

Public Member Functions
	__construct ($sSystem, $iId, $iInit=1, $oTemplate=false)
	getJsObjectName ()
	getJsScript ($bDynamicMode=false)
	getJsClick ()
	getCounter ($aParams=[])
	getElementBlock ($aParams=array())
	getElementInline ($aParams=array())
	getElement ($aParams=array())
Public Member Functions inherited from BxDolFavorite
	getConditionsTrack ($sMainTable, $sMainField, $iAuthorId=0, $iListId=0)
	actionFavorite ()
	actionEditList ()
	actionDeleteList ()
	actionGetFavoritedBy ()
	isAllowedFavorite ($isPerformAction=false)
	isAllowedEditList ($iAuthorId, $isPerformAction=false)
	msgErrAllowedFavorite ()
	isAllowedFavoriteView ($isPerformAction=false)
	msgErrAllowedFavoriteView ()
	isUndo ()
	isPublic ()
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)

Protected Member Functions
	_getDoFavorite ($aParams=array(), $bAllowedFavorite=true)
	_getCounterLabel ($iCount)
	_getLabelDoFavorite ($aParams=array())
	_getFavorite ()
	_getEditList ($aData)
	_getFavoritedBy ()
Protected Member Functions inherited from BxDolFavorite
	_getIconDoFavorite ($bPerformed)
	_getTitleDoFavorite ($bPerformed)
	_getFormObject ($sDisplayName)
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
Protected Attributes inherited from BxDolFavorite
	$_sBaseUrl
	$_sFormObject
	$_sFormDisplayAdd
	$_sFormDisplayListEdit
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 BxDolFavorite
static	getObjectInstance ($sSys, $iId, $iInit=true)
static &	getSystems ()
static	onAuthorDelete ($iAuthorId)
Static Public Member Functions inherited from BxDolObject
static	pruning ()

Detailed Description

See also

BxDolFavorite

Constructor & Destructor Documentation

__construct()

BxBaseFavorite::__construct	(		$sSystem,
			$iId,
			$iInit = 1,
			$oTemplate = false )

Reimplemented from BxDolFavorite.

Member Function Documentation

_getFavorite()

BxBaseFavorite::_getFavorite ( )

protected

Hooks:

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

• $unit_name - equals favorite
• $action - can be do/undo
• $object_id - not used
• $sender_id - profile_id for favorite'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

    hook-favorite-undo

Hooks:

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

• $unit_name - equals favorite
• $action - equals favorite
• $object_id - favorited object id
• $sender_id - profile_id for favorite'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
  • list_ids - [array] array of id's list

    HOOKS

    hook-favorite-do

---

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

• template/scripts/BxBaseFavorite.php