Files
gallery3/core/helpers/message.php
Bharat Mediratta 2c91a7e9ce Rework log and message helpers to be parallel, but separate.
1) they now have their own matching severity constants
2) they both have convenience functions success(), info(), warning() and error()
3) they both have severity_class()
2008-12-25 23:43:44 +00:00

107 lines
2.9 KiB
PHP

<?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
*/
public static function success($msg) {
self::add($msg, self::SUCCESS);
}
/**
* Report an informational event.
* @param string $msg a detailed message
*/
public static function info($msg) {
self::add($msg, self::INFO);
}
/**
* Report that something went wrong, not fatal, but worth investigation.
* @param string $msg a detailed message
*/
public static function warning($msg) {
self::add($msg, self::WARNING);
}
/**
* Report that something went wrong that should be fixed.
* @param string $msg a detailed message
*/
public static function error($msg) {
self::add($msg, self::ERROR);
}
/**
* 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
*/
private function add($msg, $severity) {
$session = Session::instance();
$status = $session->get("messages");
$status[] = array($msg, $severity);
$session->set("messages", $status);
}
/**
* Get any pending messages. These must be displayed to the user since they can only be
* retrieved once.
* @return html text
*/
public function get() {
$msgs = Session::instance()->get_once("messages", array());
if ($msgs) {
$buf = "<ul id=\"gMessages\">";
foreach ($msgs as $msg) {
$buf .= "<li class=\"" . self::severity_class($msg[1]) . "\">$msg[0]</li>";
}
return $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";
}
}
}