Instant notification event. More...
Public Member Functions | |
| __construct (?\ElggData $object=null, ?string $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
Constructor & Destructor Documentation
◆ __construct()
| Elgg\Notifications\InstantNotificationEvent::__construct | ( | ?\ElggData | $object = null, |
| ?string | $action = null, |
||
| ?\ElggEntity | $actor = null |
||
| ) |
Constructor.
- Parameters
-
\ElggData | null $object The object of the event (ElggEntity) string | null $action The name of the action (default: create) \ElggEntity | null $actor The entity that caused the event (default: logged in user)
Definition at line 41 of file InstantNotificationEvent.php.
Member Function Documentation
◆ getAction()
| Elgg\Notifications\InstantNotificationEvent::getAction | ( | ) |
Get the name of the action.
- Returns
- string
Implements Elgg\Notifications\NotificationEvent.
Definition at line 97 of file InstantNotificationEvent.php.
◆ getActor()
| 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 62 of file InstantNotificationEvent.php.
◆ getActorGUID()
| 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 75 of file InstantNotificationEvent.php.
◆ getDescription()
| Elgg\Notifications\InstantNotificationEvent::getDescription | ( | ) |
Get a description of the event.
- Returns
- string
Implements Elgg\Notifications\NotificationEvent.
Definition at line 106 of file InstantNotificationEvent.php.
◆ getObject()
| 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 88 of file InstantNotificationEvent.php.
◆ toObject()
| 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 124 of file InstantNotificationEvent.php.
Member Data Documentation
◆ $action
|
protected |
Definition at line 22 of file InstantNotificationEvent.php.
◆ $actor
|
protected |
Definition at line 32 of file InstantNotificationEvent.php.
◆ $object
|
protected |
Definition at line 27 of file InstantNotificationEvent.php.
◆ DEFAULT_ACTION_NAME
| const Elgg\Notifications\InstantNotificationEvent::DEFAULT_ACTION_NAME = 'notify_user' |
Definition at line 17 of file InstantNotificationEvent.php.
The documentation for this class was generated from the following file:
- engine/classes/Elgg/Notifications/InstantNotificationEvent.php
