ChWsbSubscription Class Reference

Public Member Functions
	__construct ()
	getMySubscriptions ()
	getData ($bDynamic=false)
	getButton ($iUserId, $sUnit, $sAction='', $iObjectId=0)
	subscribeVisitor ($sUserName, $sUserEmail, $sUnit, $sAction, $iObjectId=0)
	unsubscribeVisitor ($sUserName, $sUserEmail, $sUnit, $sAction, $iObjectId=0)
	subscribeMember ($iUserId, $sUnit, $sAction, $iObjectId=0)
	unsubscribeMember ($iUserId, $sUnit, $sAction, $iObjectId=0)
	unsubscribe ($aParams)
	send ($sUnit, $sAction, $iObjectId=0, $aExtras=array())
	getSubscribersCount ($iType=CH_WSB_SBS_TYPE_VISITOR)
	getSubscribers ($iType=CH_WSB_SBS_TYPE_VISITOR, $iStart=0, $iCount=1)
	_processMember ($sDirection, $iUserId, $sUnit, $sAction, $iObjectId)
	_processVisitor ($sDirection, $sUserName, $sUserEmail, $sUnit, $sAction, $iObjectId)
	_getJsCode ()
	_getUnsubscribeLink ($mixedIds)

Static Public Member Functions
static	getInstance ()

Public Attributes
	$_oDb
	$_bDataAdded
	$_sJsObject
	$_sActionUrl
	$_sVisitorPopup

Detailed Description

Subscriptions for any content changes.

Integration of the content with subscriptions engine allows site member and visitors to subscribe to any content changes.

Related classes: ChWsbSubscriptionQuery - database queries.

Example of usage:

1. Register all your subscriptions in sys_sbs_types database table.
2. Add necessary email templates in the sys_email_templates table.

3. Add necessary HTML/JavaScript data on the page where the 'Subscribe' button would be displayed. Use the following code

   $oSubscription = ChWsbSubscription::getInstance(); $oSubscription->getData();

4. Add Subscribe/Unsubscribe button using the following code.

   $oSubscription = new ChWsbSubscription(); $oSubscription->getButton($iUserId, $sUnit, $sAction, $iObjectId);

See also

an example of integration in the default Cheetah's modules(feedback, news, etc)

Memberships/ACL: Doesn't depend on user's membership.

Alerts: no alerts available

Definition at line 47 of file ChWsbSubscription.php.

Constructor & Destructor Documentation

__construct()

ChWsbSubscription::__construct

(

)

constructor

Definition at line 58 of file ChWsbSubscription.php.

Member Function Documentation

_getJsCode()

ChWsbSubscription::_getJsCode

(

)

Definition at line 348 of file ChWsbSubscription.php.

_getUnsubscribeLink()

ChWsbSubscription::_getUnsubscribeLink

(

$mixedIds

)

Definition at line 363 of file ChWsbSubscription.php.

_processMember()

ChWsbSubscription::_processMember	(		$sDirection,
			$iUserId,
			$sUnit,
			$sAction,
			$iObjectId
	)

Definition at line 324 of file ChWsbSubscription.php.

_processVisitor()

ChWsbSubscription::_processVisitor	(		$sDirection,
			$sUserName,
			$sUserEmail,
			$sUnit,
			$sAction,
			$iObjectId
	)

Definition at line 335 of file ChWsbSubscription.php.

getButton()

ChWsbSubscription::getButton	(		$iUserId,
			$sUnit,
			$sAction = '',
			$iObjectId = 0
	)

Definition at line 248 of file ChWsbSubscription.php.

getData()

ChWsbSubscription::getData

(

$bDynamic = false

)

Definition at line 156 of file ChWsbSubscription.php.

getInstance()

static ChWsbSubscription::getInstance ( )

static

Definition at line 67 of file ChWsbSubscription.php.

getMySubscriptions()

ChWsbSubscription::getMySubscriptions

(

)

Definition at line 75 of file ChWsbSubscription.php.

getSubscribers()

ChWsbSubscription::getSubscribers	(		$iType = CH_WSB_SBS_TYPE_VISITOR,
			$iStart = 0,
			$iCount = 1
	)

Definition at line 319 of file ChWsbSubscription.php.

getSubscribersCount()

ChWsbSubscription::getSubscribersCount

(

$iType = CH_WSB_SBS_TYPE_VISITOR

)

Definition at line 315 of file ChWsbSubscription.php.

send()

ChWsbSubscription::send	(		$sUnit,
			$sAction,
			$iObjectId = 0,
			$aExtras = array()
	)

Definition at line 307 of file ChWsbSubscription.php.

subscribeMember()

ChWsbSubscription::subscribeMember	(		$iUserId,
			$sUnit,
			$sAction,
			$iObjectId = 0
	)

Definition at line 273 of file ChWsbSubscription.php.

subscribeVisitor()

ChWsbSubscription::subscribeVisitor	(		$sUserName,
			$sUserEmail,
			$sUnit,
			$sAction,
			$iObjectId = 0
	)

Definition at line 264 of file ChWsbSubscription.php.

unsubscribe()

ChWsbSubscription::unsubscribe

(

$aParams

)

Definition at line 281 of file ChWsbSubscription.php.

unsubscribeMember()

ChWsbSubscription::unsubscribeMember	(		$iUserId,
			$sUnit,
			$sAction,
			$iObjectId = 0
	)

Definition at line 277 of file ChWsbSubscription.php.

unsubscribeVisitor()

ChWsbSubscription::unsubscribeVisitor	(		$sUserName,
			$sUserEmail,
			$sUnit,
			$sAction,
			$iObjectId = 0
	)

Definition at line 269 of file ChWsbSubscription.php.

Member Data Documentation

$_bDataAdded

ChWsbSubscription::$_bDataAdded

Definition at line 50 of file ChWsbSubscription.php.

$_oDb

ChWsbSubscription::$_oDb

Definition at line 49 of file ChWsbSubscription.php.

$_sActionUrl

ChWsbSubscription::$_sActionUrl

Definition at line 52 of file ChWsbSubscription.php.

$_sJsObject

ChWsbSubscription::$_sJsObject

Definition at line 51 of file ChWsbSubscription.php.

$_sVisitorPopup

ChWsbSubscription::$_sVisitorPopup

Definition at line 53 of file ChWsbSubscription.php.

---

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

• inc/classes/ChWsbSubscription.php