pm_Notifications_PanelNotification
in package
Panel notification class
Tags
Table of Contents
- AREA_ACCOUNTS = 'Accounts'
- AREA_MAINTENANCE = 'Maintenance'
- AREA_PERFORMANCE = 'Performance'
- AREA_PRODUCT = 'Product'
- AREA_SECURITY = 'Security'
- AREA_WEBSITES = 'Websites'
- CATEGORY_ALERT = 'Alert'
- CATEGORY_FEEDBACK = 'Feedback'
- CATEGORY_INFORMATION = 'Information'
- CATEGORY_PROMOTION = 'Promotion'
- CATEGORY_WARNING = 'Warning'
- getActionText() : string
- Retrieve text of notification button
- getActionUrl() : string
- Retrieve url of notification button
- getArea() : string
- Retrieve area of notification
- getCategory() : string
- Retrieve category of notification, which conveys how important is it
- getContext() : string
- Retrieve notification context, which describe who send notification (typically extension name used)
- getContextIcon() : string
- Retrieve notification context icon (typically extension icon used)
- getMessage() : string
- Retrieve message of notification
- getMessageKey() : string|null
- Retrieve message key of notification (optional)
- getSubject() : string
- Retrieve subject of notification
- getTitle() : string
- Retrieve title of notification, which will be shown at settings page
- isPromotion() : bool
- Flag to show Promotion or Feedback message as toast
- openActionInNewTab() : bool
- Does notification button should open url in new tab
- prepareRenderParams() : array<string|int, mixed>
- Convert send parameters to template parameters
Constants
AREA_ACCOUNTS
public
mixed
AREA_ACCOUNTS
= 'Accounts'
AREA_MAINTENANCE
public
mixed
AREA_MAINTENANCE
= 'Maintenance'
AREA_PERFORMANCE
public
mixed
AREA_PERFORMANCE
= 'Performance'
AREA_PRODUCT
public
mixed
AREA_PRODUCT
= 'Product'
AREA_SECURITY
public
mixed
AREA_SECURITY
= 'Security'
AREA_WEBSITES
public
mixed
AREA_WEBSITES
= 'Websites'
CATEGORY_ALERT
public
mixed
CATEGORY_ALERT
= 'Alert'
CATEGORY_FEEDBACK
public
mixed
CATEGORY_FEEDBACK
= 'Feedback'
CATEGORY_INFORMATION
public
mixed
CATEGORY_INFORMATION
= 'Information'
CATEGORY_PROMOTION
public
mixed
CATEGORY_PROMOTION
= 'Promotion'
CATEGORY_WARNING
public
mixed
CATEGORY_WARNING
= 'Warning'
Methods
getActionText()
Retrieve text of notification button
public
getActionText() : string
Return values
string —getActionUrl()
Retrieve url of notification button
public
getActionUrl() : string
Return values
string —getArea()
Retrieve area of notification
public
getArea() : string
Return values
string —one of predefined area constants or empty string
getCategory()
Retrieve category of notification, which conveys how important is it
public
getCategory() : string
Return values
string —one of predefined category constants
getContext()
Retrieve notification context, which describe who send notification (typically extension name used)
public
getContext() : string
Return values
string —getContextIcon()
Retrieve notification context icon (typically extension icon used)
public
getContextIcon() : string
Return values
string —getMessage()
Retrieve message of notification
public
getMessage() : string
Return values
string —getMessageKey()
Retrieve message key of notification (optional)
public
getMessageKey() : string|null
Return values
string|null —getSubject()
Retrieve subject of notification
public
getSubject() : string
Return values
string —getTitle()
Retrieve title of notification, which will be shown at settings page
public
getTitle() : string
Return values
string —isPromotion()
Flag to show Promotion or Feedback message as toast
public
isPromotion() : bool
Return values
bool —openActionInNewTab()
Does notification button should open url in new tab
public
openActionInNewTab() : bool
Return values
bool —prepareRenderParams()
Convert send parameters to template parameters
public
prepareRenderParams(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>