Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
Elgg\Notifications\Event Class Reference
Inheritance diagram for Elgg\Notifications\Event:
Elgg\Notifications\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

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

Create a notification event.

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

Definition at line 35 of file Event.php.

Member Function Documentation

Elgg\Notifications\Event::getAction ( )

Get the name of the action.

Returns
string

Definition at line 101 of file Event.php.

Elgg\Notifications\Event::getActor ( )

Get the actor of the event.

Returns
|false

Definition at line 60 of file Event.php.

Elgg\Notifications\Event::getActorGUID ( )

Get the GUID of the actor.

Returns
int

Definition at line 69 of file Event.php.

Elgg\Notifications\Event::getDescription ( )

Get a description of the event.

Returns
string

Definition at line 110 of file Event.php.

Elgg\Notifications\Event::getObject ( )

Get the object of the event.

Returns

Definition at line 78 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: