BxDolPush Class Reference

Inheritance diagram for BxDolPush:

Public Member Functions
	getCode ($sFor='')
	send ($iProfileId, $aMessage, $bAddToQueue=false)
Public Member Functions inherited from BxDolFactoryObject
	getObjectName ()

Static Public Member Functions
static	getObjectInstance ($sObject=false, $oTemplate=false)
static	getTags ($iProfileId=false)
static	getNotificationsCount ($iProfileId=0, &$aBubbles=null)
Static Public Member Functions inherited from BxDolFactoryObject
static	getObjectInstanceByClassNames ($sObject, $oTemplate, $sClassName, $sDbClassName)
Static Public Member Functions inherited from iBxDolFactoryObject
static	getObjectInstance ($sObject)

Protected Member Functions
	__construct ($aObject, $oTemplate=null, $sDbClassName='BxDolPushQuery')
	_getUrlRoot ($sType)

Protected Attributes
	$_sApiUrlRootPush
	$_sApiUrlRootEmail
Protected Attributes inherited from BxDolFactoryObject
	$_oDb
	$_oTemplate
	$_sObject
	$_aObject

Constructor & Destructor Documentation

__construct()

BxDolPush::__construct ( $aObject, $oTemplate = null, $sDbClassName = 'BxDolPushQuery' )

protected

Reimplemented from BxDolFactoryObject.

Member Function Documentation

getNotificationsCount()

BxDolPush::getNotificationsCount ( $iProfileId = 0, & $aBubbles = null )

static

Parameters

$a	- array to fill with notification counter per module

Returns

total number of notifications

getObjectInstance()

BxDolPush::getObjectInstance ( $sObject = false, $oTemplate = false )

static

Get Push Notification provider object instance by object name

Parameters

$sObject

object name

Returns

object instance or false on error

getTags()

BxDolPush::getTags ( $iProfileId = false )

static

Get tags to send to PUSH server

Parameters

$iProfileId

- profile ID

Returns

array of tags

Hooks:

'system', 'push_tags' - hook on get tags to send to PUSH server

• $unit_name - equals system
• $action - equals push_tags
• $object_id - profile_id from current user
• $sender_id - profile_id from current user
• $extra_params - array of additional params with the following array keys:
  • tags - [array] by ref, array of tags, can be overridden in hook processing

    HOOKS

    hook-system-push_tags

---

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

• inc/classes/BxDolPush.php