BxBaseLiveUpdates Class Reference

Inheritance diagram for BxBaseLiveUpdates:

Public Member Functions
	init ($aParams=array())
	add ($sName, $iFrequency, $sServiceCall, $bActive=true, $mixedValue=false)
Public Member Functions inherited from BxDolLiveUpdates
	__clone ()
	perform ()

Additional Inherited Members
Static Public Member Functions inherited from BxDolLiveUpdates
static	getInstance ()
Protected Member Functions inherited from BxDolLiveUpdates
	_addSystem ($sName, $iFrequency, $sServiceCall, $mixedActive=true)
	_addData ($sName, $iValue)
	_getCacheInfo ($sType)
	_getCacheKey ($sType)
	_getCached ($sType)
	_getCachedSystems ()
	_getCachedData ($bInit=false)
	_clearCached ()
	_updateCached ($sType, $aData)
	_getRequestedData ($iIndex=0, $bIndexCheck=false, $aCachedData=array())
	_getRequestedDataBySystem ($aSystem, $iCachedData=0, $bInit=true)
	_getPageId ()
	_encodeHash ()
	_decodeHash ($sHash)
Protected Attributes inherited from BxDolLiveUpdates
	$_oQuery
	$_aSystems
	$_aSystemsActive
	$_aSystemsTransient
	$_iProfileId
	$_iInterval
	$_oCacheObject
	$_sCacheKeySystems
	$_sCacheKeyData
	$_iCacheTTL
	$_sJsClass
	$_sJsObject

Detailed Description

See also

BxDolLiveUpdates

Constructor & Destructor Documentation

__construct()

BxBaseLiveUpdates::__construct

(

)

Reimplemented from BxDolLiveUpdates.

Member Function Documentation

add()

BxBaseLiveUpdates::add	(		$sName,
			$iFrequency,
			$sServiceCall,
			$bActive = true,
			$mixedValue = false )

Add transient live update for current user on this current page.

Parameters

string	$sName	- unique name.
integer	$iFrequency	- call frequency.
string	$sServiceCall	- serialized service call.
boolean	$bActive	- add active/not active live update.
mixed	$mixedValue	- a value (mainly integer) which will be used as initial value. When it's false then initial data will be gotten automatically using provided serialized service call.

---

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

• template/scripts/BxBaseLiveUpdates.php