-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
PluginUnloadCommand.php
121 lines (104 loc) · 3.24 KB
/
PluginUnloadCommand.php
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
<?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
* For full copyright and license information, please see the LICENSE.txt
* 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 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Command;
use Brick\VarExporter\VarExporter;
use Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;
use Cake\Utility\Hash;
/**
* Command for unloading plugins.
*/
class PluginUnloadCommand extends Command
{
/**
* Config file
*
* @var string
*/
protected string $configFile = CONFIG . 'plugins.php';
/**
* @inheritDoc
*/
public static function defaultName(): string
{
return 'plugin unload';
}
/**
* Execute the command
*
* @param \Cake\Console\Arguments $args The command arguments.
* @param \Cake\Console\ConsoleIo $io The console io
* @return int|null The exit code or null for success
*/
public function execute(Arguments $args, ConsoleIo $io): ?int
{
$plugin = (string)$args->getArgument('plugin');
$result = $this->modifyConfigFile($plugin);
if ($result === null) {
$io->success('Plugin removed from `CONFIG/plugins.php`');
return static::CODE_SUCCESS;
}
$io->err($result);
return static::CODE_ERROR;
}
/**
* Modify the plugins config file.
*
* @param string $plugin Plugin name.
* @return string|null
*/
protected function modifyConfigFile(string $plugin): ?string
{
// phpcs:ignore
$config = @include $this->configFile;
if (!is_array($config)) {
return '`CONFIG/plugins.php` not found or does not return an array';
}
$config = Hash::normalize($config);
if (!array_key_exists($plugin, $config)) {
return sprintf('Plugin `%s` could not be found', $plugin);
}
unset($config[$plugin]);
if (class_exists(VarExporter::class)) {
$array = VarExporter::export($config);
} else {
$array = var_export($config, true);
}
$contents = '<?php' . "\n" . 'return ' . $array . ';';
if (file_put_contents($this->configFile, $contents)) {
return null;
}
return 'Failed to update `CONFIG/plugins.php`';
}
/**
* Get the option parser.
*
* @param \Cake\Console\ConsoleOptionParser $parser The option parser to update
* @return \Cake\Console\ConsoleOptionParser
*/
public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
{
$parser->setDescription([
'Command for unloading plugins.',
])
->addArgument('plugin', [
'help' => 'Name of the plugin to unload.',
'required' => true,
]);
return $parser;
}
}