Elgg  Version 1.9
Public Member Functions | Protected Attributes | List of all members
Elgg_Notifications_Event Class Reference

Public Member Functions

 __construct (ElggData $object, $action, ElggUser $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

Elgg_Notifications_Event::__construct ( ElggData  $object,
  $action,
ElggUser  $actor = null 
)

Create a notification event.

Parameters
ElggData$objectThe object of the event (ElggEntity)
string$actionThe name of the action (default: create)
ElggUser$actorThe user that caused the event (default: logged in user)
Exceptions
InvalidArgumentException

Definition at line 34 of file Event.php.

Member Function Documentation

Elgg_Notifications_Event::getAction ( )

Get the name of the action.

Returns
string

Definition at line 100 of file Event.php.

Elgg_Notifications_Event::getActor ( )

Get the actor of the event.

Returns
ElggUser

Definition at line 59 of file Event.php.

Elgg_Notifications_Event::getActorGUID ( )

Get the GUID of the actor.

Returns
int

Definition at line 68 of file Event.php.

Elgg_Notifications_Event::getDescription ( )

Get a description of the event.

Returns
string

Definition at line 109 of file Event.php.

Elgg_Notifications_Event::getObject ( )

Get the object of the event.

Returns
ElggData

Definition at line 77 of file Event.php.

Member Data Documentation

Elgg_Notifications_Event::$action
protected

Definition at line 11 of file Event.php.

Elgg_Notifications_Event::$actor_guid
protected

Definition at line 23 of file Event.php.

Elgg_Notifications_Event::$object_id
protected

Definition at line 20 of file Event.php.

Elgg_Notifications_Event::$object_subtype
protected

Definition at line 17 of file Event.php.

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: