The TranslatableAlert object is an alert that supports translatable language keys.
This class will use the module that is associated with the alert to translate the key. If the module name is empty, or the special value 'core' then the global 'lang' function will be used to read translations from the admin lang file.
| since | 2.2 |
|---|---|
| package |
CMS |
| license |
GPL |
| author |
Robert Campbell (calguy1000@cmsmadesimple.org) |
| prop |
string[] $perms An array of permission names. The logged in user must have at least one of these permissions to see the alert. |
| prop |
string $icon The complete URL to an icon to associate with this alert |
| prop |
string $titlekey The language key (relative to the module) for the alert title. |
| prop |
string $msgkey The language key (relative to the module) for the alert message. |
| prop |
mixed $msgargs Either an array of arguments to pass to the language function or a single string or value. |
| see |
__construct()
Initialize the name to a unique name, the priority to normal, and the creaed time.
__get(string $key) : \CMSMS\AdminAlerts\string;
Programmers can get the name, module, priority and title. If an unknown key is provided an exception thrown.
string $key \CMSMS\AdminAlerts\string;
__set(string $key, string $val)
Progrramers can modify the name, module, priority, and title of the alert. Alerts can only be modified before the object is stored in the database. Not afterwards. If an unknown key, or invalid priority is provided then an exception is thrown.
string $keystring $valis_for(integer $admin_uid) : boolean
integer $admin_uid boolean
get_title()
get_icon() : string
string
get_prefname(string $name = null) : string
string $nameoptionaly provide a name for the alert. If not specified the current alert name will be used.
string
decode_object(string $serialized) : \CMSMS\AdminAlerts\Alert
string $serializedA serialized array, containing an optional module name that must be loaded and the serialized alert object.
encode_object(\CMSMS\AdminAlerts\Alert $obj) : string
\CMSMS\AdminAlerts\Alert $objThe object to be ecoded.
string
A serialized array, containing an optional module name that must be loaded, and the serrialized alert object.
load_by_name(string $name) : \CMSMS\AdminAlerts\Alert
load_all()
return Alert[]
load_my_alerts(integer|null $uid = null) : array<mixed,\CMSMS\AdminAlerts\Alert>
integer|null $uidThe admin userid to test for. If no uid is specified, the currently logged in admin user id is used.
array<mixed,\CMSMS\AdminAlerts\Alert>
save()
delete()
PRIORITY_HIGH
PRIORITY_NORMAL
PRIORITY_LOW