phpOMS/Preloader.php at master · Karaka-Management/phpOMS · GitHub

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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php
/**
 * Jingga
 *
 * PHP Version 8.2
 *
 * @package   phpOMS
 * @copyright Dennis Eichhorn
 * @license   OMS License 2.0
 * @version   1.0.0
 * @link      https://jingga.app
 */
declare(strict_types=1);

namespace phpOMS;

/**
 * Preloader class.
 *
 * @package phpOMS
 * @license OMS License 2.0
 * @link    https://jingga.app
 * @since   1.0.0
 */
final class Preloader
{
    /**
     * Files and paths
     *
     * @var string[]
     * @since 1.0.0
     */
    private array $includes = [];

    /**
     * Ignored files and paths
     *
     * @var string[]
     * @since 1.0.0
     */
    private array $ignores = ['.', '..'];

    /**
     * Ignore a path or file from preloading
     *
     * @param string $path Path to prevent preloading
     *
     * @return Preloader
     *
     * @since 1.0.0
     */
    public function ignore(string $path) : self
    {
        $this->ignores[] = $path;

        return $this;
    }

    /**
     * Add a path to preload
     *
     * @param string $path Path to preload
     *
     * @return Preloader
     *
     * @since 1.0.0
     */
    public function includePath(string $path) : self
    {
        $this->includes[] = $path;

        return $this;
    }

    /**
     * Load paths
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function load() : void
    {
        foreach ($this->includes as $include) {
            if (\in_array($include, $this->ignores)) {
                continue;
            }

            if (\is_dir($include)) {
                $this->loadDir($include);
            } elseif (\is_file($include)) {
                $this->loadFile($include);
            }
        }
    }

    /**
     * Load directory paths
     *
     * @param string $path Path to load
     *
     * @return void
     *
     * @since 1.0.0
     */
    private function loadDir(string $path) : void
    {
        $fh = \opendir($path);

        if ($fh === false) {
            return; // @codeCoverageIgnore
        }

        while ($file = \readdir($fh)) {
            if (\in_array($file, $this->ignores)) {
                continue;
            }

            if (\is_dir($path . '/' . $file)) {
                $this->loadDir($path . '/' . $file);
            } elseif (\is_file($path . '/' . $file)) {
                $this->loadFile($path . '/' . $file);
            }
        }

        \closedir($fh);
    }

    /**
     * Load file
     *
     * @param string $path Path to load
     *
     * @return void
     *
     * @since 1.0.0
     */
    private function loadFile(string $path) : void
    {
        if (\in_array($path, $this->ignores)
            || \substr($path, -\strlen('.php')) !== '.php'
        ) {
            return;
        }

        require_once($path);
    }
}