1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2008 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
class message_Core {
const SUCCESS = 1;
const INFO = 2;
const WARNING = 3;
const ERROR = 4;
/**
* Report a successful event.
* @param string $msg a detailed message
* @param string $permanent_key make this message permanent and store it under this key
*/
public static function success($msg, $permanent_key=null) {
self::add($msg, self::SUCCESS, $permanent_key);
}
/**
* Report an informational event.
* @param string $msg a detailed message
* @param string $permanent_key make this message permanent and store it under this key
*/
public static function info($msg, $permanent_key=null) {
self::add($msg, self::INFO, $permanent_key);
}
/**
* Report that something went wrong, not fatal, but worth investigation.
* @param string $msg a detailed message
* @param string $permanent_key make this message permanent and store it under this key
*/
public static function warning($msg, $permanent_key=null) {
self::add($msg, self::WARNING, $permanent_key);
}
/**
* Report that something went wrong that should be fixed.
* @param string $msg a detailed message
* @param string $permanent_key make this message permanent and store it under this key
*/
public static function error($msg, $permanent_key=null) {
self::add($msg, self::ERROR, $permanent_key);
}
/**
* Save a message in the session for our next page load.
* @param string $msg a detailed message
* @param integer $severity one of the severity constants
* @param string $permanent_key make this message permanent and store it under this key
*/
private function add($msg, $severity, $permanent_key=null) {
if ($permanent_key) {
$message = ORM::factory("message")
->where("key", $permanent_key)
->find();
if (!$message->loaded) {
$message->key = $permanent_key;
}
$message->severity = $severity;
$message->value = $msg;
$message->save();
} else {
$session = Session::instance();
$status = $session->get("messages");
$status[] = array($msg, $severity);
$session->set("messages", $status);
}
}
/**
* Remove any permanent message by key.
* @param string $permanent_key
*/
public function clear_permanent($permanent_key) {
$message = ORM::factory("message")->where("key", $permanent_key)->find();
if ($message->loaded) {
$message->delete();
}
}
/**
* Get any pending messages. There are two types of messages, transient and permanent.
* Permanent messages are used to let the admin know that there are pending administrative
* issues that need to be resolved. Transient ones are only displayed once.
* @return html text
*/
public function get() {
$buf = array();
foreach (Session::instance()->get_once("messages", array()) as $msg) {
$buf[] = "<li class=\"" . self::severity_class($msg[1]) . "\">$msg[0]</li>";
}
if (user::active()->admin) {
foreach (ORM::factory("message")->find_all() as $msg) {
$buf[] = "<li class=\"" . self::severity_class($msg->severity) . "\">$msg->value</li>";
}
}
if ($buf) {
return "<ul id=\"gMessages\">" . implode("", $buf) . "</ul>";
}
}
/**
* Convert a message severity to a CSS class
* @param integer $severity
* @return string
*/
public function severity_class($severity) {
switch($severity) {
case self::SUCCESS:
return "gSuccess";
case self::INFO:
return "gInfo";
case self::WARNING:
return "gWarning";
case self::ERROR:
return "gError";
}
}
}
|
