ClassLoader::getPrefixes() - Code Metrics - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

ClassLoader::getPrefixes() A
last analyzed 2021-05-27 17:40 UTC

↳ Parent: ClassLoader

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace Elgg;

/**
 * A class/interface/trait autoloader for PHP
 *
 * It is able to load classes that use either:
 *
 *  * The technical interoperability standards for PHP 5.3 namespaces and
 *    class names (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md);
 *
 *  * The PEAR naming convention for classes (http://pear.php.net/).
 *
 * Classes from a sub-namespace or a sub-hierarchy of PEAR classes can be
 * looked for in a list of locations to ease the vendoring of a sub-set of
 * classes for large projects.
 *
 * All discovered files are stored in the internal class map and the map is
 * queried before attempting to find a file.
 *
 * Contains code from Symfony2's UniversalClassLoader.
 *
 * Copyright (c) 2004-2013 Fabien Potencier
 *
 * 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.
 *
 * @access private
 *
 * @package    Elgg.Core
 * @subpackage Autoloader
 * @author     Fabien Potencier <[email protected]>
 */
class ClassLoader {

	protected $namespaces = array();
	protected $prefixes = array();
	protected $fallbacks = array();

	/**
	 * @var \Elgg\ClassMap Map of classes to files
	 */
	protected $map;

	/**
	 * Constructor
	 * 
	 * @param \Elgg\ClassMap $map Class map
	 */
	public function __construct(\Elgg\ClassMap $map) {
		$this->map = $map;
	}

	/**
	 * Get the class map
	 * 
	 * @return \Elgg\ClassMap
	 */
	public function getClassMap() {
		return $this->map;
	}

	/**
	 * Gets the configured namespaces.
	 *
	 * @return array A hash with namespaces as keys and directories as values
	 */
	public function getNamespaces() {
		return $this->namespaces;
	}

	/**
	 * Gets the configured class prefixes.
	 *
	 * @return array A hash with class prefixes as keys and directories as values
	 */
	public function getPrefixes() {
		return $this->prefixes;
	}

	/**
	 * Registers an array of namespaces
	 *
	 * @param array $namespaces An array of namespaces (namespaces as keys and locations as values)
	 * @return void
	 */
	public function registerNamespaces(array $namespaces) {
		foreach ($namespaces as $namespace => $locations) {
			$this->namespaces[$namespace] = (array)$locations;
		}
	}

	/**
	 * Registers a namespace.
	 *
	 * @param string       $namespace The namespace
	 * @param array|string $paths     The location(s) of the namespace
	 * @return void
	 */
	public function registerNamespace($namespace, $paths) {
		$this->namespaces[$namespace] = (array)$paths;
	}

	/**
	 * Registers an array of classes using the PEAR naming convention.
	 *
	 * @param array $classes An array of classes (prefixes as keys and locations as values)
	 * @return void
	 */
	public function registerPrefixes(array $classes) {
		foreach ($classes as $prefix => $locations) {
			$this->prefixes[$prefix] = (array)$locations;
		}
	}

	/**
	 * Registers a set of classes using the PEAR naming convention.
	 *
	 * @param string       $prefix The classes prefix
	 * @param array|string $paths  The location(s) of the classes
	 * @return void
	 */
	public function registerPrefix($prefix, $paths) {
		$this->prefixes[$prefix] = (array)$paths;
	}

	/**
	 * Add a directory to search if no registered directory is found.
	 *
	 * @param string $path The directory
	 * @return void
	 */
	public function addFallback($path) {
		$this->fallbacks[] = rtrim($path, '/\\');
	}

	/**
	 * Registers this instance as an autoloader.
	 * 
	 * @return void
	 */
	public function register() {
		spl_autoload_register(array($this, 'loadClass'));
	}

	/**
	 * Loads the given class or interface, possibly updating the class map.
	 *
	 * @param string $class The name of the class
	 * @return void
	 */
	public function loadClass($class) {
		$file = $this->map->getPath($class);
		if ($file && is_readable($file)) {
			require $file;
			return;
		}

		$file = $this->findFile($class);
		if ($file && is_readable($file)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$this->map->setPath($class, $file);
			$this->map->setAltered(true);
			require $file;
		}
	}

