blob: 78172580d44d5cfe0eeca4221b3919ede02c31c1 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreevd7297352012-01-07 22:53:14 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevd7297352012-01-07 22:53:14 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
Derek Allard2067d1a2008-11-13 22:59:24 +000018 *
19 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Andrey Andreev80500af2013-01-01 08:16:53 +020021 * @copyright Copyright (c) 2008 - 2013, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * Loader Class
31 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030032 * Loads framework components.
Derek Allard2067d1a2008-11-13 22:59:24 +000033 *
34 * @package CodeIgniter
35 * @subpackage Libraries
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @category Loader
Andrey Andreev92ebfb62012-05-17 12:49:24 +030037 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000038 * @link http://codeigniter.com/user_guide/libraries/loader.html
39 */
40class CI_Loader {
41
42 // All these are set automatically. Don't mess with them.
David Behlercda768a2011-08-14 23:52:48 +020043 /**
44 * Nesting level of the output buffering mechanism
45 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030046 * @var int
David Behlercda768a2011-08-14 23:52:48 +020047 */
Greg Aker0c9ee4a2011-04-20 09:40:17 -050048 protected $_ci_ob_level;
Andrey Andreev92ebfb62012-05-17 12:49:24 +030049
David Behlercda768a2011-08-14 23:52:48 +020050 /**
51 * List of paths to load views from
52 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030053 * @var array
David Behlercda768a2011-08-14 23:52:48 +020054 */
Ted Wood4c223642013-01-05 16:50:31 -080055 protected $_ci_view_paths = array(VIEWPATH => TRUE);
Andrey Andreev92ebfb62012-05-17 12:49:24 +030056
David Behlercda768a2011-08-14 23:52:48 +020057 /**
58 * List of paths to load libraries from
59 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030060 * @var array
David Behlercda768a2011-08-14 23:52:48 +020061 */
Ted Wood4c223642013-01-05 16:50:31 -080062 protected $_ci_library_paths = array(APPPATH, BASEPATH);
Andrey Andreev92ebfb62012-05-17 12:49:24 +030063
David Behlercda768a2011-08-14 23:52:48 +020064 /**
65 * List of paths to load models from
66 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030067 * @var array
David Behlercda768a2011-08-14 23:52:48 +020068 */
Ted Wood4c223642013-01-05 16:50:31 -080069 protected $_ci_model_paths = array(APPPATH);
Andrey Andreev92ebfb62012-05-17 12:49:24 +030070
David Behlercda768a2011-08-14 23:52:48 +020071 /**
72 * List of paths to load helpers from
73 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030074 * @var array
David Behlercda768a2011-08-14 23:52:48 +020075 */
Ted Wood4c223642013-01-05 16:50:31 -080076 protected $_ci_helper_paths = array(APPPATH, BASEPATH);
Andrey Andreev92ebfb62012-05-17 12:49:24 +030077
David Behlercda768a2011-08-14 23:52:48 +020078 /**
David Behlercda768a2011-08-14 23:52:48 +020079 * List of cached variables
80 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030081 * @var array
David Behlercda768a2011-08-14 23:52:48 +020082 */
Timothy Warren48a7fbb2012-04-23 11:58:16 -040083 protected $_ci_cached_vars = array();
Andrey Andreev92ebfb62012-05-17 12:49:24 +030084
David Behlercda768a2011-08-14 23:52:48 +020085 /**
86 * List of loaded classes
87 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030088 * @var array
David Behlercda768a2011-08-14 23:52:48 +020089 */
Timothy Warren48a7fbb2012-04-23 11:58:16 -040090 protected $_ci_classes = array();
Andrey Andreev92ebfb62012-05-17 12:49:24 +030091
David Behlercda768a2011-08-14 23:52:48 +020092 /**
David Behlercda768a2011-08-14 23:52:48 +020093 * List of loaded models
94 *
Andrey Andreeved4b2582012-10-27 17:46:52 +030095 * @var array
David Behlercda768a2011-08-14 23:52:48 +020096 */
Timothy Warren48a7fbb2012-04-23 11:58:16 -040097 protected $_ci_models = array();
Andrey Andreev92ebfb62012-05-17 12:49:24 +030098
David Behlercda768a2011-08-14 23:52:48 +020099 /**
100 * List of loaded helpers
101 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300102 * @var array
David Behlercda768a2011-08-14 23:52:48 +0200103 */
Timothy Warren48a7fbb2012-04-23 11:58:16 -0400104 protected $_ci_helpers = array();
Andrey Andreev92ebfb62012-05-17 12:49:24 +0300105
David Behlercda768a2011-08-14 23:52:48 +0200106 /**
107 * List of class name mappings
108 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300109 * @var array
David Behlercda768a2011-08-14 23:52:48 +0200110 */
Timothy Warren48a7fbb2012-04-23 11:58:16 -0400111 protected $_ci_varmap = array(
Timothy Warren40403d22012-04-19 16:38:50 -0400112 'unit_test' => 'unit',
113 'user_agent' => 'agent'
114 );
Derek Allard2067d1a2008-11-13 22:59:24 +0000115
Andrey Andreev519f87a2013-07-23 17:16:10 +0300116 // --------------------------------------------------------------------
117
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300119 * Class constructor
Derek Allard2067d1a2008-11-13 22:59:24 +0000120 *
Andrey Andreevcdac2482012-11-03 18:09:01 +0200121 * Sets component load paths, gets the initial output buffering level.
Andrey Andreev92ebfb62012-05-17 12:49:24 +0300122 *
123 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000124 */
Greg Akerf5c84022011-04-19 17:13:03 -0500125 public function __construct()
Barry Mienydd671972010-10-04 16:33:58 +0200126 {
Andrey Andreev519f87a2013-07-23 17:16:10 +0300127 $this->_ci_ob_level = ob_get_level();
128 $this->_ci_classes =& is_loaded();
David Behlercda768a2011-08-14 23:52:48 +0200129
Andrey Andreevd7297352012-01-07 22:53:14 +0200130 log_message('debug', 'Loader Class Initialized');
Derek Allard2067d1a2008-11-13 22:59:24 +0000131 }
Barry Mienydd671972010-10-04 16:33:58 +0200132
Derek Allard2067d1a2008-11-13 22:59:24 +0000133 // --------------------------------------------------------------------
David Behlercda768a2011-08-14 23:52:48 +0200134
Greg Aker0c9ee4a2011-04-20 09:40:17 -0500135 /**
Andrey Andreevcdac2482012-11-03 18:09:01 +0200136 * Initializer
137 *
138 * @todo Figure out a way to move this to the constructor
139 * without breaking *package_path*() methods.
140 * @uses CI_Loader::_ci_autoloader()
141 * @used-by CI_Controller::__construct()
142 * @return void
143 */
144 public function initialize()
145 {
Andrey Andreevcdac2482012-11-03 18:09:01 +0200146 $this->_ci_autoloader();
147 }
148
149 // --------------------------------------------------------------------
150
151 /**
Greg Aker0c9ee4a2011-04-20 09:40:17 -0500152 * Is Loaded
153 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300154 * A utility method to test if a class is in the self::$_ci_classes array.
Greg Aker0c9ee4a2011-04-20 09:40:17 -0500155 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300156 * @used-by Mainly used by Form Helper function _get_validation_object().
Greg Aker0c9ee4a2011-04-20 09:40:17 -0500157 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300158 * @param string $class Class name to check for
159 * @return string|bool Class object name if loaded or FALSE
Greg Aker0c9ee4a2011-04-20 09:40:17 -0500160 */
161 public function is_loaded($class)
162 {
Andrey Andreev519f87a2013-07-23 17:16:10 +0300163 return array_search(ucfirst($class), $this->_ci_classes, TRUE);
Greg Aker0c9ee4a2011-04-20 09:40:17 -0500164 }
165
166 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200167
Derek Allard2067d1a2008-11-13 22:59:24 +0000168 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300169 * Library Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000170 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300171 * Loads and instantiates libraries.
172 * Designed to be called from application controllers.
Derek Allard2067d1a2008-11-13 22:59:24 +0000173 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300174 * @param string $library Library name
175 * @param array $params Optional parameters to pass to the library class constructor
176 * @param string $object_name An optional object name to assign to
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200177 * @return object
Barry Mienydd671972010-10-04 16:33:58 +0200178 */
Andrey Andreev9c12b3f2014-01-06 12:32:30 +0200179 public function library($library, $params = NULL, $object_name = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000180 {
Andrey Andreev519f87a2013-07-23 17:16:10 +0300181 if (empty($library))
182 {
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200183 return $this;
Andrey Andreev519f87a2013-07-23 17:16:10 +0300184 }
185 elseif (is_array($library))
Greg Akerce433962010-10-12 09:29:35 -0500186 {
Phil Sturgeon08b51692011-04-03 18:05:42 +0100187 foreach ($library as $class)
Greg Akerce433962010-10-12 09:29:35 -0500188 {
Kellas Reeves3c6e4852011-02-09 11:57:56 -0600189 $this->library($class, $params);
Greg Akerce433962010-10-12 09:29:35 -0500190 }
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000191
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200192 return $this;
Greg Akerce433962010-10-12 09:29:35 -0500193 }
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000194
vlakoff1228fe22013-01-14 01:30:09 +0100195 if ($params !== NULL && ! is_array($params))
Derek Allard2067d1a2008-11-13 22:59:24 +0000196 {
197 $params = NULL;
198 }
199
Kellas Reeves3c6e4852011-02-09 11:57:56 -0600200 $this->_ci_load_class($library, $params, $object_name);
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200201 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000202 }
203
204 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200205
Derek Allard2067d1a2008-11-13 22:59:24 +0000206 /**
207 * Model Loader
208 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300209 * Loads and instantiates libraries.
Derek Allard2067d1a2008-11-13 22:59:24 +0000210 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300211 * @param string $model Model name
212 * @param string $name An optional object name to assign to
213 * @param bool $db_conn An optional database connection configuration to initialize
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200214 * @return object
Barry Mienydd671972010-10-04 16:33:58 +0200215 */
Greg Akerf5c84022011-04-19 17:13:03 -0500216 public function model($model, $name = '', $db_conn = FALSE)
Barry Mienydd671972010-10-04 16:33:58 +0200217 {
Andrey Andreeved4b2582012-10-27 17:46:52 +0300218 if (empty($model))
219 {
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200220 return $this;
Andrey Andreeved4b2582012-10-27 17:46:52 +0300221 }
222 elseif (is_array($model))
Derek Allard2067d1a2008-11-13 22:59:24 +0000223 {
Andrey Andreev5a519db2013-01-12 04:19:19 +0200224 foreach ($model as $key => $value)
Derek Allard2067d1a2008-11-13 22:59:24 +0000225 {
Ahmad Anbar4005e3c2013-09-12 23:33:28 +0300226 is_int($key) ? $this->model($value, '', $db_conn) : $this->model($key, $value, $db_conn);
Derek Allard2067d1a2008-11-13 22:59:24 +0000227 }
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200228
229 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000230 }
231
Derek Jones32bf1862010-03-02 13:46:07 -0600232 $path = '';
Barry Mienydd671972010-10-04 16:33:58 +0200233
Derek Allard2067d1a2008-11-13 22:59:24 +0000234 // Is the model in a sub-folder? If so, parse out the filename and path.
Derek Jones32bf1862010-03-02 13:46:07 -0600235 if (($last_slash = strrpos($model, '/')) !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000236 {
Derek Jones32bf1862010-03-02 13:46:07 -0600237 // The path is in front of the last slash
Andrey Andreevd47baab2012-01-09 16:56:46 +0200238 $path = substr($model, 0, ++$last_slash);
Derek Jones32bf1862010-03-02 13:46:07 -0600239
240 // And the model name behind it
Andrey Andreevd47baab2012-01-09 16:56:46 +0200241 $model = substr($model, $last_slash);
Derek Allard2067d1a2008-11-13 22:59:24 +0000242 }
Barry Mienydd671972010-10-04 16:33:58 +0200243
Phil Sturgeon10d78f62012-06-04 14:41:53 -0500244 if (empty($name))
Derek Allard2067d1a2008-11-13 22:59:24 +0000245 {
246 $name = $model;
247 }
Barry Mienydd671972010-10-04 16:33:58 +0200248
Derek Allard2067d1a2008-11-13 22:59:24 +0000249 if (in_array($name, $this->_ci_models, TRUE))
250 {
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200251 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000252 }
Barry Mienydd671972010-10-04 16:33:58 +0200253
Derek Allard2067d1a2008-11-13 22:59:24 +0000254 $CI =& get_instance();
255 if (isset($CI->$name))
256 {
257 show_error('The model name you are loading is the name of a resource that is already being used: '.$name);
258 }
Barry Mienydd671972010-10-04 16:33:58 +0200259
Andrey Andreev20292312013-07-22 14:29:10 +0300260 if ($db_conn !== FALSE && ! class_exists('CI_DB', FALSE))
261 {
262 if ($db_conn === TRUE)
263 {
264 $db_conn = '';
265 }
266
267 $CI->load->database($db_conn, FALSE, TRUE);
268 }
269
270 if ( ! class_exists('CI_Model', FALSE))
271 {
272 load_class('Model', 'core');
273 }
274
275 $model = ucfirst(strtolower($model));
Derek Allard2067d1a2008-11-13 22:59:24 +0000276
Derek Jones32bf1862010-03-02 13:46:07 -0600277 foreach ($this->_ci_model_paths as $mod_path)
278 {
Greg Aker3a746652011-04-19 10:59:47 -0500279 if ( ! file_exists($mod_path.'models/'.$path.$model.'.php'))
Derek Jones32bf1862010-03-02 13:46:07 -0600280 {
281 continue;
282 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000283
Greg Aker3a746652011-04-19 10:59:47 -0500284 require_once($mod_path.'models/'.$path.$model.'.php');
Derek Jones32bf1862010-03-02 13:46:07 -0600285
Derek Jones32bf1862010-03-02 13:46:07 -0600286 $CI->$name = new $model();
Derek Jones32bf1862010-03-02 13:46:07 -0600287 $this->_ci_models[] = $name;
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200288 return $this;
Derek Jones32bf1862010-03-02 13:46:07 -0600289 }
Barry Mienydd671972010-10-04 16:33:58 +0200290
Derek Jones32bf1862010-03-02 13:46:07 -0600291 // couldn't find the model
292 show_error('Unable to locate the model you have specified: '.$model);
Derek Allard2067d1a2008-11-13 22:59:24 +0000293 }
Barry Mienydd671972010-10-04 16:33:58 +0200294
Derek Allard2067d1a2008-11-13 22:59:24 +0000295 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200296
Derek Allard2067d1a2008-11-13 22:59:24 +0000297 /**
298 * Database Loader
299 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300300 * @param mixed $params Database configuration options
301 * @param bool $return Whether to return the database object
302 * @param bool $query_builder Whether to enable Query Builder
303 * (overrides the configuration setting)
304 *
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200305 * @return object|bool Database object if $return is set to TRUE,
306 * FALSE on failure, CI_Loader instance in any other case
Barry Mienydd671972010-10-04 16:33:58 +0200307 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000308 public function database($params = '', $return = FALSE, $query_builder = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000309 {
310 // Grab the super object
311 $CI =& get_instance();
Barry Mienydd671972010-10-04 16:33:58 +0200312
Derek Allard2067d1a2008-11-13 22:59:24 +0000313 // Do we even need to load the database class?
Andrey Andreev9d0ab042012-10-24 21:47:39 +0300314 if ($return === FALSE && $query_builder === NULL && isset($CI->db) && is_object($CI->db) && ! empty($CI->db->conn_id))
Derek Allard2067d1a2008-11-13 22:59:24 +0000315 {
316 return FALSE;
Barry Mienydd671972010-10-04 16:33:58 +0200317 }
318
Greg Aker3a746652011-04-19 10:59:47 -0500319 require_once(BASEPATH.'database/DB.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000320
321 if ($return === TRUE)
322 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000323 return DB($params, $query_builder);
Derek Allard2067d1a2008-11-13 22:59:24 +0000324 }
Barry Mienydd671972010-10-04 16:33:58 +0200325
Andrey Andreevd7297352012-01-07 22:53:14 +0200326 // Initialize the db variable. Needed to prevent
Derek Allard2067d1a2008-11-13 22:59:24 +0000327 // reference errors with some configurations
328 $CI->db = '';
Barry Mienydd671972010-10-04 16:33:58 +0200329
Derek Allard2067d1a2008-11-13 22:59:24 +0000330 // Load the DB class
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000331 $CI->db =& DB($params, $query_builder);
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200332 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000333 }
Barry Mienydd671972010-10-04 16:33:58 +0200334
Derek Allard2067d1a2008-11-13 22:59:24 +0000335 // --------------------------------------------------------------------
336
337 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300338 * Load the Database Utilities Class
Derek Allard2067d1a2008-11-13 22:59:24 +0000339 *
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200340 * @param object $db Database object
Andrey Andreev9c12b3f2014-01-06 12:32:30 +0200341 * @param bool $return Whether to return the DB Utilities class object or not
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200342 * @return object
Barry Mienydd671972010-10-04 16:33:58 +0200343 */
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200344 public function dbutil($db = NULL, $return = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000345 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000346 $CI =& get_instance();
347
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200348 if ( ! is_object($db) OR ! ($db instanceof CI_DB))
349 {
350 class_exists('CI_DB', FALSE) OR $this->database();
351 $db =& $CI->db;
352 }
Barry Mienydd671972010-10-04 16:33:58 +0200353
Greg Aker3a746652011-04-19 10:59:47 -0500354 require_once(BASEPATH.'database/DB_utility.php');
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200355 require_once(BASEPATH.'database/drivers/'.$db->dbdriver.'/'.$db->dbdriver.'_utility.php');
356 $class = 'CI_DB_'.$db->dbdriver.'_utility';
Derek Allard2067d1a2008-11-13 22:59:24 +0000357
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200358 if ($return === TRUE)
359 {
360 return new $class($db);
361 }
362
363 $CI->dbutil = new $class($db);
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200364 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000365 }
Barry Mienydd671972010-10-04 16:33:58 +0200366
Derek Allard2067d1a2008-11-13 22:59:24 +0000367 // --------------------------------------------------------------------
368
369 /**
370 * Load the Database Forge Class
371 *
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200372 * @param object $db Database object
373 * @param bool $return Whether to return the DB Forge class object or not
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200374 * @return object
Barry Mienydd671972010-10-04 16:33:58 +0200375 */
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200376 public function dbforge($db = NULL, $return = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000377 {
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200378 $CI =& get_instance();
379 if ( ! is_object($db) OR ! ($db instanceof CI_DB))
Derek Allard2067d1a2008-11-13 22:59:24 +0000380 {
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200381 class_exists('CI_DB', FALSE) OR $this->database();
382 $db =& $CI->db;
Derek Allard2067d1a2008-11-13 22:59:24 +0000383 }
Barry Mienydd671972010-10-04 16:33:58 +0200384
Greg Aker3a746652011-04-19 10:59:47 -0500385 require_once(BASEPATH.'database/DB_forge.php');
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200386 require_once(BASEPATH.'database/drivers/'.$db->dbdriver.'/'.$db->dbdriver.'_forge.php');
Andrey Andreeva287a342012-11-05 23:19:59 +0200387
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200388 if ( ! empty($db->subdriver))
Andrey Andreeva287a342012-11-05 23:19:59 +0200389 {
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200390 $driver_path = BASEPATH.'database/drivers/'.$db->dbdriver.'/subdrivers/'.$db->dbdriver.'_'.$db->subdriver.'_forge.php';
Andrey Andreeva287a342012-11-05 23:19:59 +0200391 if (file_exists($driver_path))
392 {
393 require_once($driver_path);
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200394 $class = 'CI_DB_'.$db->dbdriver.'_'.$db->subdriver.'_forge';
Andrey Andreeva287a342012-11-05 23:19:59 +0200395 }
396 }
397 else
398 {
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200399 $class = 'CI_DB_'.$db->dbdriver.'_forge';
Andrey Andreeva287a342012-11-05 23:19:59 +0200400 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000401
Andrey Andreeveaa60c72012-11-06 01:11:22 +0200402 if ($return === TRUE)
403 {
404 return new $class($db);
405 }
406
407 $CI->dbforge = new $class($db);
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200408 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000409 }
Barry Mienydd671972010-10-04 16:33:58 +0200410
Derek Allard2067d1a2008-11-13 22:59:24 +0000411 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200412
Derek Allard2067d1a2008-11-13 22:59:24 +0000413 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300414 * View Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000415 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300416 * Loads "view" files.
Derek Allard2067d1a2008-11-13 22:59:24 +0000417 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300418 * @param string $view View name
419 * @param array $vars An associative array of data
420 * to be extracted for use in the view
421 * @param bool $return Whether to return the view output
422 * or leave it to the Output class
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200423 * @return object|string
Derek Allard2067d1a2008-11-13 22:59:24 +0000424 */
Greg Akerf5c84022011-04-19 17:13:03 -0500425 public function view($view, $vars = array(), $return = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000426 {
427 return $this->_ci_load(array('_ci_view' => $view, '_ci_vars' => $this->_ci_object_to_array($vars), '_ci_return' => $return));
428 }
Barry Mienydd671972010-10-04 16:33:58 +0200429
Derek Allard2067d1a2008-11-13 22:59:24 +0000430 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200431
Derek Allard2067d1a2008-11-13 22:59:24 +0000432 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300433 * Generic File Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000434 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300435 * @param string $path File path
436 * @param bool $return Whether to return the file output
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200437 * @return object|string
Derek Allard2067d1a2008-11-13 22:59:24 +0000438 */
Greg Akerf5c84022011-04-19 17:13:03 -0500439 public function file($path, $return = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000440 {
441 return $this->_ci_load(array('_ci_path' => $path, '_ci_return' => $return));
442 }
Barry Mienydd671972010-10-04 16:33:58 +0200443
Derek Allard2067d1a2008-11-13 22:59:24 +0000444 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200445
Derek Allard2067d1a2008-11-13 22:59:24 +0000446 /**
447 * Set Variables
448 *
449 * Once variables are set they become available within
450 * the controller class and its "view" files.
451 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300452 * @param array|object|string $vars
453 * An associative array or object containing values
454 * to be set, or a value's name if string
455 * @param string $val Value to set, only used if $vars is a string
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200456 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000457 */
Andrey Andreev9c12b3f2014-01-06 12:32:30 +0200458 public function vars($vars, $val = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000459 {
vlakoffa5e0ea82013-02-27 18:17:35 +0100460 if (is_string($vars))
Derek Allard2067d1a2008-11-13 22:59:24 +0000461 {
462 $vars = array($vars => $val);
463 }
Barry Mienydd671972010-10-04 16:33:58 +0200464
Derek Allard2067d1a2008-11-13 22:59:24 +0000465 $vars = $this->_ci_object_to_array($vars);
Barry Mienydd671972010-10-04 16:33:58 +0200466
Andrey Andreev94af3552012-03-26 23:10:42 +0300467 if (is_array($vars) && count($vars) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000468 {
469 foreach ($vars as $key => $val)
470 {
471 $this->_ci_cached_vars[$key] = $val;
472 }
473 }
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200474
475 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000476 }
Barry Mienydd671972010-10-04 16:33:58 +0200477
Derek Allard2067d1a2008-11-13 22:59:24 +0000478 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200479
Derek Allard2067d1a2008-11-13 22:59:24 +0000480 /**
Tomaz Lovreca81a5ef2013-10-16 11:29:57 +0200481 * Clear Cached Variables
Andrey Andreevaf01fb12014-01-03 16:57:44 +0200482 *
Tomaz Lovreca81a5ef2013-10-16 11:29:57 +0200483 * Clears the cached variables.
Andrey Andreevaf01fb12014-01-03 16:57:44 +0200484 *
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200485 * @return object
Tomaz Lovreca81a5ef2013-10-16 11:29:57 +0200486 */
487 public function clear_vars()
488 {
489 $this->_ci_cached_vars = array();
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200490 return $this;
Tomaz Lovreca81a5ef2013-10-16 11:29:57 +0200491 }
Andrey Andreevaf01fb12014-01-03 16:57:44 +0200492
Tomaz Lovreca81a5ef2013-10-16 11:29:57 +0200493 // --------------------------------------------------------------------
494
495 /**
Phil Sturgeon8731f642011-07-22 16:11:34 -0600496 * Get Variable
497 *
498 * Check if a variable is set and retrieve it.
499 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300500 * @param string $key Variable name
501 * @return mixed The variable or NULL if not found
Phil Sturgeon8731f642011-07-22 16:11:34 -0600502 */
503 public function get_var($key)
504 {
505 return isset($this->_ci_cached_vars[$key]) ? $this->_ci_cached_vars[$key] : NULL;
506 }
507
508 // --------------------------------------------------------------------
509
510 /**
Shane Pearson81dd2232011-11-18 20:49:35 -0600511 * Get Variables
512 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300513 * Retrieves all loaded variables.
Shane Pearson81dd2232011-11-18 20:49:35 -0600514 *
515 * @return array
516 */
517 public function get_vars()
518 {
519 return $this->_ci_cached_vars;
520 }
521
522 // --------------------------------------------------------------------
523
524 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300525 * Helper Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000526 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300527 * @param string|string[] $helpers Helper name(s)
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200528 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000529 */
Greg Akerf5c84022011-04-19 17:13:03 -0500530 public function helper($helpers = array())
Barry Mienydd671972010-10-04 16:33:58 +0200531 {
Derek Jones32bf1862010-03-02 13:46:07 -0600532 foreach ($this->_ci_prep_filename($helpers, '_helper') as $helper)
Barry Mienydd671972010-10-04 16:33:58 +0200533 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000534 if (isset($this->_ci_helpers[$helper]))
535 {
536 continue;
537 }
Derek Jones32bf1862010-03-02 13:46:07 -0600538
Barry Mienydd671972010-10-04 16:33:58 +0200539 // Is this a helper extension request?
Andrey Andreev12d7b462012-11-12 13:42:09 +0200540 $ext_helper = config_item('subclass_prefix').$helper;
541 $ext_loaded = FALSE;
542 foreach ($this->_ci_helper_paths as $path)
543 {
544 if (file_exists($path.'helpers/'.$ext_helper.'.php'))
545 {
546 include_once($path.'helpers/'.$ext_helper.'.php');
547 $ext_loaded = TRUE;
548 }
549 }
550
551 // If we have loaded extensions - check if the base one is here
552 if ($ext_loaded === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000553 {
Greg Aker3a746652011-04-19 10:59:47 -0500554 $base_helper = BASEPATH.'helpers/'.$helper.'.php';
Derek Allard2067d1a2008-11-13 22:59:24 +0000555 if ( ! file_exists($base_helper))
556 {
Greg Aker3a746652011-04-19 10:59:47 -0500557 show_error('Unable to load the requested file: helpers/'.$helper.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000558 }
Barry Mienydd671972010-10-04 16:33:58 +0200559
Derek Allard2067d1a2008-11-13 22:59:24 +0000560 include_once($base_helper);
Derek Jones32bf1862010-03-02 13:46:07 -0600561 $this->_ci_helpers[$helper] = TRUE;
562 log_message('debug', 'Helper loaded: '.$helper);
563 continue;
Derek Allard2067d1a2008-11-13 22:59:24 +0000564 }
Barry Mienydd671972010-10-04 16:33:58 +0200565
Andrey Andreev12d7b462012-11-12 13:42:09 +0200566 // No extensions found ... try loading regular helpers and/or overrides
Derek Jones32bf1862010-03-02 13:46:07 -0600567 foreach ($this->_ci_helper_paths as $path)
568 {
Greg Aker3a746652011-04-19 10:59:47 -0500569 if (file_exists($path.'helpers/'.$helper.'.php'))
Barry Mienydd671972010-10-04 16:33:58 +0200570 {
Greg Aker3a746652011-04-19 10:59:47 -0500571 include_once($path.'helpers/'.$helper.'.php');
Derek Jones32bf1862010-03-02 13:46:07 -0600572
573 $this->_ci_helpers[$helper] = TRUE;
Barry Mienydd671972010-10-04 16:33:58 +0200574 log_message('debug', 'Helper loaded: '.$helper);
Derek Jones32bf1862010-03-02 13:46:07 -0600575 break;
Derek Allard2067d1a2008-11-13 22:59:24 +0000576 }
577 }
578
Derek Jones32bf1862010-03-02 13:46:07 -0600579 // unable to load the helper
580 if ( ! isset($this->_ci_helpers[$helper]))
581 {
Greg Aker3a746652011-04-19 10:59:47 -0500582 show_error('Unable to load the requested file: helpers/'.$helper.'.php');
Derek Jones32bf1862010-03-02 13:46:07 -0600583 }
Barry Mienydd671972010-10-04 16:33:58 +0200584 }
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200585
586 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000587 }
Barry Mienydd671972010-10-04 16:33:58 +0200588
Derek Allard2067d1a2008-11-13 22:59:24 +0000589 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200590
Derek Allard2067d1a2008-11-13 22:59:24 +0000591 /**
592 * Load Helpers
593 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300594 * An alias for the helper() method in case the developer has
595 * written the plural form of it.
Derek Allard2067d1a2008-11-13 22:59:24 +0000596 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300597 * @uses CI_Loader::helper()
598 * @param string|string[] $helpers Helper name(s)
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200599 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000600 */
Greg Akerf5c84022011-04-19 17:13:03 -0500601 public function helpers($helpers = array())
Derek Allard2067d1a2008-11-13 22:59:24 +0000602 {
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200603 return $this->helper($helpers);
Derek Allard2067d1a2008-11-13 22:59:24 +0000604 }
Barry Mienydd671972010-10-04 16:33:58 +0200605
Derek Allard2067d1a2008-11-13 22:59:24 +0000606 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200607
Derek Allard2067d1a2008-11-13 22:59:24 +0000608 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300609 * Language Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000610 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300611 * Loads language files.
612 *
613 * @param string|string[] $files List of language file names to load
614 * @param string Language name
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200615 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000616 */
Andrey Andreev9c12b3f2014-01-06 12:32:30 +0200617 public function language($files, $lang = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000618 {
619 $CI =& get_instance();
Andrey Andreeved4b2582012-10-27 17:46:52 +0300620 is_array($files) OR $files = array($files);
Derek Allard2067d1a2008-11-13 22:59:24 +0000621
Andrey Andreeved4b2582012-10-27 17:46:52 +0300622 foreach ($files as $langfile)
Barry Mienydd671972010-10-04 16:33:58 +0200623 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000624 $CI->lang->load($langfile, $lang);
625 }
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200626
627 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000628 }
Barry Mienydd671972010-10-04 16:33:58 +0200629
Derek Allard2067d1a2008-11-13 22:59:24 +0000630 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200631
Derek Allard2067d1a2008-11-13 22:59:24 +0000632 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300633 * Config Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000634 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300635 * Loads a config file (an alias for CI_Config::load()).
636 *
637 * @uses CI_Config::load()
638 * @param string $file Configuration file name
639 * @param bool $use_sections Whether configuration values should be loaded into their own section
640 * @param bool $fail_gracefully Whether to just return FALSE or display an error message
641 * @return bool TRUE if the file was loaded correctly or FALSE on failure
Derek Allard2067d1a2008-11-13 22:59:24 +0000642 */
Andrey Andreev9c12b3f2014-01-06 12:32:30 +0200643 public function config($file, $use_sections = FALSE, $fail_gracefully = FALSE)
Barry Mienydd671972010-10-04 16:33:58 +0200644 {
Andrey Andreev119d8a72014-01-08 15:27:53 +0200645 return get_instance()->config->load($file, $use_sections, $fail_gracefully);
Derek Allard2067d1a2008-11-13 22:59:24 +0000646 }
647
648 // --------------------------------------------------------------------
Derek Jones32bf1862010-03-02 13:46:07 -0600649
Derek Allard2067d1a2008-11-13 22:59:24 +0000650 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300651 * Driver Loader
Derek Jones8dca0412010-03-05 13:01:44 -0600652 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300653 * Loads a driver library.
Derek Jones8dca0412010-03-05 13:01:44 -0600654 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300655 * @param string|string[] $library Driver name(s)
656 * @param array $params Optional parameters to pass to the driver
657 * @param string $object_name An optional object name to assign to
658 *
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200659 * @return object|bool Object or FALSE on failure if $library is a string
660 * and $object_name is set. CI_Loader instance otherwise.
Derek Jones8dca0412010-03-05 13:01:44 -0600661 */
Andrey Andreev9c12b3f2014-01-06 12:32:30 +0200662 public function driver($library, $params = NULL, $object_name = NULL)
Derek Jones8dca0412010-03-05 13:01:44 -0600663 {
Christopher Guineyb54d3552012-03-10 08:38:10 -0800664 if (is_array($library))
Christopher Guiney9929d6f2012-03-09 19:53:24 -0800665 {
Christopher Guineyb54d3552012-03-10 08:38:10 -0800666 foreach ($library as $driver)
Christopher Guiney9929d6f2012-03-09 19:53:24 -0800667 {
668 $this->driver($driver);
669 }
Christopher Guiney9929d6f2012-03-09 19:53:24 -0800670
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200671 return $this;
672 }
673 elseif (empty($library))
Tom Klingenberg6a15b2d2011-10-07 20:03:30 +0200674 {
675 return FALSE;
676 }
677
vlakofffadb8222013-05-12 10:57:09 +0200678 if ( ! class_exists('CI_Driver_Library', FALSE))
dchill426262d052012-11-24 18:41:13 -0500679 {
680 // We aren't instantiating an object here, just making the base class available
681 require BASEPATH.'libraries/Driver.php';
682 }
683
Derek Jonesd5e0cb52010-03-09 20:20:46 -0600684 // We can save the loader some time since Drivers will *always* be in a subfolder,
685 // and typically identically named to the library
686 if ( ! strpos($library, '/'))
687 {
Greg Akerd25e66a2010-03-28 01:07:09 -0500688 $library = ucfirst($library).'/'.$library;
Derek Jones8dca0412010-03-05 13:01:44 -0600689 }
Barry Mienydd671972010-10-04 16:33:58 +0200690
Derek Jones8dca0412010-03-05 13:01:44 -0600691 return $this->library($library, $params, $object_name);
692 }
693
694 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200695
Derek Jones8dca0412010-03-05 13:01:44 -0600696 /**
Derek Jones32bf1862010-03-02 13:46:07 -0600697 * Add Package Path
Derek Allard2067d1a2008-11-13 22:59:24 +0000698 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300699 * Prepends a parent path to the library, model, helper and config
700 * path arrays.
Derek Allard2067d1a2008-11-13 22:59:24 +0000701 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300702 * @see CI_Loader::$_ci_library_paths
703 * @see CI_Loader::$_ci_model_paths
704 * @see CI_Loader::$_ci_helper_paths
705 * @see CI_Config::$_config_paths
706 *
707 * @param string $path Path to add
708 * @param bool $view_cascade (default: TRUE)
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200709 * @return object
Derek Jones32bf1862010-03-02 13:46:07 -0600710 */
Andrey Andreevcce91802012-06-12 13:25:31 +0300711 public function add_package_path($path, $view_cascade = TRUE)
Derek Jones32bf1862010-03-02 13:46:07 -0600712 {
Pascal Kriete6b6c2742010-11-09 13:12:22 -0500713 $path = rtrim($path, '/').'/';
David Behlercda768a2011-08-14 23:52:48 +0200714
Derek Jones32bf1862010-03-02 13:46:07 -0600715 array_unshift($this->_ci_library_paths, $path);
716 array_unshift($this->_ci_model_paths, $path);
717 array_unshift($this->_ci_helper_paths, $path);
Barry Mienydd671972010-10-04 16:33:58 +0200718
Greg Akerf5c84022011-04-19 17:13:03 -0500719 $this->_ci_view_paths = array($path.'views/' => $view_cascade) + $this->_ci_view_paths;
720
Derek Jones32bf1862010-03-02 13:46:07 -0600721 // Add config file path
722 $config =& $this->_ci_get_component('config');
and-ersb3ec9422013-01-03 16:05:12 +0100723 $config->_config_paths[] = $path;
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200724
725 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000726 }
727
728 // --------------------------------------------------------------------
Derek Jones32bf1862010-03-02 13:46:07 -0600729
730 /**
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000731 * Get Package Paths
732 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300733 * Return a list of all package paths.
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000734 *
vlakoffcdc61132013-05-10 16:47:47 +0200735 * @param bool $include_base Whether to include BASEPATH (default: FALSE)
Andrey Andreeved4b2582012-10-27 17:46:52 +0300736 * @return array
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000737 */
Greg Akerf5c84022011-04-19 17:13:03 -0500738 public function get_package_paths($include_base = FALSE)
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000739 {
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300740 return ($include_base === TRUE) ? $this->_ci_library_paths : $this->_ci_model_paths;
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000741 }
742
743 // --------------------------------------------------------------------
744
745 /**
Derek Jones32bf1862010-03-02 13:46:07 -0600746 * Remove Package Path
747 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300748 * Remove a path from the library, model, helper and/or config
749 * path arrays if it exists. If no path is provided, the most recently
750 * added path will be removed removed.
Derek Jones32bf1862010-03-02 13:46:07 -0600751 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300752 * @param string $path Path to remove
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200753 * @return object
Derek Jones32bf1862010-03-02 13:46:07 -0600754 */
Andrey Andreeved4b2582012-10-27 17:46:52 +0300755 public function remove_package_path($path = '')
Derek Jones32bf1862010-03-02 13:46:07 -0600756 {
757 $config =& $this->_ci_get_component('config');
Barry Mienydd671972010-10-04 16:33:58 +0200758
Alex Bilbieed944a32012-06-02 11:07:47 +0100759 if ($path === '')
Derek Jones32bf1862010-03-02 13:46:07 -0600760 {
Andrey Andreevd7297352012-01-07 22:53:14 +0200761 array_shift($this->_ci_library_paths);
762 array_shift($this->_ci_model_paths);
763 array_shift($this->_ci_helper_paths);
764 array_shift($this->_ci_view_paths);
Korri3684d342012-04-17 00:35:08 -0400765 array_pop($config->_config_paths);
Derek Jones32bf1862010-03-02 13:46:07 -0600766 }
767 else
768 {
Pascal Kriete6b6c2742010-11-09 13:12:22 -0500769 $path = rtrim($path, '/').'/';
Derek Jones32bf1862010-03-02 13:46:07 -0600770 foreach (array('_ci_library_paths', '_ci_model_paths', '_ci_helper_paths') as $var)
771 {
772 if (($key = array_search($path, $this->{$var})) !== FALSE)
773 {
774 unset($this->{$var}[$key]);
775 }
776 }
David Behlercda768a2011-08-14 23:52:48 +0200777
Greg Akerf5c84022011-04-19 17:13:03 -0500778 if (isset($this->_ci_view_paths[$path.'views/']))
779 {
780 unset($this->_ci_view_paths[$path.'views/']);
781 }
Barry Mienydd671972010-10-04 16:33:58 +0200782
Derek Jones32bf1862010-03-02 13:46:07 -0600783 if (($key = array_search($path, $config->_config_paths)) !== FALSE)
784 {
785 unset($config->_config_paths[$key]);
786 }
787 }
Barry Mienydd671972010-10-04 16:33:58 +0200788
Derek Jones32bf1862010-03-02 13:46:07 -0600789 // make sure the application default paths are still in the array
790 $this->_ci_library_paths = array_unique(array_merge($this->_ci_library_paths, array(APPPATH, BASEPATH)));
791 $this->_ci_helper_paths = array_unique(array_merge($this->_ci_helper_paths, array(APPPATH, BASEPATH)));
792 $this->_ci_model_paths = array_unique(array_merge($this->_ci_model_paths, array(APPPATH)));
Greg Akerf5c84022011-04-19 17:13:03 -0500793 $this->_ci_view_paths = array_merge($this->_ci_view_paths, array(APPPATH.'views/' => TRUE));
Derek Jones32bf1862010-03-02 13:46:07 -0600794 $config->_config_paths = array_unique(array_merge($config->_config_paths, array(APPPATH)));
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200795
796 return $this;
Derek Jones32bf1862010-03-02 13:46:07 -0600797 }
798
799 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200800
Derek Allard2067d1a2008-11-13 22:59:24 +0000801 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300802 * Internal CI Data Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000803 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300804 * Used to load views and files.
805 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000806 * Variables are prefixed with _ci_ to avoid symbol collision with
Andrey Andreeved4b2582012-10-27 17:46:52 +0300807 * variables made available to view files.
Derek Allard2067d1a2008-11-13 22:59:24 +0000808 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300809 * @used-by CI_Loader::view()
810 * @used-by CI_Loader::file()
811 * @param array $_ci_data Data to load
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200812 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000813 */
Greg Akerf5c84022011-04-19 17:13:03 -0500814 protected function _ci_load($_ci_data)
Derek Allard2067d1a2008-11-13 22:59:24 +0000815 {
816 // Set the default data variables
817 foreach (array('_ci_view', '_ci_vars', '_ci_path', '_ci_return') as $_ci_val)
818 {
Andrey Andreev94af3552012-03-26 23:10:42 +0300819 $$_ci_val = isset($_ci_data[$_ci_val]) ? $_ci_data[$_ci_val] : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000820 }
David Behlercda768a2011-08-14 23:52:48 +0200821
Greg Akerf5c84022011-04-19 17:13:03 -0500822 $file_exists = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000823
824 // Set the path to the requested file
Alex Bilbie40bd2a72012-06-02 16:04:15 +0100825 if (is_string($_ci_path) && $_ci_path !== '')
Greg Aker8807be32011-04-21 13:06:15 -0500826 {
827 $_ci_x = explode('/', $_ci_path);
828 $_ci_file = end($_ci_x);
829 }
830 else
Derek Allard2067d1a2008-11-13 22:59:24 +0000831 {
832 $_ci_ext = pathinfo($_ci_view, PATHINFO_EXTENSION);
Alex Bilbieed944a32012-06-02 11:07:47 +0100833 $_ci_file = ($_ci_ext === '') ? $_ci_view.'.php' : $_ci_view;
Greg Akerf5c84022011-04-19 17:13:03 -0500834
Joe McFrederick64f470b2012-08-18 12:29:56 -0400835 foreach ($this->_ci_view_paths as $_ci_view_file => $cascade)
Greg Akerf5c84022011-04-19 17:13:03 -0500836 {
Joe McFrederick64f470b2012-08-18 12:29:56 -0400837 if (file_exists($_ci_view_file.$_ci_file))
Greg Akerf5c84022011-04-19 17:13:03 -0500838 {
Joe McFrederick64f470b2012-08-18 12:29:56 -0400839 $_ci_path = $_ci_view_file.$_ci_file;
Greg Akerf5c84022011-04-19 17:13:03 -0500840 $file_exists = TRUE;
841 break;
842 }
David Behlercda768a2011-08-14 23:52:48 +0200843
Greg Akerf5c84022011-04-19 17:13:03 -0500844 if ( ! $cascade)
845 {
846 break;
David Behlercda768a2011-08-14 23:52:48 +0200847 }
Greg Akerf5c84022011-04-19 17:13:03 -0500848 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000849 }
Barry Mienydd671972010-10-04 16:33:58 +0200850
Greg Akerf5c84022011-04-19 17:13:03 -0500851 if ( ! $file_exists && ! file_exists($_ci_path))
Derek Allard2067d1a2008-11-13 22:59:24 +0000852 {
853 show_error('Unable to load the requested file: '.$_ci_file);
854 }
Barry Mienydd671972010-10-04 16:33:58 +0200855
Derek Allard2067d1a2008-11-13 22:59:24 +0000856 // This allows anything loaded using $this->load (views, files, etc.)
857 // to become accessible from within the Controller and Model functions.
Pascal Kriete89ace432010-11-10 15:49:10 -0500858 $_ci_CI =& get_instance();
859 foreach (get_object_vars($_ci_CI) as $_ci_key => $_ci_var)
Derek Allard2067d1a2008-11-13 22:59:24 +0000860 {
Pascal Kriete89ace432010-11-10 15:49:10 -0500861 if ( ! isset($this->$_ci_key))
Derek Allard2067d1a2008-11-13 22:59:24 +0000862 {
Pascal Kriete89ace432010-11-10 15:49:10 -0500863 $this->$_ci_key =& $_ci_CI->$_ci_key;
Derek Allard2067d1a2008-11-13 22:59:24 +0000864 }
865 }
866
867 /*
868 * Extract and cache variables
869 *
vlakoff02506182012-07-03 07:28:50 +0200870 * You can either set variables using the dedicated $this->load->vars()
Derek Allard2067d1a2008-11-13 22:59:24 +0000871 * function or via the second parameter of this function. We'll merge
872 * the two types and cache them so that views that are embedded within
873 * other views can have access to these variables.
Barry Mienydd671972010-10-04 16:33:58 +0200874 */
Derek Allard2067d1a2008-11-13 22:59:24 +0000875 if (is_array($_ci_vars))
876 {
877 $this->_ci_cached_vars = array_merge($this->_ci_cached_vars, $_ci_vars);
878 }
879 extract($this->_ci_cached_vars);
Barry Mienydd671972010-10-04 16:33:58 +0200880
Derek Allard2067d1a2008-11-13 22:59:24 +0000881 /*
882 * Buffer the output
883 *
884 * We buffer the output for two reasons:
885 * 1. Speed. You get a significant speed boost.
Andrey Andreevd7297352012-01-07 22:53:14 +0200886 * 2. So that the final rendered template can be post-processed by
dchill425628ba02012-08-08 12:05:45 -0400887 * the output class. Why do we need post processing? For one thing,
888 * in order to show the elapsed page load time. Unless we can
889 * intercept the content right before it's sent to the browser and
890 * then stop the timer it won't be accurate.
Derek Allard2067d1a2008-11-13 22:59:24 +0000891 */
892 ob_start();
Barry Mienydd671972010-10-04 16:33:58 +0200893
Derek Allard2067d1a2008-11-13 22:59:24 +0000894 // If the PHP installation does not support short tags we'll
895 // do a little string replacement, changing the short tags
896 // to standard PHP echo statements.
Andrey Andreeve9d2dc82012-11-07 14:23:29 +0200897 if ( ! is_php('5.4') && (bool) @ini_get('short_open_tag') === FALSE
898 && config_item('rewrite_short_tags') === TRUE && function_usable('eval')
899 )
Derek Allard2067d1a2008-11-13 22:59:24 +0000900 {
Andrey Andreevd47baab2012-01-09 16:56:46 +0200901 echo eval('?>'.preg_replace('/;*\s*\?>/', '; ?>', str_replace('<?=', '<?php echo ', file_get_contents($_ci_path))));
Derek Allard2067d1a2008-11-13 22:59:24 +0000902 }
903 else
904 {
905 include($_ci_path); // include() vs include_once() allows for multiple views with the same name
906 }
Barry Mienydd671972010-10-04 16:33:58 +0200907
Derek Allard2067d1a2008-11-13 22:59:24 +0000908 log_message('debug', 'File loaded: '.$_ci_path);
Barry Mienydd671972010-10-04 16:33:58 +0200909
Derek Allard2067d1a2008-11-13 22:59:24 +0000910 // Return the file data if requested
911 if ($_ci_return === TRUE)
Barry Mienydd671972010-10-04 16:33:58 +0200912 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000913 $buffer = ob_get_contents();
914 @ob_end_clean();
915 return $buffer;
916 }
917
918 /*
919 * Flush the buffer... or buff the flusher?
920 *
921 * In order to permit views to be nested within
922 * other views, we need to flush the content back out whenever
923 * we are beyond the first level of output buffering so that
924 * it can be seen and included properly by the first included
925 * template and any subsequent ones. Oy!
Barry Mienydd671972010-10-04 16:33:58 +0200926 */
Derek Allard2067d1a2008-11-13 22:59:24 +0000927 if (ob_get_level() > $this->_ci_ob_level + 1)
928 {
929 ob_end_flush();
930 }
931 else
932 {
Greg Aker22f1a632010-11-10 15:34:35 -0600933 $_ci_CI->output->append_output(ob_get_contents());
Derek Allard2067d1a2008-11-13 22:59:24 +0000934 @ob_end_clean();
935 }
Andrey Andreev61a7b8f2014-01-07 13:36:50 +0200936
937 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000938 }
939
940 // --------------------------------------------------------------------
941
942 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +0300943 * Internal CI Class Loader
Derek Allard2067d1a2008-11-13 22:59:24 +0000944 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300945 * @used-by CI_Loader::library()
946 * @uses CI_Loader::_ci_init_class()
Derek Allard2067d1a2008-11-13 22:59:24 +0000947 *
Andrey Andreeved4b2582012-10-27 17:46:52 +0300948 * @param string $class Class name to load
949 * @param mixed $params Optional parameters to pass to the class constructor
950 * @param string $object_name Optional object name to assign to
Barry Mienydd671972010-10-04 16:33:58 +0200951 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000952 */
Greg Akerf5c84022011-04-19 17:13:03 -0500953 protected function _ci_load_class($class, $params = NULL, $object_name = NULL)
Barry Mienydd671972010-10-04 16:33:58 +0200954 {
955 // Get the class name, and while we're at it trim any slashes.
956 // The directory path can be included as part of the class name,
Derek Allard2067d1a2008-11-13 22:59:24 +0000957 // but we don't want a leading slash
Greg Aker3a746652011-04-19 10:59:47 -0500958 $class = str_replace('.php', '', trim($class, '/'));
Barry Mienydd671972010-10-04 16:33:58 +0200959
Derek Allard2067d1a2008-11-13 22:59:24 +0000960 // Was the path included with the class name?
961 // We look for a slash to determine this
Derek Jones32bf1862010-03-02 13:46:07 -0600962 if (($last_slash = strrpos($class, '/')) !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000963 {
Derek Jones32bf1862010-03-02 13:46:07 -0600964 // Extract the path
Andrey Andreevc26d34f2013-01-28 21:46:08 +0200965 $subdir = substr($class, 0, ++$last_slash);
Barry Mienydd671972010-10-04 16:33:58 +0200966
Derek Jones32bf1862010-03-02 13:46:07 -0600967 // Get the filename from the path
Andrey Andreevd7297352012-01-07 22:53:14 +0200968 $class = substr($class, $last_slash);
Derek Allard2067d1a2008-11-13 22:59:24 +0000969 }
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200970 else
Derek Allard2067d1a2008-11-13 22:59:24 +0000971 {
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200972 $subdir = '';
973 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000974
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200975 $class = ucfirst($class);
976 $subclass = APPPATH.'libraries/'.$subdir.config_item('subclass_prefix').$class.'.php';
977
978 // Is this a class extension request?
979 if (file_exists($subclass))
980 {
Daniel1d3752c2013-04-14 16:41:57 -0400981 $baseclass = BASEPATH.'libraries/'.$subdir.$class.'.php';
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200982
983 if ( ! file_exists($baseclass))
Derek Allard2067d1a2008-11-13 22:59:24 +0000984 {
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200985 log_message('error', 'Unable to load the requested class: '.$class);
986 show_error('Unable to load the requested class: '.$class);
Derek Allard2067d1a2008-11-13 22:59:24 +0000987 }
Barry Mienydd671972010-10-04 16:33:58 +0200988
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200989 // Safety: Was the class already loaded by a previous call?
990 if (class_exists(config_item('subclass_prefix').$class, FALSE))
Derek Allard2067d1a2008-11-13 22:59:24 +0000991 {
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200992 // Before we deem this to be a duplicate request, let's see
993 // if a custom object name is being supplied. If so, we'll
994 // return a new instance of the object
995 if ($object_name !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000996 {
Andrey Andreev3608e1a2013-01-28 16:27:30 +0200997 $CI =& get_instance();
998 if ( ! isset($CI->$object_name))
Derek Allard2067d1a2008-11-13 22:59:24 +0000999 {
Andrey Andreev3608e1a2013-01-28 16:27:30 +02001000 return $this->_ci_init_class($class, config_item('subclass_prefix'), $params, $object_name);
Derek Allard2067d1a2008-11-13 22:59:24 +00001001 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001002 }
Barry Mienydd671972010-10-04 16:33:58 +02001003
Andrey Andreev3608e1a2013-01-28 16:27:30 +02001004 log_message('debug', $class.' class already loaded. Second attempt ignored.');
1005 return;
Derek Allard2067d1a2008-11-13 22:59:24 +00001006 }
Andrey Andreev3608e1a2013-01-28 16:27:30 +02001007
1008 include_once($baseclass);
1009 include_once($subclass);
1010
1011 return $this->_ci_init_class($class, config_item('subclass_prefix'), $params, $object_name);
1012 }
1013
vlakoff35672462013-02-15 01:36:04 +01001014 // Let's search for the requested library file and load it.
Andrey Andreev3608e1a2013-01-28 16:27:30 +02001015 foreach ($this->_ci_library_paths as $path)
1016 {
1017 $filepath = $path.'libraries/'.$subdir.$class.'.php';
1018
1019 // Safety: Was the class already loaded by a previous call?
1020 if (class_exists($class, FALSE))
1021 {
1022 // Before we deem this to be a duplicate request, let's see
1023 // if a custom object name is being supplied. If so, we'll
1024 // return a new instance of the object
1025 if ($object_name !== NULL)
1026 {
1027 $CI =& get_instance();
1028 if ( ! isset($CI->$object_name))
1029 {
1030 return $this->_ci_init_class($class, '', $params, $object_name);
1031 }
1032 }
1033
1034 log_message('debug', $class.' class already loaded. Second attempt ignored.');
1035 return;
1036 }
1037 // Does the file exist? No? Bummer...
1038 elseif ( ! file_exists($filepath))
1039 {
1040 continue;
1041 }
1042
1043 include_once($filepath);
1044 return $this->_ci_init_class($class, '', $params, $object_name);
1045 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001046
Andrey Andreevd7297352012-01-07 22:53:14 +02001047 // One last attempt. Maybe the library is in a subdirectory, but it wasn't specified?
Alex Bilbieed944a32012-06-02 11:07:47 +01001048 if ($subdir === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001049 {
Andrey Andreev3608e1a2013-01-28 16:27:30 +02001050 return $this->_ci_load_class($class.'/'.$class, $params, $object_name);
dchill42aee92652012-08-26 21:45:35 -04001051 }
Barry Mienydd671972010-10-04 16:33:58 +02001052
Derek Allard2067d1a2008-11-13 22:59:24 +00001053 // If we got this far we were unable to find the requested class.
Andrey Andreev3608e1a2013-01-28 16:27:30 +02001054 log_message('error', 'Unable to load the requested class: '.$class);
1055 show_error('Unable to load the requested class: '.$class);
Derek Allard2067d1a2008-11-13 22:59:24 +00001056 }
Barry Mienydd671972010-10-04 16:33:58 +02001057
Derek Allard2067d1a2008-11-13 22:59:24 +00001058 // --------------------------------------------------------------------
1059
1060 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +03001061 * Internal CI Class Instantiator
Derek Allard2067d1a2008-11-13 22:59:24 +00001062 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001063 * @used-by CI_Loader::_ci_load_class()
1064 *
1065 * @param string $class Class name
1066 * @param string $prefix Class name prefix
1067 * @param array|null|bool $config Optional configuration to pass to the class constructor:
1068 * FALSE to skip;
1069 * NULL to search in config paths;
1070 * array containing configuration data
1071 * @param string $object_name Optional object name to assign to
Andrey Andreev94af3552012-03-26 23:10:42 +03001072 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +00001073 */
Greg Aker0c9ee4a2011-04-20 09:40:17 -05001074 protected function _ci_init_class($class, $prefix = '', $config = FALSE, $object_name = NULL)
Barry Mienydd671972010-10-04 16:33:58 +02001075 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001076 // Is there an associated config file for this class? Note: these should always be lowercase
Derek Allard2067d1a2008-11-13 22:59:24 +00001077 if ($config === NULL)
1078 {
Eric Barnes5e16ec62011-01-04 17:25:23 -05001079 // Fetch the config paths containing any package paths
1080 $config_component = $this->_ci_get_component('config');
1081
1082 if (is_array($config_component->_config_paths))
Derek Allard2067d1a2008-11-13 22:59:24 +00001083 {
Eric Barnes5e16ec62011-01-04 17:25:23 -05001084 // Break on the first found file, thus package files
1085 // are not overridden by default paths
1086 foreach ($config_component->_config_paths as $path)
1087 {
1088 // We test for both uppercase and lowercase, for servers that
joelcox1bfd9fa2011-01-16 18:49:39 +01001089 // are case-sensitive with regard to file names. Check for environment
1090 // first, global next
Andrey Andreevdb529ca2013-01-28 11:00:02 +02001091 if (file_exists($path.'config/'.ENVIRONMENT.'/'.strtolower($class).'.php'))
joelcox1bfd9fa2011-01-16 18:49:39 +01001092 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001093 include($path.'config/'.ENVIRONMENT.'/'.strtolower($class).'.php');
joelcox1bfd9fa2011-01-16 18:49:39 +01001094 break;
1095 }
Andrey Andreevdb529ca2013-01-28 11:00:02 +02001096 elseif (file_exists($path.'config/'.ENVIRONMENT.'/'.ucfirst(strtolower($class)).'.php'))
joelcox1bfd9fa2011-01-16 18:49:39 +01001097 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001098 include($path.'config/'.ENVIRONMENT.'/'.ucfirst(strtolower($class)).'.php');
joelcox1bfd9fa2011-01-16 18:49:39 +01001099 break;
1100 }
Andrey Andreev94af3552012-03-26 23:10:42 +03001101 elseif (file_exists($path.'config/'.strtolower($class).'.php'))
Eric Barnes5e16ec62011-01-04 17:25:23 -05001102 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001103 include($path.'config/'.strtolower($class).'.php');
Eric Barnes5e16ec62011-01-04 17:25:23 -05001104 break;
1105 }
Andrey Andreev94af3552012-03-26 23:10:42 +03001106 elseif (file_exists($path.'config/'.ucfirst(strtolower($class)).'.php'))
Eric Barnes5e16ec62011-01-04 17:25:23 -05001107 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001108 include($path.'config/'.ucfirst(strtolower($class)).'.php');
Eric Barnes5e16ec62011-01-04 17:25:23 -05001109 break;
1110 }
1111 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001112 }
1113 }
Barry Mienydd671972010-10-04 16:33:58 +02001114
Alex Bilbieed944a32012-06-02 11:07:47 +01001115 if ($prefix === '')
Barry Mienydd671972010-10-04 16:33:58 +02001116 {
Andrey Andreev49e68de2013-02-21 16:30:55 +02001117 if (class_exists('CI_'.$class, FALSE))
Derek Allard2067d1a2008-11-13 22:59:24 +00001118 {
1119 $name = 'CI_'.$class;
1120 }
Andrey Andreev49e68de2013-02-21 16:30:55 +02001121 elseif (class_exists(config_item('subclass_prefix').$class, FALSE))
Derek Allard2067d1a2008-11-13 22:59:24 +00001122 {
1123 $name = config_item('subclass_prefix').$class;
1124 }
1125 else
1126 {
1127 $name = $class;
1128 }
1129 }
1130 else
1131 {
1132 $name = $prefix.$class;
1133 }
Barry Mienydd671972010-10-04 16:33:58 +02001134
Derek Allard2067d1a2008-11-13 22:59:24 +00001135 // Is the class name valid?
Andrey Andreev49e68de2013-02-21 16:30:55 +02001136 if ( ! class_exists($name, FALSE))
Derek Allard2067d1a2008-11-13 22:59:24 +00001137 {
Andrey Andreevd7297352012-01-07 22:53:14 +02001138 log_message('error', 'Non-existent class: '.$name);
jonnueee2df62012-07-16 13:06:16 +01001139 show_error('Non-existent class: '.$name);
Derek Allard2067d1a2008-11-13 22:59:24 +00001140 }
Barry Mienydd671972010-10-04 16:33:58 +02001141
Derek Allard2067d1a2008-11-13 22:59:24 +00001142 // Set the variable name we will assign the class to
Andrey Andreevd7297352012-01-07 22:53:14 +02001143 // Was a custom class name supplied? If so we'll use it
Andrey Andreev519f87a2013-07-23 17:16:10 +03001144 if (empty($object_name))
Derek Allard2067d1a2008-11-13 22:59:24 +00001145 {
Andrey Andreev519f87a2013-07-23 17:16:10 +03001146 $object_name = strtolower($class);
1147 if (isset($this->_ci_varmap[$object_name]))
1148 {
1149 $object_name = $this->_ci_varmap[$object_name];
1150 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001151 }
Andrey Andreev519f87a2013-07-23 17:16:10 +03001152
1153 // Don't overwrite existing properties
1154 $CI =& get_instance();
1155 if (isset($CI->$object_name))
Derek Allard2067d1a2008-11-13 22:59:24 +00001156 {
Andrey Andreev519f87a2013-07-23 17:16:10 +03001157 if ($CI->$object_name instanceof $name)
1158 {
1159 log_message('debug', $class." has already been instantiated as '".$object_name."'. Second attempt aborted.");
1160 return;
1161 }
1162
1163 show_error("Resource '".$object_name."' already exists and is not a ".$class." instance.");
Derek Allard2067d1a2008-11-13 22:59:24 +00001164 }
1165
Barry Mienydd671972010-10-04 16:33:58 +02001166 // Save the class name and object name
Andrey Andreev519f87a2013-07-23 17:16:10 +03001167 $this->_ci_classes[$object_name] = $class;
Derek Allard2067d1a2008-11-13 22:59:24 +00001168
Barry Mienydd671972010-10-04 16:33:58 +02001169 // Instantiate the class
Andrey Andreev519f87a2013-07-23 17:16:10 +03001170 $CI->$object_name = isset($config)
1171 ? new $name($config)
1172 : new $name();
Barry Mienydd671972010-10-04 16:33:58 +02001173 }
1174
Derek Allard2067d1a2008-11-13 22:59:24 +00001175 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001176
Derek Allard2067d1a2008-11-13 22:59:24 +00001177 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +03001178 * CI Autoloader
Derek Allard2067d1a2008-11-13 22:59:24 +00001179 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001180 * Loads component listed in the config/autoload.php file.
Derek Allard2067d1a2008-11-13 22:59:24 +00001181 *
Andrey Andreevcdac2482012-11-03 18:09:01 +02001182 * @used-by CI_Loader::initialize()
Derek Allard2067d1a2008-11-13 22:59:24 +00001183 * @return void
1184 */
Shane Pearson665baec2011-08-22 18:52:19 -05001185 protected function _ci_autoloader()
Barry Mienydd671972010-10-04 16:33:58 +02001186 {
Andrey Andreevdb529ca2013-01-28 11:00:02 +02001187 if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/autoload.php'))
bubbafoley0ea04142011-03-17 14:55:41 -05001188 {
Shane Pearson6adfe632011-08-10 16:42:53 -05001189 include(APPPATH.'config/'.ENVIRONMENT.'/autoload.php');
bubbafoley0ea04142011-03-17 14:55:41 -05001190 }
1191 else
1192 {
Shane Pearson6adfe632011-08-10 16:42:53 -05001193 include(APPPATH.'config/autoload.php');
bubbafoley0ea04142011-03-17 14:55:41 -05001194 }
Barry Mienydd671972010-10-04 16:33:58 +02001195
Derek Allard2067d1a2008-11-13 22:59:24 +00001196 if ( ! isset($autoload))
1197 {
1198 return FALSE;
1199 }
Barry Mienydd671972010-10-04 16:33:58 +02001200
Phil Sturgeon9730c752010-12-15 10:50:15 +00001201 // Autoload packages
1202 if (isset($autoload['packages']))
1203 {
1204 foreach ($autoload['packages'] as $package_path)
1205 {
1206 $this->add_package_path($package_path);
1207 }
1208 }
1209
Derek Allard2067d1a2008-11-13 22:59:24 +00001210 // Load any custom config file
1211 if (count($autoload['config']) > 0)
Barry Mienydd671972010-10-04 16:33:58 +02001212 {
Derek Allard2067d1a2008-11-13 22:59:24 +00001213 $CI =& get_instance();
1214 foreach ($autoload['config'] as $key => $val)
1215 {
1216 $CI->config->load($val);
1217 }
Barry Mienydd671972010-10-04 16:33:58 +02001218 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001219
Derek Jonesc6da5032010-03-09 20:44:27 -06001220 // Autoload helpers and languages
1221 foreach (array('helper', 'language') as $type)
Barry Mienydd671972010-10-04 16:33:58 +02001222 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001223 if (isset($autoload[$type]) && count($autoload[$type]) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001224 {
1225 $this->$type($autoload[$type]);
Barry Mienydd671972010-10-04 16:33:58 +02001226 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001227 }
1228
Andrey Andreev9ab70a82013-07-23 00:09:26 +03001229 // Autoload drivers
1230 if (isset($autoload['drivers']))
1231 {
1232 foreach ($autoload['drivers'] as $item)
1233 {
1234 $this->driver($item);
1235 }
1236 }
1237
Derek Allard2067d1a2008-11-13 22:59:24 +00001238 // Load libraries
Andrey Andreev94af3552012-03-26 23:10:42 +03001239 if (isset($autoload['libraries']) && count($autoload['libraries']) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001240 {
1241 // Load the database driver.
1242 if (in_array('database', $autoload['libraries']))
1243 {
1244 $this->database();
1245 $autoload['libraries'] = array_diff($autoload['libraries'], array('database'));
1246 }
Barry Mienydd671972010-10-04 16:33:58 +02001247
Derek Allard2067d1a2008-11-13 22:59:24 +00001248 // Load all other libraries
1249 foreach ($autoload['libraries'] as $item)
1250 {
1251 $this->library($item);
1252 }
Barry Mienydd671972010-10-04 16:33:58 +02001253 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001254
1255 // Autoload models
1256 if (isset($autoload['model']))
1257 {
1258 $this->model($autoload['model']);
1259 }
Barry Mienydd671972010-10-04 16:33:58 +02001260 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001261
1262 // --------------------------------------------------------------------
1263
1264 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +03001265 * CI Object to Array translator
Derek Allard2067d1a2008-11-13 22:59:24 +00001266 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001267 * Takes an object as input and converts the class variables to
1268 * an associative array with key/value pairs.
Derek Allard2067d1a2008-11-13 22:59:24 +00001269 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001270 * @param object $object Object data to translate
Derek Allard2067d1a2008-11-13 22:59:24 +00001271 * @return array
1272 */
Greg Akerf5c84022011-04-19 17:13:03 -05001273 protected function _ci_object_to_array($object)
Derek Allard2067d1a2008-11-13 22:59:24 +00001274 {
Andrey Andreev94af3552012-03-26 23:10:42 +03001275 return is_object($object) ? get_object_vars($object) : $object;
Derek Allard2067d1a2008-11-13 22:59:24 +00001276 }
1277
1278 // --------------------------------------------------------------------
1279
1280 /**
Andrey Andreeved4b2582012-10-27 17:46:52 +03001281 * CI Component getter
Derek Jones32bf1862010-03-02 13:46:07 -06001282 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001283 * Get a reference to a specific library or model.
1284 *
1285 * @param string $component Component name
Derek Jones32bf1862010-03-02 13:46:07 -06001286 * @return bool
1287 */
Greg Akerf5c84022011-04-19 17:13:03 -05001288 protected function &_ci_get_component($component)
Derek Jones32bf1862010-03-02 13:46:07 -06001289 {
Pascal Kriete89ace432010-11-10 15:49:10 -05001290 $CI =& get_instance();
1291 return $CI->$component;
Derek Jones32bf1862010-03-02 13:46:07 -06001292 }
1293
1294 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001295
Derek Jones32bf1862010-03-02 13:46:07 -06001296 /**
1297 * Prep filename
1298 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001299 * This function prepares filenames of various items to
1300 * make their loading more reliable.
Derek Jones32bf1862010-03-02 13:46:07 -06001301 *
Andrey Andreeved4b2582012-10-27 17:46:52 +03001302 * @param string|string[] $filename Filename(s)
1303 * @param string $extension Filename extension
Derek Jones32bf1862010-03-02 13:46:07 -06001304 * @return array
1305 */
Greg Akerf5c84022011-04-19 17:13:03 -05001306 protected function _ci_prep_filename($filename, $extension)
Derek Jones32bf1862010-03-02 13:46:07 -06001307 {
1308 if ( ! is_array($filename))
Barry Mienydd671972010-10-04 16:33:58 +02001309 {
Andrey Andreevd47baab2012-01-09 16:56:46 +02001310 return array(strtolower(str_replace(array($extension, '.php'), '', $filename).$extension));
Derek Jones32bf1862010-03-02 13:46:07 -06001311 }
1312 else
1313 {
1314 foreach ($filename as $key => $val)
1315 {
Andrey Andreevd47baab2012-01-09 16:56:46 +02001316 $filename[$key] = strtolower(str_replace(array($extension, '.php'), '', $val).$extension);
Derek Jones32bf1862010-03-02 13:46:07 -06001317 }
Barry Mienydd671972010-10-04 16:33:58 +02001318
Derek Jones32bf1862010-03-02 13:46:07 -06001319 return $filename;
1320 }
1321 }
Andrey Andreev94af3552012-03-26 23:10:42 +03001322
Derek Allard2067d1a2008-11-13 22:59:24 +00001323}
1324
1325/* End of file Loader.php */
Tomaz Lovrec8bb20a12013-10-16 12:34:36 +02001326/* Location: ./system/core/Loader.php */