summaryrefslogtreecommitdiffstats
path: root/lib/class/error.class.php
blob: 2cf962ace6bd4614db60654266697bcf17e27060 (plain)
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/*
 * Error Class
 *
 * PHP version 5
 *
 * LICENSE: GNU General Public License, version 2 (GPLv2)
 * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License v2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANT ABILITY 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * @category	Error
 * @package	Ampache
 * @author	Karl Vollmer <vollmer@ampache.org>
 * @copyright	2001 - 2011 Ampache.org
 * @license	http://opensource.org/licenses/gpl-2.0 GPLv2
 * @version	PHP 5.2
 * @link	http://www.ampache.org/
 * @since	File available since Release 1.0
 */

/**
 * Error class
 *
 * This is the baic error class, its better now that we can use php5
 * hello static functions and variables
 *
 * @category	Error
 * @package	Ampache
 * @author	Karl Vollmer <vollmer@ampache.org>
 * @copyright	2001 - 2011 Ampache.org
 * @license	http://opensource.org/licenses/gpl-2.0 GPLv2
 * @version	Release: 3.6
 * @link	http://www.ampache.org/
 * @since	Class available since Release 1.0
 */
class Error {

	private static $state = false; // set to one when an error occurs
	private static $errors = array(); // Errors array key'd array with errors that have occured

	/**
	 * __constructor
	 * This does nothing... amazing isn't it!
	 */
	private function __construct() {

		// Rien a faire

	} // __construct

	/**
	 * __destruct
	 * This saves all of the errors that are left into the session
	 */
	public function __destruct() {


		foreach (self::$errors as $key=>$error) {
			$_SESSION['errors'][$key] = $error;
		}

	} // __destruct

	/**
	 * add
	 * This is a public static function it adds a new error message to the array
	 * It can optionally clobber rather then adding to the error message
	 */
	public static function add($name,$message,$clobber=0) {

		// Make sure its set first
		if (!isset(Error::$errors[$name])) {
			Error::$errors[$name] = $message;
			Error::$state = 1;
			$_SESSION['errors'][$name] = $message;
		}
		// They want us to clobber it
		elseif ($clobber) {
			Error::$state = 1;
			Error::$errors[$name] = $message;
			$_SESSION['errors'][$name] = $message;
		}
		// They want us to append the error, add a BR\n and then the message
		else {
			Error::$state = 1;
			Error::$errors[$name] .= "<br />\n" . $message;
			$_SESSION['errors'][$name] .=  "<br />\n" . $message;
		}

	} // add

	/**
	 * occurred
	 * This returns true / false if an error has occured anywhere
	 */
	public static function occurred() {

		if (self::$state == '1') { return true; }

		return false;

	} // occurred

	/**
	 * get
	 * This returns an error by name
	 */
	public static function get($name) {

		if (!isset(Error::$errors[$name])) { return ''; }

		return Error::$errors[$name];

	} // get

	/**
	 * display
	 * This prints the error out with a standard Error class span
	 * Ben Goska: Renamed from print to display, print is reserved
	 */
	public static function display($name) {

		// Be smart about this, if no error don't print
		if (!isset(Error::$errors[$name])) { return ''; }

		echo '<span class="error">' . Error::$errors[$name] . '</span>';

	} // display

	/**
 	 * auto_init
	 * This loads the errors from the session back into Ampache
	 */
	public static function auto_init() {

		if (!is_array($_SESSION['errors'])) { return false; }

		// Re-insert them
		foreach ($_SESSION['errors'] as $key=>$error) {
			self::add($key,$error);
		}

	} // auto_init

} // Error