blob: 863c5ef4b90e3256106952cf7022ec7603007880 [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +00001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
2/**
3 * CodeIgniter
4 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
7 * @package CodeIgniter
8 * @author ExpressionEngine Dev Team
Greg Aker0711dc82011-01-05 10:49:40 -06009 * @copyright Copyright (c) 2008 - 2011, EllisLab, Inc.
Derek Allard2067d1a2008-11-13 22:59:24 +000010 * @license http://codeigniter.com/user_guide/license.html
11 * @link http://codeigniter.com
12 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18/**
19 * CodeIgniter Config Class
20 *
21 * This class contains functions that enable config files to be managed
22 *
23 * @package CodeIgniter
24 * @subpackage Libraries
25 * @category Libraries
26 * @author ExpressionEngine Dev Team
27 * @link http://codeigniter.com/user_guide/libraries/config.html
28 */
29class CI_Config {
30
31 var $config = array();
32 var $is_loaded = array();
Derek Jones6d743e22010-03-02 13:22:03 -060033 var $_config_paths = array(APPPATH);
Derek Allard2067d1a2008-11-13 22:59:24 +000034
35 /**
36 * Constructor
37 *
38 * Sets the $config data from the primary config.php file as a class variable
39 *
40 * @access public
41 * @param string the config file name
42 * @param boolean if configuration values should be loaded into their own section
43 * @param boolean true if errors should just return false, false if an error message should be displayed
44 * @return boolean if the file was successfully loaded or not
45 */
Greg Akera9263282010-11-10 15:26:43 -060046 function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +000047 {
Barry Mienydd671972010-10-04 16:33:58 +020048 $this->config =& get_config();
Derek Allard2067d1a2008-11-13 22:59:24 +000049 log_message('debug', "Config Class Initialized");
Phil Sturgeon4df8b222010-12-15 14:23:14 +000050
51 // Set the base_url automatically if none was provided
52 if ($this->config['base_url'] == '')
53 {
Pascal Kriete5d5895f2011-02-14 13:27:07 -050054 if (isset($_SERVER['HTTP_HOST']))
Phil Sturgeon4df8b222010-12-15 14:23:14 +000055 {
Phil Sturgeonfb552382010-12-15 14:29:21 +000056 $base_url = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) !== 'off' ? 'https' : 'http';
Phil Sturgeon4df8b222010-12-15 14:23:14 +000057 $base_url .= '://'. $_SERVER['HTTP_HOST'];
58 $base_url .= str_replace(basename($_SERVER['SCRIPT_NAME']), '', $_SERVER['SCRIPT_NAME']);
59 }
60
61 else
62 {
63 $base_url = 'http://localhost/';
64 }
65
66 $this->set_item('base_url', $base_url);
67 }
Derek Allard2067d1a2008-11-13 22:59:24 +000068 }
Barry Mienydd671972010-10-04 16:33:58 +020069
Derek Allard2067d1a2008-11-13 22:59:24 +000070 // --------------------------------------------------------------------
71
72 /**
73 * Load Config File
74 *
75 * @access public
76 * @param string the config file name
joelcoxcee80752011-01-15 23:09:47 +010077 * @param boolean if configuration values should be loaded into their own section
78 * @param boolean true if errors should just return false, false if an error message should be displayed
Derek Allard2067d1a2008-11-13 22:59:24 +000079 * @return boolean if the file was loaded correctly
Barry Mienydd671972010-10-04 16:33:58 +020080 */
Derek Allard2067d1a2008-11-13 22:59:24 +000081 function load($file = '', $use_sections = FALSE, $fail_gracefully = FALSE)
82 {
83 $file = ($file == '') ? 'config' : str_replace(EXT, '', $file);
Phil Sturgeon05fa6112011-04-06 22:57:43 +010084 $found = FALSE;
Derek Jones6d743e22010-03-02 13:22:03 -060085 $loaded = FALSE;
Barry Mienydd671972010-10-04 16:33:58 +020086
Pascal Kriete5d5895f2011-02-14 13:27:07 -050087 foreach ($this->_config_paths as $path)
Phil Sturgeon05fa6112011-04-06 22:57:43 +010088 {
89 $check_locations = defined('ENVIRONMENT')
90 ? array(ENVIRONMENT.'/'.$file, $file)
91 : array($file);
Barry Mienydd671972010-10-04 16:33:58 +020092
Phil Sturgeon05fa6112011-04-06 22:57:43 +010093 foreach ($check_locations as $location)
Derek Jones6d743e22010-03-02 13:22:03 -060094 {
Phil Sturgeon05fa6112011-04-06 22:57:43 +010095 $file_path = $path.'config/'.$location.EXT;
96
97 if (in_array($file_path, $this->is_loaded, TRUE))
98 {
99 $loaded = TRUE;
100 continue 2;
101 }
102
103 if (file_exists($file_path))
104 {
105 $found = TRUE;
106 break;
107 }
108 }
109
110 if ($found === FALSE)
111 {
Derek Jones6d743e22010-03-02 13:22:03 -0600112 continue;
113 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000114
Derek Jones6d743e22010-03-02 13:22:03 -0600115 include($file_path);
116
117 if ( ! isset($config) OR ! is_array($config))
118 {
119 if ($fail_gracefully === TRUE)
120 {
121 return FALSE;
122 }
123 show_error('Your '.$file_path.' file does not appear to contain a valid configuration array.');
124 }
Barry Mienydd671972010-10-04 16:33:58 +0200125
Derek Jones6d743e22010-03-02 13:22:03 -0600126 if ($use_sections === TRUE)
127 {
128 if (isset($this->config[$file]))
129 {
130 $this->config[$file] = array_merge($this->config[$file], $config);
131 }
132 else
133 {
134 $this->config[$file] = $config;
135 }
136 }
137 else
138 {
139 $this->config = array_merge($this->config, $config);
140 }
Barry Mienydd671972010-10-04 16:33:58 +0200141
Derek Jones6d743e22010-03-02 13:22:03 -0600142 $this->is_loaded[] = $file_path;
143 unset($config);
Barry Mienydd671972010-10-04 16:33:58 +0200144
Derek Jones6d743e22010-03-02 13:22:03 -0600145 $loaded = TRUE;
146 log_message('debug', 'Config file loaded: '.$file_path);
147 }
Barry Mienydd671972010-10-04 16:33:58 +0200148
Derek Jones6d743e22010-03-02 13:22:03 -0600149 if ($loaded === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 {
151 if ($fail_gracefully === TRUE)
152 {
153 return FALSE;
154 }
Phil Sturgeon05fa6112011-04-06 22:57:43 +0100155 show_error('The configuration file '.$file.EXT.' does not exist.');
Derek Allard2067d1a2008-11-13 22:59:24 +0000156 }
Phil Sturgeon05fa6112011-04-06 22:57:43 +0100157
Derek Allard2067d1a2008-11-13 22:59:24 +0000158 return TRUE;
159 }
Barry Mienydd671972010-10-04 16:33:58 +0200160
Derek Allard2067d1a2008-11-13 22:59:24 +0000161 // --------------------------------------------------------------------
162
163 /**
164 * Fetch a config file item
165 *
166 *
167 * @access public
168 * @param string the config item name
169 * @param string the index name
170 * @param bool
171 * @return string
172 */
173 function item($item, $index = '')
Barry Mienydd671972010-10-04 16:33:58 +0200174 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000175 if ($index == '')
Barry Mienydd671972010-10-04 16:33:58 +0200176 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000177 if ( ! isset($this->config[$item]))
178 {
179 return FALSE;
180 }
181
182 $pref = $this->config[$item];
183 }
184 else
185 {
186 if ( ! isset($this->config[$index]))
187 {
188 return FALSE;
189 }
190
191 if ( ! isset($this->config[$index][$item]))
192 {
193 return FALSE;
194 }
195
196 $pref = $this->config[$index][$item];
197 }
198
199 return $pref;
200 }
Barry Mienydd671972010-10-04 16:33:58 +0200201
202 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000203
204 /**
205 * Fetch a config file item - adds slash after item
206 *
207 * The second parameter allows a slash to be added to the end of
208 * the item, in the case of a path.
209 *
210 * @access public
211 * @param string the config item name
212 * @param bool
213 * @return string
214 */
215 function slash_item($item)
216 {
217 if ( ! isset($this->config[$item]))
218 {
219 return FALSE;
220 }
221
Phil Sturgeon4df8b222010-12-15 14:23:14 +0000222 return rtrim($this->config[$item], '/').'/';
Derek Allard2067d1a2008-11-13 22:59:24 +0000223 }
Barry Mienydd671972010-10-04 16:33:58 +0200224
Derek Allard2067d1a2008-11-13 22:59:24 +0000225 // --------------------------------------------------------------------
226
227 /**
228 * Site URL
229 *
230 * @access public
231 * @param string the URI string
232 * @return string
233 */
234 function site_url($uri = '')
235 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000236 if ($uri == '')
237 {
Phil Sturgeon4df8b222010-12-15 14:23:14 +0000238 return $this->slash_item('base_url').$this->item('index_page');
Derek Jones6d743e22010-03-02 13:22:03 -0600239 }
240
241 if ($this->item('enable_query_strings') == FALSE)
242 {
243 if (is_array($uri))
244 {
245 $uri = implode('/', $uri);
246 }
Barry Mienydd671972010-10-04 16:33:58 +0200247
Phil Sturgeon705a3ee2011-01-19 13:46:07 +0000248 $index = $this->item('index_page') == '' ? '' : $this->slash_item('index_page');
Derek Jones6d743e22010-03-02 13:22:03 -0600249 $suffix = ($this->item('url_suffix') == FALSE) ? '' : $this->item('url_suffix');
Phil Sturgeon705a3ee2011-01-19 13:46:07 +0000250 return $this->slash_item('base_url').$index.trim($uri, '/').$suffix;
Derek Allard2067d1a2008-11-13 22:59:24 +0000251 }
252 else
253 {
Derek Jones6d743e22010-03-02 13:22:03 -0600254 if (is_array($uri))
255 {
256 $i = 0;
257 $str = '';
258 foreach ($uri as $key => $val)
259 {
260 $prefix = ($i == 0) ? '' : '&';
261 $str .= $prefix.$key.'='.$val;
262 $i++;
263 }
264
265 $uri = $str;
266 }
267
Phil Sturgeon4df8b222010-12-15 14:23:14 +0000268 return $this->slash_item('base_url').$this->item('index_page').'?'.$uri;
Derek Allard2067d1a2008-11-13 22:59:24 +0000269 }
270 }
Barry Mienydd671972010-10-04 16:33:58 +0200271
Derek Allard2067d1a2008-11-13 22:59:24 +0000272 // --------------------------------------------------------------------
273
274 /**
275 * System URL
276 *
277 * @access public
278 * @return string
279 */
280 function system_url()
281 {
282 $x = explode("/", preg_replace("|/*(.+?)/*$|", "\\1", BASEPATH));
283 return $this->slash_item('base_url').end($x).'/';
284 }
Barry Mienydd671972010-10-04 16:33:58 +0200285
Derek Allard2067d1a2008-11-13 22:59:24 +0000286 // --------------------------------------------------------------------
287
288 /**
289 * Set a config file item
290 *
291 * @access public
292 * @param string the config item key
293 * @param string the config item value
294 * @return void
295 */
296 function set_item($item, $value)
297 {
298 $this->config[$item] = $value;
299 }
Barry Mienydd671972010-10-04 16:33:58 +0200300
Derek Jones6d743e22010-03-02 13:22:03 -0600301 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000302
Derek Jones6d743e22010-03-02 13:22:03 -0600303 /**
304 * Assign to Config
305 *
306 * This function is called by the front controller (CodeIgniter.php)
307 * after the Config class is instantiated. It permits config items
308 * to be assigned or overriden by variables contained in the index.php file
309 *
310 * @access private
311 * @param array
312 * @return void
Barry Mienydd671972010-10-04 16:33:58 +0200313 */
Derek Jones6d743e22010-03-02 13:22:03 -0600314 function _assign_to_config($items = array())
315 {
316 if (is_array($items))
317 {
318 foreach ($items as $key => $val)
319 {
320 $this->set_item($key, $val);
321 }
Barry Mienydd671972010-10-04 16:33:58 +0200322 }
Derek Jones6d743e22010-03-02 13:22:03 -0600323 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000324}
325
326// END CI_Config class
327
328/* End of file Config.php */
Phil Sturgeon05fa6112011-04-06 22:57:43 +0100329/* Location: ./system/core/Config.php */