	/**
	 * Finds the path to the file where the class is defined.
	 *
	 * @param string $class The name of the class
	 *
	 * @return string|null The path, if found
	 */
	public function findFile($class) {
		if ('\\' == $class[0]) {
			$class = substr($class, 1);
		}

		$pos = strrpos($class, '\\');
		if (false !== $pos) {
			// namespaced class name
			$namespace = substr($class, 0, $pos);
			$className = substr($class, $pos + 1);
			$normalizedClass = str_replace('\\', DIRECTORY_SEPARATOR, $namespace)
				. DIRECTORY_SEPARATOR
				. str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
			foreach ($this->namespaces as $ns => $dirs) {
				if (0 !== strpos($namespace, $ns)) {
					continue;
				}

				foreach ($dirs as $dir) {
					$file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
					if (is_file($file)) {
						return $file;
					}
				}
			}

		} else {
			// PEAR-like class name
			$normalizedClass = str_replace('_', DIRECTORY_SEPARATOR, $class) . '.php';
			foreach ($this->prefixes as $prefix => $dirs) {
				if (0 !== strpos($class, $prefix)) {
					continue;
				}

				foreach ($dirs as $dir) {
					$file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
					if (is_file($file)) {
						return $file;
					}
				}
			}
		}

		foreach ($this->fallbacks as $dir) {
			$file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
			if (is_file($file)) {
				return $file;
			}
		}
	}
}



