CI_Driver_Library::load_driver() - Code Metrics - ci-bonfire/Sprint - Measure and Improve Code Quality continuously with Scrutinizer

CI_Driver_Library::load_driver() F
last analyzed 2016-08-09 21:23 UTC

↳ Parent: Project

Complexity

Conditions	13
Paths	300

Size

Total Lines	100
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	45
nc	300
nop	1
dl	0
loc	100
rs	3.7737
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @package	CodeIgniter
 * @author	EllisLab Dev Team
 * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
 * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
 * @license	http://opensource.org/licenses/MIT	MIT License
 * @link	http://codeigniter.com
 * @since	Version 1.0.0
 * @filesource
 */
defined('BASEPATH') OR exit('No direct script access allowed');

/**
 * CodeIgniter Driver Library Class
 *
 * This class enables you to create "Driver" libraries that add runtime ability
 * to extend the capabilities of a class via additional driver objects
 *
 * @package		CodeIgniter
 * @subpackage	Libraries
 * @category	Libraries
 * @author		EllisLab Dev Team
 * @link
 */
class CI_Driver_Library {

	/**
	 * Array of drivers that are available to use with the driver class
	 *
	 * @var array
	 */
	protected $valid_drivers = array();

	/**
	 * Name of the current class - usually the driver class
	 *
	 * @var string
	 */
	protected $lib_name;

	/**
	 * Get magic method
	 *
	 * The first time a child is used it won't exist, so we instantiate it
	 * subsequents calls will go straight to the proper child.
	 *
	 * @param	string	Child class name
	 * @return	object	Child class
	 */
	public function __get($child)
	{
		// Try to load the driver
		return $this->load_driver($child);
	}

	/**
	 * Load driver
	 *
	 * Separate load_driver call to support explicit driver load by library or user
	 *
	 * @param	string	Driver name (w/o parent prefix)
	 * @return	object	Child class
	 */
	public function load_driver($child)
	{
		// Get CodeIgniter instance and subclass prefix
		$prefix = config_item('subclass_prefix');

		if ( ! isset($this->lib_name))
		{
			// Get library name without any prefix
			$this->lib_name = str_replace(array('CI_', $prefix), '', get_class($this));
		}

		// The child will be prefixed with the parent lib
		$child_name = $this->lib_name.'_'.$child;

		// See if requested child is a valid driver
		if ( ! in_array($child, $this->valid_drivers))
		{
			// The requested driver isn't valid!
			$msg = 'Invalid driver requested: '.$child_name;
			log_message('error', $msg);
			show_error($msg);
		}

		// Get package paths and filename case variations to search
		$CI = get_instance();
		$paths = $CI->load->get_package_paths(TRUE);

		// Is there an extension?
		$class_name = $prefix.$child_name;
		$found = class_exists($class_name, FALSE);
		if ( ! $found)
		{
			// Check for subclass file
			foreach ($paths as $path)
			{
				// Does the file exist?
				$file = $path.'libraries/'.$this->lib_name.'/drivers/'.$prefix.$child_name.'.php';
				if (file_exists($file))
				{
					// Yes - require base class from BASEPATH
					$basepath = BASEPATH.'libraries/'.$this->lib_name.'/drivers/'.$child_name.'.php';
					if ( ! file_exists($basepath))
					{
						$msg = 'Unable to load the requested class: CI_'.$child_name;
						log_message('error', $msg);
						show_error($msg);
					}

					// Include both sources and mark found
					include_once($basepath);
					include_once($file);
					$found = TRUE;
					break;
				}
			}
		}

		// Do we need to search for the class?
		if ( ! $found)
		{
			// Use standard class name
			$class_name = 'CI_'.$child_name;
			if ( ! class_exists($class_name, FALSE))
			{
				// Check package paths
				foreach ($paths as $path)
				{
					// Does the file exist?
					$file = $path.'libraries/'.$this->lib_name.'/drivers/'.$child_name.'.php';
					if (file_exists($file))
					{
						// Include source
						include_once($file);
						break;
					}
				}
			}
		}

		// Did we finally find the class?
		if ( ! class_exists($class_name, FALSE))
		{
			if (class_exists($child_name, FALSE))
			{
				$class_name = $child_name;
			}
			else
			{
				$msg = 'Unable to load the requested driver: '.$class_name;
				log_message('error', $msg);
				show_error($msg);
			}
		}

		// Instantiate, decorate and add child
		$obj = new $class_name();
		$obj->decorate($this);
		$this->$child = $obj;
		return $this->$child;
	}

}

