-
Notifications
You must be signed in to change notification settings - Fork 565
Expand file tree
/
Copy pathDebugKitPlugin.php
More file actions
123 lines (110 loc) · 3.94 KB
/
Copy pathDebugKitPlugin.php
File metadata and controls
123 lines (110 loc) · 3.94 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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since DebugKit 3.15.0
* @license https://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace DebugKit;
use Cake\Console\CommandCollection;
use Cake\Core\BasePlugin;
use Cake\Core\Configure;
use Cake\Core\PluginApplicationInterface;
use Cake\Error\PhpError;
use Cake\Event\EventInterface;
use Cake\Event\EventManager;
use Cake\Http\MiddlewareQueue;
use DebugKit\Command\BenchmarkCommand;
use DebugKit\Middleware\DebugKitMiddleware;
use DebugKit\Panel\DeprecationsPanel;
/**
* Plugin class for CakePHP plugin collection.
*/
class DebugKitPlugin extends BasePlugin
{
/**
* @var \DebugKit\ToolbarService|null
*/
protected ?ToolbarService $service = null;
/**
* Load all the application configuration and bootstrap logic.
*
* @param \Cake\Core\PluginApplicationInterface $app The host application
* @return void
*/
public function bootstrap(PluginApplicationInterface $app): void
{
$service = new ToolbarService(EventManager::instance(), (array)Configure::read('DebugKit'));
if (!$service->isEnabled()) {
return;
}
$this->service = $service;
$this->setDeprecationHandler($service);
// will load `config/bootstrap.php`.
parent::bootstrap($app);
}
/**
* Add middleware for the plugin.
*
* @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to update.
* @return \Cake\Http\MiddlewareQueue
*/
public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
{
// Only insert middleware if Toolbar Service is available (not in phpunit run)
if ($this->service) {
$middlewareQueue->insertAt(0, new DebugKitMiddleware($this->service));
}
return $middlewareQueue;
}
/**
* Add console commands for the plugin.
*
* @param \Cake\Console\CommandCollection $commands The command collection to update
* @return \Cake\Console\CommandCollection
*/
public function console(CommandCollection $commands): CommandCollection
{
return $commands->add('benchmark', BenchmarkCommand::class);
}
/**
* set deprecation handler
*
* @param \DebugKit\ToolbarService $service The toolbar service instance
* @return void
*/
public function setDeprecationHandler(ToolbarService $service): void
{
if (!empty($service->getConfig('panels')['DebugKit.Deprecations'])) {
EventManager::instance()->on('Error.beforeRender', function (EventInterface $event, PhpError $error): void {
$code = $error->getCode();
if ($code !== E_USER_DEPRECATED && $code !== E_DEPRECATED) {
return;
}
$file = $error->getFile();
$line = $error->getLine();
// Extract the line/file from the message as deprecationWarning
// will calculate the application frame when generating the message.
preg_match('/\\n([^\n,]+?), line: (\d+)\\n/', $error->getMessage(), $matches);
if ($matches) {
$file = $matches[1];
$line = $matches[2];
}
DeprecationsPanel::addDeprecatedError([
'code' => $code,
'message' => $error->getMessage(),
'file' => $file,
'line' => $line,
]);
$event->stopPropagation();
});
}
}
}