Elgg  Version 6.3
ElggSystemMessage.php
Go to the documentation of this file.
1 <?php
11 
15  protected $message;
16 
20  protected $ttl = -1;
21 
25  protected $type;
26 
30  protected $vars = [];
31 
35  protected $link = '';
36 
43  public function __construct(string $message, string $type = 'success') {
44  $this->message = $message;
45  $this->type = $type;
46  }
47 
63  public static function factory(array $options): \ElggSystemMessage {
64  $message = new static(elgg_extract('message', $options));
65  unset($options['message']);
66 
67  foreach ($options as $key => $value) {
68  $func = 'set' . ucfirst($key);
69  if (is_callable([$message, $func])) {
70  $message->$func($value);
71  } else {
72  $message->vars[$key] = $value;
73  }
74  }
75 
76  return $message;
77  }
78 
85  public function setMessage(string $message): void {
86  $this->message = $message;
87  }
88 
94  public function getMessage(): string {
95  return $this->message;
96  }
97 
104  public function setType(string $type): void {
105  $this->type = $type;
106  }
107 
113  public function getType(): string {
114  return $this->type;
115  }
116 
124  public function setTtl(int $ttl): void {
125  $this->ttl = $ttl;
126  }
127 
133  public function getTtl(): int {
134  return $this->ttl;
135  }
136 
144  public function getVars(array $extras = []): array {
145  return array_merge($this->vars, $extras);
146  }
147 
153  public function __toString(): string {
154  return $this->message;
155  }
156 }
$type
Definition: delete.php:21
return[ 'admin/delete_admin_notices'=>['access'=> 'admin'], 'admin/menu/save'=>['access'=> 'admin'], 'admin/plugins/activate'=>['access'=> 'admin'], 'admin/plugins/activate_all'=>['access'=> 'admin'], 'admin/plugins/deactivate'=>['access'=> 'admin'], 'admin/plugins/deactivate_all'=>['access'=> 'admin'], 'admin/plugins/set_priority'=>['access'=> 'admin'], 'admin/security/security_txt'=>['access'=> 'admin'], 'admin/security/settings'=>['access'=> 'admin'], 'admin/security/regenerate_site_secret'=>['access'=> 'admin'], 'admin/site/cache/invalidate'=>['access'=> 'admin'], 'admin/site/flush_cache'=>['access'=> 'admin'], 'admin/site/icons'=>['access'=> 'admin'], 'admin/site/set_maintenance_mode'=>['access'=> 'admin'], 'admin/site/set_robots'=>['access'=> 'admin'], 'admin/site/theme'=>['access'=> 'admin'], 'admin/site/unlock_upgrade'=>['access'=> 'admin'], 'admin/site/settings'=>['access'=> 'admin'], 'admin/upgrade'=>['access'=> 'admin'], 'admin/upgrade/reset'=>['access'=> 'admin'], 'admin/user/ban'=>['access'=> 'admin'], 'admin/user/bulk/ban'=>['access'=> 'admin'], 'admin/user/bulk/delete'=>['access'=> 'admin'], 'admin/user/bulk/unban'=>['access'=> 'admin'], 'admin/user/bulk/validate'=>['access'=> 'admin'], 'admin/user/change_email'=>['access'=> 'admin'], 'admin/user/delete'=>['access'=> 'admin'], 'admin/user/login_as'=>['access'=> 'admin'], 'admin/user/logout_as'=>[], 'admin/user/makeadmin'=>['access'=> 'admin'], 'admin/user/resetpassword'=>['access'=> 'admin'], 'admin/user/removeadmin'=>['access'=> 'admin'], 'admin/user/unban'=>['access'=> 'admin'], 'admin/user/validate'=>['access'=> 'admin'], 'annotation/delete'=>[], 'avatar/upload'=>[], 'comment/save'=>[], 'diagnostics/download'=>['access'=> 'admin'], 'entity/chooserestoredestination'=>[], 'entity/delete'=>[], 'entity/mute'=>[], 'entity/restore'=>[], 'entity/subscribe'=>[], 'entity/trash'=>[], 'entity/unmute'=>[], 'entity/unsubscribe'=>[], 'login'=>['access'=> 'logged_out'], 'logout'=>[], 'notifications/mute'=>['access'=> 'public'], 'plugins/settings/remove'=>['access'=> 'admin'], 'plugins/settings/save'=>['access'=> 'admin'], 'plugins/usersettings/save'=>[], 'register'=>['access'=> 'logged_out', 'middleware'=>[\Elgg\Router\Middleware\RegistrationAllowedGatekeeper::class,],], 'river/delete'=>[], 'settings/notifications'=>[], 'settings/notifications/subscriptions'=>[], 'user/changepassword'=>['access'=> 'public'], 'user/requestnewpassword'=>['access'=> 'public'], 'useradd'=>['access'=> 'admin'], 'usersettings/save'=>[], 'widgets/add'=>[], 'widgets/delete'=>[], 'widgets/move'=>[], 'widgets/save'=>[],]
Definition: actions.php:73
Elgg System Message.
setTtl(int $ttl)
Set the time to live.
static factory(array $options)
Create an ElggSystemMessage from an associative array.
__toString()
This magic method is used for setting a string value for the object.
__construct(string $message, string $type='success')
\ElggSystemMessage constructor
getType()
Returns the message type.
setMessage(string $message)
Set the message.
getTtl()
Returns the time to live.
getVars(array $extras=[])
Returns the extra vars set during the factory.
getMessage()
Returns the message.
setType(string $type)
Set the type.
if($who_can_change_language==='nobody') elseif($who_can_change_language==='admin_only' &&!elgg_is_admin_logged_in()) $options
Definition: language.php:20
elgg_extract($key, $array, $default=null, bool $strict=true)
Checks for $array[$key] and returns its value if it exists, else returns $default.
Definition: elgglib.php:240
$value
Definition: generic.php:51
$result message
if($container instanceof ElggGroup && $container->guid !=elgg_get_page_owner_guid()) $key
Definition: summary.php:44