-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathAutoload.php
More file actions
130 lines (115 loc) · 3.88 KB
/
Copy pathAutoload.php
File metadata and controls
130 lines (115 loc) · 3.88 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?php
declare(strict_types=1);
namespace Codeception\Util;
use function array_unshift;
use function file_exists;
use function rtrim;
use function spl_autoload_register;
use function str_contains;
use function str_replace;
use function strrchr;
use function strrpos;
use function substr;
use function trim;
/**
* Autoloader, which is fully compatible with PSR-4,
* and can be used to autoload your `Helper`, `Page`, and `Step` classes.
*/
class Autoload
{
protected static bool $registered = false;
/**
* An associative array where the key is a namespace prefix and the value
* is an array of base directories for classes in that namespace.
*/
protected static array $map = [];
private function __construct()
{
}
/**
* Adds a base directory for a namespace prefix.
*
* Example:
*
* ```php
* <?php
* // app\Codeception\UserHelper will be loaded from '/path/to/helpers/UserHelper.php'
* Autoload::addNamespace('app\Codeception', '/path/to/helpers');
*
* // LoginPage will be loaded from '/path/to/pageobjects/LoginPage.php'
* Autoload::addNamespace('', '/path/to/pageobjects');
*
* Autoload::addNamespace('app\Codeception', '/path/to/controllers');
* ```
*
* @param string $prefix The namespace prefix.
* @param string $baseDir A base directory for class files in the namespace.
* @param bool $prepend If true, prepend the base directory to the stack instead of appending it;
* this causes it to be searched first rather than last.
*/
public static function addNamespace(string $prefix, string $baseDir, bool $prepend = false): void
{
if (!self::$registered) {
spl_autoload_register(fn(string $class): string|false => self::load($class));
self::$registered = true;
}
$prefix = trim($prefix, '\\') . '\\';
$baseDir = rtrim($baseDir, '/\\') . '/';
self::$map[$prefix] ??= [];
if ($prepend) {
array_unshift(self::$map[$prefix], $baseDir);
} else {
self::$map[$prefix][] = $baseDir;
}
}
public static function load(string $class): string|false
{
$prefix = $class;
while (false !== ($pos = strrpos($prefix, '\\'))) {
$prefix = substr($class, 0, $pos + 1);
$relativeClass = substr($class, $pos + 1);
if ($file = self::loadMappedFile($prefix, $relativeClass)) {
return $file;
}
$prefix = rtrim($prefix, '\\');
}
if (isset(self::$map['\\']) && ($class[0] ?? '') !== '\\') {
return self::load('\\' . $class);
}
if (str_contains($class, '\\')) {
$relativeClass = substr(strrchr($class, '\\'), 1);
if ($file = self::loadMappedFile('\\', $relativeClass)) {
return $file;
}
}
return false;
}
/**
* Load the mapped file for a namespace prefix and relative class.
*
* @param string $prefix The namespace prefix.
* @param string $relativeClass The relative class name.
* @return string|false Boolean false if no mapped file can be loaded, or the name of the mapped file that was loaded.
*/
protected static function loadMappedFile(string $prefix, string $relativeClass): string|false
{
if (!isset(self::$map[$prefix])) {
return false;
}
foreach (self::$map[$prefix] as $baseDir) {
$file = $baseDir . str_replace('\\', '/', $relativeClass) . '.php';
if (static::requireFile($file)) {
return $file;
}
}
return false;
}
protected static function requireFile($file): bool
{
if (file_exists($file)) {
require_once $file;
return true;
}
return false;
}
}