// --------------------------------------------------------------------------

/**
 * CodeIgniter Driver Class
 *
 * This class enables you to create drivers for a Library based on the Driver Library.
 * It handles the drivers' access to the parent library
 *
 * @package		CodeIgniter
 * @subpackage	Libraries
 * @category	Libraries
 * @author		EllisLab Dev Team
 * @link
 */
class CI_Driver {

	/**
	 * Instance of the parent class
	 *
	 * @var object
	 */
	protected $_parent;

	/**
	 * List of methods in the parent class
	 *
	 * @var array
	 */
	protected $_methods = array();

	/**
	 * List of properties in the parent class
	 *
	 * @var array
	 */
	protected $_properties = array();

	/**
	 * Array of methods and properties for the parent class(es)
	 *
	 * @static
	 * @var	array
	 */
	protected static $_reflections = array();

	/**
	 * Decorate
	 *
	 * Decorates the child with the parent driver lib's methods and properties
	 *
	 * @param	object
	 * @return	void
	 */
	public function decorate($parent)
	{
		$this->_parent = $parent;

		// Lock down attributes to what is defined in the class
		// and speed up references in magic methods

		$class_name = get_class($parent);

		if ( ! isset(self::$_reflections[$class_name]))
		{
			$r = new ReflectionObject($parent);

			foreach ($r->getMethods() as $method)
			{
				if ($method->isPublic())
				{
					$this->_methods[] = $method->getName();
				}
			}

			foreach ($r->getProperties() as $prop)
			{
				if ($prop->isPublic())
				{
					$this->_properties[] = $prop->getName();
				}
			}

			self::$_reflections[$class_name] = array($this->_methods, $this->_properties);
		}
		else
		{
			list($this->_methods, $this->_properties) = self::$_reflections[$class_name];
		}
	}

	// --------------------------------------------------------------------

	/**
	 * __call magic method
	 *
	 * Handles access to the parent driver library's methods
	 *
	 * @param	string
	 * @param	array
	 * @return	mixed
	 */
	public function __call($method, $args = array())
	{
		if (in_array($method, $this->_methods))
		{
			return call_user_func_array(array($this->_parent, $method), $args);
		}

		throw new BadMethodCallException('No such method: '.$method.'()');
	}

	// --------------------------------------------------------------------

	/**
	 * __get magic method
	 *
	 * Handles reading of the parent driver library's properties
	 *
	 * @param	string
	 * @return	mixed
	 */
	public function __get($var)
	{
		if (in_array($var, $this->_properties))
		{
			return $this->_parent->$var;
		}
	}

	// --------------------------------------------------------------------

