-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
PluginLoadCommand.php
140 lines (121 loc) · 3.86 KB
/
PluginLoadCommand.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?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 Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;
use Cake\Core\Exception\MissingPluginException;
use Cake\Core\Plugin;
/**
* Command for loading plugins.
*
* @psalm-suppress PropertyNotSetInConstructor
*/
class PluginLoadCommand extends Command
{
/**
* @inheritDoc
*/
public static function defaultName(): string
{
return 'plugin load';
}
/**
* Arguments
*
* @var \Cake\Console\Arguments
*/
protected $args;
/**
* Console IO
*
* @var \Cake\Console\ConsoleIo
*/
protected $io;
/**
* 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
{
$this->io = $io;
$this->args = $args;
$plugin = $args->getArgument('plugin');
if (!$plugin) {
$this->io->err('You must provide a plugin name in CamelCase format.');
$this->io->err('To load an "Example" plugin, run `cake plugin load Example`.');
return static::CODE_ERROR;
}
try {
Plugin::getCollection()->findPath($plugin);
} catch (MissingPluginException $e) {
$this->io->err($e->getMessage());
$this->io->err('Ensure you have the correct spelling and casing.');
return static::CODE_ERROR;
}
$app = APP . 'Application.php';
if (file_exists($app)) {
$this->modifyApplication($app, $plugin);
return static::CODE_SUCCESS;
}
return static::CODE_ERROR;
}
/**
* Modify the application class
*
* @param string $app The Application file to modify.
* @param string $plugin The plugin name to add.
* @return void
*/
protected function modifyApplication(string $app, string $plugin): void
{
$contents = file_get_contents($app);
$append = "\n \$this->addPlugin('%s');\n";
$insert = str_replace(', []', '', sprintf($append, $plugin));
if (!preg_match('/function bootstrap\(\)(?:\s*)\:(?:\s*)void/m', $contents)) {
$this->io->err('Your Application class does not have a bootstrap() method. Please add one.');
$this->abort();
} else {
$contents = preg_replace(
'/(function bootstrap\(\)(?:\s*)\:(?:\s*)void(?:\s+)\{)/m',
'$1' . $insert,
$contents
);
}
file_put_contents($app, $contents);
$this->io->out('');
$this->io->out(sprintf('%s modified', $app));
}
/**
* 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 loading plugins.',
])
->addArgument('plugin', [
'help' => 'Name of the plugin to load.',
]);
return $parser;
}
}