summaryrefslogtreecommitdiffstats
path: root/lib/class/config.class.php
blob: 8ad7189e13c87c6f87a36ad69b2e996b7d6245af (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
<?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/**
 * Config Class
 *
 *
 * 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
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * @package	Ampache
 * @copyright	2001 - 2011 Ampache.org
 * @license	http://opensource.org/licenses/gpl-2.0 GPLv2
 * @link	http://www.ampache.org/
 */


/**
 * Config Class
 *
 * used to store static arrays of
 * config values, can read from ini files
 *
 * has static methods, this uses the global config
 * creating a 'Config' object will allow for local
 * config overides and/or local configs (for like dba)
 * The class should be a static var in the other classes
 *
 * @package	Ampache
 * @copyright	2001 - 2011 Ampache.org
 * @license	http://opensource.org/licenses/gpl-2.0 GPLv2
 * @link	http://www.ampache.org/
 */
class Config {

	/**
	 * These are the settings for this specific class
	 *
	 * @var	array
	 */
	private $_local	= array();

	/**
	 * These are the global settings they go where it goes
	 *
	 * @var	array
	 */
	private static $_global = array();

	/**
	 * constructor
	 * This is what is called when the class is loaded
	 */
	public function __construct() {

		// Rien a faire

	} // constructor

	/**
	 * get
	 * This checks to see if this is an instance or procedure
	 * call, procedure == global, instance == local
	 *
	 * @param	string	$name
	 * @return	mixed	array or null
	 */
	public static function get($name) {

		if (isset(self::$_global[$name])) { return self::$_global[$name]; } 
		else { return null; } 

	} // get

	/**
	 * get_all
	 * This returns all of the current config variables as an array
	 *
	 * @return	array
	 */
	public static function get_all() {

		return self::$_global;

	} // get_all

	/**
	 * set
	 *
	 * This sets config values.
	 *
	 * @param	string	$name		Key name
	 * @param	string	$value		Value name
	 * @param	boolean	$clobber	Clobber flag true or false
	 * @return	void
	 */
	public static function set($name, $value, $clobber = false) {

		if (isset(self::$_global[$name]) && !$clobber) {
			debug_event('Config', "Tried to overwrite existing key $name without setting clobber", 5);
			Error::add('Config Global', sprintf(T_('Trying to clobber \'%s\' without setting clobber'), $name));
			return false;
		}
		
		self::$_global[$name] = $value;

	} // set

	/**
	 * set_by_array
	 *
	 * This is the same as the set function except it takes an array as
	 * input.
	 *
	 * @param	array	$array		Array
	 * @param	boolean	$clobber	Clobber flag true or false
	 */
	public static function set_by_array($array, $clobber = false) {

		foreach ($array as $name => $value) {
			self::set($name,$value,$clobber);
		}

	} // set_by_array

} // end Config class
?>