PHP objects¶
Notification¶
A notification implements the interface
\CuyZ\Notiz\Core\Notification\Notification, giving access to the methods
below.
Tip
Please note that depending on the type of the notification, even more methods can be available.
Method
Notification::getTitle()
Return type
string
Description
Returns the title of the notification.
Method
Notification::getNotificationDefinition()
Return type
\CuyZ\Notiz\Core\Definition\Tree\Notification\NotificationDefinition
Description
Returns the definition object of the notification.
Method
Notification::hasEventDefinition()
Return type
bool
Description
Returns whether the notification is bound to an event or not.
Method
Notification::getEventDefinition()
Return type
\CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition
Description
Returns the definition object of the event bound to the notification. If no event is bound, an exception is thrown.
Method
Notification::getEventConfiguration()
Return type
array
Description
Returns the configuration of the event. If no configuration is found, an empty array is returned.
Event¶
An event implements the interface \CuyZ\Notiz\Core\Event\Event, giving
access to the following methods:
Tip
Please note that depending on the type of the event, even more methods can be available.
Method
Event::getDefinition()
Return type
\CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition
Description
Returns the definition object of the event.
Method
Event::getNotification()
Return type
\CuyZ\Notiz\Core\Notification\Notification
Description
Returns the notification that is being dispatched by this event.