	/**
	 * __set magic method
	 *
	 * Handles writing to the parent driver library's properties
	 *
	 * @param	string
	 * @param	array
	 * @return	mixed
	 */
	public function __set($var, $val)
	{
		if (in_array($var, $this->_properties))
		{
			$this->_parent->$var = $val;
		}
	}

}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-16 16:43 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 52 and the first side effect is on line 38. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* CodeIgniter
4			*
5			* An open source application development framework for PHP
6			*
7			* This content is released under the MIT License (MIT)
8			*
9			* Copyright (c) 2014 - 2015, British Columbia Institute of Technology
10			*
11			* Permission is hereby granted, free of charge, to any person obtaining a copy
12			* of this software and associated documentation files (the "Software"), to deal
13			* in the Software without restriction, including without limitation the rights
14			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15			* copies of the Software, and to permit persons to whom the Software is
16			* furnished to do so, subject to the following conditions:
17			*
18			* The above copyright notice and this permission notice shall be included in
19			* all copies or substantial portions of the Software.
20			*
21			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27			* THE SOFTWARE.
28			*
29			* @package CodeIgniter
30			* @author EllisLab Dev Team
31			* @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
32			* @copyright Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
33			* @license http://opensource.org/licenses/MIT MIT License
34			* @link http://codeigniter.com
35			* @since Version 1.0.0
36			* @filesource
37			*/
38			defined('BASEPATH') OR exit('No direct script access allowed');
39
40			/**
41			* CodeIgniter Driver Library Class
42			*
43			* This class enables you to create "Driver" libraries that add runtime ability
44			* to extend the capabilities of a class via additional driver objects
45			*
46			* @package CodeIgniter
47			* @subpackage Libraries
48			* @category Libraries
49			* @author EllisLab Dev Team
50			* @link
51			*/
52			class CI_Driver_Library {
53
54			/**
55			* Array of drivers that are available to use with the driver class
56			*
57			* @var array
58			*/
59			protected $valid_drivers = array();
60
61			/**
62			* Name of the current class - usually the driver class
63			*
64			* @var string
65			*/
66			protected $lib_name;
67
68			/**
69			* Get magic method
70			*
71			* The first time a child is used it won't exist, so we instantiate it
72			* subsequents calls will go straight to the proper child.
73			*
74			* @param string Child class name
75			* @return object Child class
76			*/
77			public function __get($child)
78			{
79			// Try to load the driver
80			return $this->load_driver($child);
81			}
82
83			/**
84			* Load driver
85			*
86			* Separate load_driver call to support explicit driver load by library or user
87			*
88			* @param string Driver name (w/o parent prefix)
89			* @return object Child class
90			*/
91			public function load_driver($child)
92			{
93			// Get CodeIgniter instance and subclass prefix
94			$prefix = config_item('subclass_prefix');
95
96			if ( ! isset($this->lib_name))
97			{
98			// Get library name without any prefix
99			$this->lib_name = str_replace(array('CI_', $prefix), '', get_class($this));
100			}
101
102			// The child will be prefixed with the parent lib
103			$child_name = $this->lib_name.'_'.$child;
104
105			// See if requested child is a valid driver
106			if ( ! in_array($child, $this->valid_drivers))
107			{
108			// The requested driver isn't valid!
109			$msg = 'Invalid driver requested: '.$child_name;
110			log_message('error', $msg);
111			show_error($msg);
112			}
113
114			// Get package paths and filename case variations to search
115			$CI = get_instance();
116			$paths = $CI->load->get_package_paths(TRUE);
117
118			// Is there an extension?
119			$class_name = $prefix.$child_name;
120			$found = class_exists($class_name, FALSE);
121			if ( ! $found)
122			{
123			// Check for subclass file
124			foreach ($paths as $path)
125			{
126			// Does the file exist?
127			$file = $path.'libraries/'.$this->lib_name.'/drivers/'.$prefix.$child_name.'.php';
128			if (file_exists($file))
129			{
130			// Yes - require base class from BASEPATH
131			$basepath = BASEPATH.'libraries/'.$this->lib_name.'/drivers/'.$child_name.'.php';
132			if ( ! file_exists($basepath))
133			{
134			$msg = 'Unable to load the requested class: CI_'.$child_name;
135			log_message('error', $msg);
136			show_error($msg);
137			}
138
139			// Include both sources and mark found
140			include_once($basepath);
141			include_once($file);
142			$found = TRUE;
143			break;
144			}
145			}
146			}
147
148			// Do we need to search for the class?
149			if ( ! $found)
150			{
151			// Use standard class name
152			$class_name = 'CI_'.$child_name;
153			if ( ! class_exists($class_name, FALSE))
154			{
155			// Check package paths
156			foreach ($paths as $path)
157			{
158			// Does the file exist?
159			$file = $path.'libraries/'.$this->lib_name.'/drivers/'.$child_name.'.php';
160			if (file_exists($file))
161			{
162			// Include source
163			include_once($file);
164			break;
165			}
166			}
167			}
168			}
169
170			// Did we finally find the class?
171			if ( ! class_exists($class_name, FALSE))
172			{
173			if (class_exists($child_name, FALSE))
174			{
175			$class_name = $child_name;
176			}
177			else
178			{
179			$msg = 'Unable to load the requested driver: '.$class_name;
180			log_message('error', $msg);
181			show_error($msg);
182			}
183			}
184
185			// Instantiate, decorate and add child
186			$obj = new $class_name();
187			$obj->decorate($this);
188			$this->$child = $obj;
189			return $this->$child;
190			}
191
192			}
193
194			// --------------------------------------------------------------------------
195
196			/**
197			* CodeIgniter Driver Class
198			*
199			* This class enables you to create drivers for a Library based on the Driver Library.
200			* It handles the drivers' access to the parent library
201			*
202			* @package CodeIgniter
203			* @subpackage Libraries
204			* @category Libraries
205			* @author EllisLab Dev Team
206			* @link
207			*/
208			class CI_Driver {
209
210			/**
211			* Instance of the parent class
212			*
213			* @var object
214			*/
215			protected $_parent;
216
217			/**
218			* List of methods in the parent class
219			*
220			* @var array
221			*/
222			protected $_methods = array();
223
224			/**
225			* List of properties in the parent class
226			*
227			* @var array
228			*/
229			protected $_properties = array();
230
231			/**
232			* Array of methods and properties for the parent class(es)
233			*
234			* @static
235			* @var array
236			*/
237			protected static $_reflections = array();
238
239			/**
240			* Decorate
241			*
242			* Decorates the child with the parent driver lib's methods and properties
243			*
244			* @param object
245			* @return void
246			*/
247			public function decorate($parent)
248			{
249			$this->_parent = $parent;
250
251			// Lock down attributes to what is defined in the class
252			// and speed up references in magic methods
253
254			$class_name = get_class($parent);
255
256			if ( ! isset(self::$_reflections[$class_name]))
257			{
258			$r = new ReflectionObject($parent);
259
260			foreach ($r->getMethods() as $method)
261			{
262			if ($method->isPublic())
263			{
264			$this->_methods[] = $method->getName();
265			}
266			}
267
268			foreach ($r->getProperties() as $prop)
269			{
270			if ($prop->isPublic())
271			{
272			$this->_properties[] = $prop->getName();
273			}
274			}
275
276			self::$_reflections[$class_name] = array($this->_methods, $this->_properties);
277			}
278			else
279			{
280			list($this->_methods, $this->_properties) = self::$_reflections[$class_name];
281			}
282			}
283
284			// --------------------------------------------------------------------
285
286			/**
287			* __call magic method
288			*
289			* Handles access to the parent driver library's methods
290			*
291			* @param string
292			* @param array
293			* @return mixed
294			*/
295			public function __call($method, $args = array())
296			{
297			if (in_array($method, $this->_methods))
298			{
299			return call_user_func_array(array($this->_parent, $method), $args);
300			}
301
302			throw new BadMethodCallException('No such method: '.$method.'()');
303			}
304
305			// --------------------------------------------------------------------
306
307			/**
308			* __get magic method
309			*
310			* Handles reading of the parent driver library's properties
311			*
312			* @param string
313			* @return mixed
314			*/
315			public function __get($var)
316			{
317			if (in_array($var, $this->_properties))
318			{
319			return $this->_parent->$var;
320			}
321			}
322
323			// --------------------------------------------------------------------
324
325			/**
326			* __set magic method
327			*
328			* Handles writing to the parent driver library's properties
329			*
330			* @param string
331			* @param array
332			* @return mixed
333			*/
334			public function __set($var, $val)
335			{
336			if (in_array($var, $this->_properties))
337			{
338			$this->_parent->$var = $val;
339			}
340			}
341
342			}
343

ci-bonfire / Sprint

GitHub Access Token became invalid

CI_Driver_Library::load_driver() F last analyzed 2016-08-09 21:23 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

CI_Driver_Library::load_driver() F
last analyzed 2016-08-09 21:23 UTC