\hhu\z\controllers\componentsNotificationComponent

Component to handle user notifications

Summary

Methods
Properties
Constants
load()
factory()
__construct()
addNotification()
getNotifications()
clearNotifications()
No public properties found
TYPE_ACHIEVEMENT
TYPE_LEVELUP
SESSION_KEY
No protected methods found
No protected properties found
N/A
getClassName()
No private properties found
N/A

Constants

TYPE_ACHIEVEMENT

TYPE_ACHIEVEMENT

Type: Achievement

TYPE_LEVELUP

TYPE_LEVELUP

Type: Level-up

SESSION_KEY

SESSION_KEY

Key for Session-Array to store notifications in

Methods

load()

load(string  $componentName) 

Load the class of a Component.

Parameters

string $componentName

Name of the Component to load

Throws

\nre\exceptions\ComponentNotFoundException
\nre\exceptions\ComponentNotValidException

factory()

factory(string  $componentName) 

Instantiate a Component (Factory Pattern).

Parameters

string $componentName

Name of the Component to instantiate

__construct()

__construct() 

Construct a new Notification-component.

addNotification()

addNotification(string  $type, string  $message, string  $link = null, string  $image = null) 

Add a notification.

Parameters

string $type

Type of notification

string $message

Message to display

string $link

Optional URL to link to

string $image

Optional URL of image to display

getNotifications()

getNotifications() : array

Get all registered notifiactions and clear them.

Returns

array —

List of existing notifications

clearNotifications()

clearNotifications() 

Clear all notifications currently registered

getClassName()

getClassName(string  $componentName) : string

Determine the classname for the given Component name.

Parameters

string $componentName

Component name to get classname of

Returns

string —

Classname for the Component name