Elgg\Notifications\InstantNotificationEvent Class Reference

Instant notification event. More...

Inheritance diagram for Elgg\Notifications\InstantNotificationEvent:

Public Member Functions
	__construct (ElggData $object=null, $action=null, ElggEntity $actor=null)
	Constructor. More...
	getActor ()
	Get the actor of the event. More...
	getActorGUID ()
	Get the GUID of the actor. More...
	getObject ()
	Get the object of the event. More...
	getAction ()
	Get the name of the action. More...
	getDescription ()
	Get a description of the event. More...
	toObject ()
	Export the notification event into a serializable object This method is mainly used for logging purposes. More...

Public Attributes
const	DEFAULT_ACTION_NAME = 'notify_user'

Protected Attributes
	$action
	$object
	$actor

Detailed Description

Instant notification event.

Since

2.3

Definition at line 14 of file InstantNotificationEvent.php.

Constructor & Destructor Documentation

Elgg\Notifications\InstantNotificationEvent::__construct	(	ElggData	$object = null,
			$action = null,
		ElggEntity	$actor = null
	)

Constructor.

Parameters

ElggData	$object	The object of the event (ElggEntity)
string	$action	The name of the action (default: create)
ElggEntity	$actor	The entity that caused the event (default: logged in user)

Definition at line 37 of file InstantNotificationEvent.php.

Member Function Documentation

Elgg\Notifications\InstantNotificationEvent::getAction

(

)

Get the name of the action.

Returns

string

Implements Elgg\Notifications\NotificationEvent.

Definition at line 93 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::getActor

(

)

Get the actor of the event.

Note

Note that the actor and the object of the notification event may have been deleted/disabled since the event was serialized and stored in the database.

Returns

ElggEntity|false|null

Implements Elgg\Notifications\NotificationEvent.

Definition at line 58 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::getActorGUID

(

)

Get the GUID of the actor.

Note

Note that the actor and the object of the notification event may have been deleted/disabled since the event was serialized and stored in the database.

Returns

int

Implements Elgg\Notifications\NotificationEvent.

Definition at line 71 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::getDescription

(

)

Get a description of the event.

Returns

string

Implements Elgg\Notifications\NotificationEvent.

Definition at line 102 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::getObject

(

)

Get the object of the event.

Note

Note that the actor and the object of the notification event may have been deleted/disabled since the event was serialized and stored in the database.

Returns

ElggData|false|null

Implements Elgg\Notifications\NotificationEvent.

Definition at line 84 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::toObject

(

)

Export the notification event into a serializable object This method is mainly used for logging purposes.

Returns

stdClass

Definition at line 120 of file InstantNotificationEvent.php.

Member Data Documentation

Elgg\Notifications\InstantNotificationEvent::$action

protected

Definition at line 22 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::$actor

protected

Definition at line 28 of file InstantNotificationEvent.php.

Elgg\Notifications\InstantNotificationEvent::$object

protected

Definition at line 25 of file InstantNotificationEvent.php.

const Elgg\Notifications\InstantNotificationEvent::DEFAULT_ACTION_NAME = 'notify_user'

Definition at line 18 of file InstantNotificationEvent.php.

---

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

• engine/classes/Elgg/Notifications/InstantNotificationEvent.php