1			<?php
2			namespace Elgg;
3
4			/**
5			* A class/interface/trait autoloader for PHP
6			*
7			* It is able to load classes that use either:
8			*
9			* * The technical interoperability standards for PHP 5.3 namespaces and
10			* class names (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md);
11			*
12			* * The PEAR naming convention for classes (http://pear.php.net/).
13			*
14			* Classes from a sub-namespace or a sub-hierarchy of PEAR classes can be
15			* looked for in a list of locations to ease the vendoring of a sub-set of
16			* classes for large projects.
17			*
18			* All discovered files are stored in the internal class map and the map is
19			* queried before attempting to find a file.
20			*
21			* Contains code from Symfony2's UniversalClassLoader.
22			*
23			* Copyright (c) 2004-2013 Fabien Potencier
24			*
25			* Permission is hereby granted, free of charge, to any person obtaining a copy
26			* of this software and associated documentation files (the "Software"), to deal
27			* in the Software without restriction, including without limitation the rights
28			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
29			* copies of the Software, and to permit persons to whom the Software is furnished
30			* to do so, subject to the following conditions:
31			*
32			* The above copyright notice and this permission notice shall be included in all
33			* copies or substantial portions of the Software.
34			*
35			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
36			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
37			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
38			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
39			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
40			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
41			* THE SOFTWARE.
42			*
43			* @access private
44			*
45			* @package Elgg.Core
46			* @subpackage Autoloader
47			* @author Fabien Potencier <[email protected]>
48			*/
49			class ClassLoader {
50
51			protected $namespaces = array();
52			protected $prefixes = array();
53			protected $fallbacks = array();
54
55			/**
56			* @var \Elgg\ClassMap Map of classes to files
57			*/
58			protected $map;
59
60			/**
61			* Constructor
62			*
63			* @param \Elgg\ClassMap $map Class map
64			*/
65	6		public function __construct(\Elgg\ClassMap $map) {
66	6		$this->map = $map;
67	6		}
68
69			/**
70			* Get the class map
71			*
72			* @return \Elgg\ClassMap
73			*/
74			public function getClassMap() {
75			return $this->map;
76			}
77
78			/**
79			* Gets the configured namespaces.
80			*
81			* @return array A hash with namespaces as keys and directories as values
82			*/
83			public function getNamespaces() {
84			return $this->namespaces;
85			}
86
87			/**
88			* Gets the configured class prefixes.
89			*
90			* @return array A hash with class prefixes as keys and directories as values
91			*/
92			public function getPrefixes() {
93			return $this->prefixes;
94			}
95
96			/**
97			* Registers an array of namespaces
98			*
99			* @param array $namespaces An array of namespaces (namespaces as keys and locations as values)
100			* @return void
101			*/
102			public function registerNamespaces(array $namespaces) {
103			foreach ($namespaces as $namespace => $locations) {
104			$this->namespaces[$namespace] = (array)$locations;
105			}
106			}
107
108			/**
109			* Registers a namespace.
110			*
111			* @param string $namespace The namespace
112			* @param array\|string $paths The location(s) of the namespace
113			* @return void
114			*/
115			public function registerNamespace($namespace, $paths) {
116			$this->namespaces[$namespace] = (array)$paths;
117			}
118
119			/**
120			* Registers an array of classes using the PEAR naming convention.
121			*
122			* @param array $classes An array of classes (prefixes as keys and locations as values)
123			* @return void
124			*/
125			public function registerPrefixes(array $classes) {
126			foreach ($classes as $prefix => $locations) {
127			$this->prefixes[$prefix] = (array)$locations;
128			}
129			}
130
131			/**
132			* Registers a set of classes using the PEAR naming convention.
133			*
134			* @param string $prefix The classes prefix
135			* @param array\|string $paths The location(s) of the classes
136			* @return void
137			*/
138			public function registerPrefix($prefix, $paths) {
139			$this->prefixes[$prefix] = (array)$paths;
140			}
141
142			/**
143			* Add a directory to search if no registered directory is found.
144			*
145			* @param string $path The directory
146			* @return void
147			*/
148			public function addFallback($path) {
149			$this->fallbacks[] = rtrim($path, '/\\');
150			}
151
152			/**
153			* Registers this instance as an autoloader.
154			*
155			* @return void
156			*/
157	6		public function register() {
158	6		spl_autoload_register(array($this, 'loadClass'));
159	6		}
160
161			/**
162			* Loads the given class or interface, possibly updating the class map.
163			*
164			* @param string $class The name of the class
165			* @return void
166			*/
167	1		public function loadClass($class) {
168	1		$file = $this->map->getPath($class);
169	1		if ($file && is_readable($file)) {
170			require $file;
171			return;
172			}
173
174	1		$file = $this->findFile($class);
175	1		if ($file && is_readable($file)) {
			0 ignored issues – show Bug Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The expression `$file` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
176			$this->map->setPath($class, $file);
177			$this->map->setAltered(true);
178			require $file;
179			}
180	1		}
181
182			/**
183			* Finds the path to the file where the class is defined.
184			*
185			* @param string $class The name of the class
186			*
187			* @return string\|null The path, if found
188			*/
189	1		public function findFile($class) {
190	1		if ('\\' == $class[0]) {
191			$class = substr($class, 1);
192			}
193
194	1		$pos = strrpos($class, '\\');
195	1		if (false !== $pos) {
196			// namespaced class name
197			$namespace = substr($class, 0, $pos);
198			$className = substr($class, $pos + 1);
199			$normalizedClass = str_replace('\\', DIRECTORY_SEPARATOR, $namespace)
200			. DIRECTORY_SEPARATOR
201			. str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
202			foreach ($this->namespaces as $ns => $dirs) {
203			if (0 !== strpos($namespace, $ns)) {
204			continue;
205			}
206
207		View Code Duplication	foreach ($dirs as $dir) {
208			$file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
209			if (is_file($file)) {
210			return $file;
211			}
212			}
213			}
214
215			} else {
216			// PEAR-like class name
217	1		$normalizedClass = str_replace('_', DIRECTORY_SEPARATOR, $class) . '.php';
218	1		foreach ($this->prefixes as $prefix => $dirs) {
219			if (0 !== strpos($class, $prefix)) {
220			continue;
221			}
222
223		View Code Duplication	foreach ($dirs as $dir) {
224			$file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
225			if (is_file($file)) {
226			return $file;
227			}
228			}
229	1		}
230			}
231
232	1	View Code Duplication	foreach ($this->fallbacks as $dir) {
233			$file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
234			if (is_file($file)) {
235			return $file;
236			}
237	1		}
238	1		}
239			}
240
241

gctools-outilsgc / gcconnex

ClassLoader::getPrefixes() A last analyzed 2021-05-27 17:40 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ClassLoader::getPrefixes() A
last analyzed 2021-05-27 17:40 UTC