Inheritance diagram for BxDolFavorite:

Public Member Functions
	actionFavorite ()

	isAllowedFavorite ($isPerformAction=false)

	isUndo ()

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)

Protected Member Functions
	_getIconDoFavorite ($bPerformed)

Protected Member Functions inherited from BxDolObject
	_getAuthorId ()

	_trigger ()

	_triggerValue ($iValue)

	_replaceMarkers ($mixed)

Detailed Description

Track any object favorites automatically

Add record to sys_object_favorite table to track object favorites, to record favorites just create this class instance with your object id, for example:

BxDolFavorite::getObjectInstance('my_system', 25); // 25 - is object id

Description of sys_object_favorite 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 favorites
`table_lists` - table with lists 
`is_on` - is the system activated
`trigger_table` - table where you need to update favorites field
`trigger_field_id` - table field id to unique determine object
`trigger_field_count` - table field where total favorites 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_favorites_track` (
    `object_id` int(11) NOT NULL default '0', -- this field type must be exact as your object id type
    `author_id` int(11) NOT NULL default '0', -- favoring user profile id
    `date` int(11) NOT NULL default '0', -- timestamp of last recorded view
    KEY `id` (`object_id`,`author_id`)
);

Member Function Documentation

◆ _getIconDoFavorite()

BxDolFavorite::_getIconDoFavorite ( $bPerformed )

protected

Internal functions

◆ actionFavorite()

BxDolFavorite::actionFavorite ( )

Actions functions

◆ getObjectInstance()

static BxDolFavorite::getObjectInstance	(	$sSys,
		$iId,
		$iInit = `true`
	)

static

get favorites object instanse

Parameters

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

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

◆ isAllowedFavorite()

BxDolFavorite::isAllowedFavorite ( $isPerformAction = false )

Permissions functions

◆ isUndo()

BxDolFavorite::isUndo ( )

Auxiliary functions

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

inc/classes/BxDolFavorite.php

Public Member Functions

Static Public Member Functions