Elgg\Notifications\SubscriptionNotificationEvent Class Reference

Subscription notification event. More...

Inheritance diagram for Elgg\Notifications\SubscriptionNotificationEvent:

Public Member Functions
	__construct (\ElggData $object, string $action,\ElggEntity $actor=null)
	Create a notification event. 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...

Protected Attributes
	$action
	$object
	$actor

Detailed Description

Subscription notification event.

Since

2.3

Definition at line 14 of file SubscriptionNotificationEvent.php.

Constructor & Destructor Documentation

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

Create a notification event.

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)

Exceptions

InvalidArgumentException

Definition at line 42 of file SubscriptionNotificationEvent.php.

Member Function Documentation

Elgg\Notifications\SubscriptionNotificationEvent::getAction

(

)

Get the name of the action.

Returns

string

Implements Elgg\Notifications\NotificationEvent.

Definition at line 101 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::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

|false|null

Implements Elgg\Notifications\NotificationEvent.

Definition at line 66 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::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 79 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::getDescription

(

)

Get a description of the event.

Returns

string

Implements Elgg\Notifications\NotificationEvent.

Definition at line 110 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::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

|false|null

Implements Elgg\Notifications\NotificationEvent.

Definition at line 92 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::toObject

(

)

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

Returns

Definition at line 124 of file SubscriptionNotificationEvent.php.

Member Data Documentation

Elgg\Notifications\SubscriptionNotificationEvent::$action

protected

Definition at line 21 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::$actor

protected

Definition at line 31 of file SubscriptionNotificationEvent.php.

Elgg\Notifications\SubscriptionNotificationEvent::$object

protected

Definition at line 26 of file SubscriptionNotificationEvent.php.

---

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

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