Elgg\Notifications\Event Class Reference

Inheritance diagram for Elgg\Notifications\Event:

Public Member Functions
	__construct (\ElggData $object, $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...

Protected Attributes
	$action
	$object_type
	$object_subtype
	$object_id
	$actor_guid

Detailed Description

Definition at line 9 of file Event.php.

Constructor & Destructor Documentation

__construct()

Elgg\Notifications\Event::__construct	(	\ElggData	$object,
			$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

Definition at line 35 of file Event.php.

Member Function Documentation

getAction()

Elgg\Notifications\Event::getAction

(

)

Get the name of the action.

Returns

string

Definition at line 101 of file Event.php.

getActor()

Elgg\Notifications\Event::getActor

(

)

Get the actor of the event.

Returns

\ElggEntity|false

Definition at line 60 of file Event.php.

getActorGUID()

Elgg\Notifications\Event::getActorGUID

(

)

Get the GUID of the actor.

Returns

int

Definition at line 69 of file Event.php.

getDescription()

Elgg\Notifications\Event::getDescription

(

)

Get a description of the event.

Returns

string

Definition at line 110 of file Event.php.

getObject()

Elgg\Notifications\Event::getObject

(

)

Get the object of the event.

Returns

\ElggData

Definition at line 78 of file Event.php.

Member Data Documentation

$action

Elgg\Notifications\Event::$action

protected

Definition at line 11 of file Event.php.

$actor_guid

Elgg\Notifications\Event::$actor_guid

protected

Definition at line 23 of file Event.php.

$object_id

Elgg\Notifications\Event::$object_id

protected

Definition at line 20 of file Event.php.

$object_subtype

Elgg\Notifications\Event::$object_subtype

protected

Definition at line 17 of file Event.php.

$object_type

Elgg\Notifications\Event::$object_type

protected

Definition at line 14 of file Event.php.

---

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

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