File: Status.php

package info (click to toggle)
php-composer-xdebug-handler 3.0.5-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 460 kB
  • sloc: php: 2,501; makefile: 18
file content (227 lines) | stat: -rw-r--r-- 5,861 bytes parent folder | download
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?php

declare(strict_types=1);

/*
 * This file is part of composer/xdebug-handler.
 *
 * (c) Composer <https://github.com/composer>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Composer\XdebugHandler\Tests\App\Framework;

use Composer\XdebugHandler\XdebugHandler;

/**
 * @phpstan-import-type restartData from \Composer\XdebugHandler\PhpConfig
 */
class Status
{
    private const INVALID = 'not applicable';
    private const MISSING = 'not available';

    /** @var bool */
    private $isDisplay;
    /** @var bool */
    private $showInis;
    /** @var bool */
    private $loaded = false;

    public function __construct(bool $display, bool $showInis)
    {
        $this->isDisplay = $display;
        $this->showInis = $showInis;
    }

    /**
     *
     * @param class-string $className
     * @return list<string>
     */
    public function getWorkingsStatus(string $className): array
    {
        $this->loaded = extension_loaded('xdebug');
        $result = [];

        // status
        [$status, $info] = $this->getXdebugStatus();
        $result[] = sprintf('[%s] %s', $status, $info);

        if (!$this->isDisplay) {
            return $result;
        }

        // active
        $active = $this->getActive($className);
        $result[] = sprintf('[active] %s', $active);

        // skipped
        $skipped = $this->getSkipped($className);
        $result[] = sprintf('[skipped] %s', $skipped);

        // envs
        foreach($this->getEnvs() as $item) {
            $result[] = sprintf('[env] %s', $item);
        }

        // inis
        foreach($this->getInis($className) as $item) {
            $result[] = sprintf('[ini] %s', $item);
        }

        // settings
        foreach($this->getSettings($className) as $item) {
            $result[] = sprintf('[settings] %s', $item);
        }

        return $result;
    }

    /**
     *
     * @return array{0: string, 1: string}
     */
    private function getXdebugStatus(): array
    {
        $status = $this->loaded ? 'XDEBUG' : 'NO XDEBUG';
        $text = 'The Xdebug extension is';
        $suffix = $this->loaded ? 'loaded' : 'not loaded';
        $info = sprintf('%s %s', $text, $suffix);

        return [$status, $info];
    }

    /**
     *
     * @param class-string $className
     */
    private function getActive(string $className): string
    {
        $active = $className::isXdebugActive();

        return $active === true ? 'true' : 'false';
    }

    /**
     *
     * @param class-string $className
     */
    private function getSkipped(string $className): string
    {
        $version = $className::getSkippedVersion();

        if ($version === '') {
            return $this->loaded ? self::INVALID : self::MISSING;
        }

        return $version;
    }

    /**
     * @return list<string>
     */
    private function getEnvs(): array
    {
        $result = [];
        $envs = ['PHPRC', 'PHP_INI_SCAN_DIR'];

        foreach ($envs as $name) {
            $format = '%s=%s';

            if (false === ($env = getenv($name))) {
                $env = 'unset';
                $format = '%s %s';
            } elseif ($env === '') {
                $env = "''";
            }

            $result[] = sprintf($format, $name, $env);
        }

        return $result;
    }

    /**
     * @param class-string $className
     * @return list<string>
     */
    private function getInis(string $className): array
    {
        $iniFiles = $this->findIniFiles($className);

        if ($iniFiles[0] === '') {
            array_shift($iniFiles);
        }

        $count = count($iniFiles);

        if ($this->showInis || $count === 1) {
            return $iniFiles;
        }

        $message = sprintf("%d more ini files (show with '--inis' option)", $count - 1);

        return [$iniFiles[0], $message];
    }

    /**
     * @param class-string $className
     * @return list<string>
     */
    private function findIniFiles(string $className): array
    {
        $extended = $className !== XdebugHandler::class;

        if ($extended) {
            $iniFiles = $className::getAllIniFiles();
        } elseif (class_exists(XdebugHandler::class)) {
            $iniFiles = $className::getAllIniFiles();
        } else {
            $iniFiles = array((string) php_ini_loaded_file());
            $scanned = php_ini_scanned_files();

            if ($scanned !== false) {
                $iniFiles = array_merge($iniFiles, array_map('trim', explode(',', $scanned)));
            }
        }

        // @phpstan-ignore-next-line
        return !is_array($iniFiles) ? [self::MISSING] : $iniFiles;
    }

    /**
     *
     * @param class-string $className
     * @return list<string>
     */
    private function getSettings(string $className): array
    {
        /** @var restartData|null $settings */
        $settings = $className::getRestartSettings();

        if ($settings === null) {
            return $this->loaded ? [self::INVALID] : [self::MISSING];
        }

        $settings['scannedInis'] = true === $settings['scannedInis'] ? 'true' : 'false';
        $settings['scanDir'] = false === $settings['scanDir'] ? 'false' : $settings['scanDir'];
        $settings['phprc'] = false === $settings['phprc'] ? 'false' : $settings['phprc'];
        $settings['skipped'] = '' === $settings['skipped'] ? "''" : $settings['skipped'];

        $iniCount = count($settings['inis']);
        if ($iniCount === 1) {
            $settings['inis'] = $settings['inis'][0];
        } else {
            $settings['inis'] = sprintf('(%d inis)', $iniCount);
        }

        $data = [];
        foreach($settings as $key => $value) {
            $data[] = sprintf('%s=%s', $key, $value);
        }
        return $data;
    }
}