forked from cakephp/cakephp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCommandTask.php
More file actions
132 lines (113 loc) · 4.04 KB
/
Copy pathCommandTask.php
File metadata and controls
132 lines (113 loc) · 4.04 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
124
125
126
127
128
129
130
131
132
<?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 2.5.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Shell\Task;
use Cake\Console\Shell;
use Cake\Core\App;
use Cake\Core\Plugin;
use Cake\Filesystem\Filesystem;
use Cake\Utility\Inflector;
/**
* Base class for Shell Command reflection.
*
* @internal
*/
class CommandTask extends Shell
{
/**
* Gets the shell command listing.
*
* @return array
*/
public function getShellList()
{
$skipFiles = ['app'];
$hiddenCommands = ['command_list', 'completion'];
$plugins = Plugin::loaded();
$shellList = array_fill_keys($plugins, null) + ['CORE' => null, 'app' => null];
$appPath = App::classPath('Shell');
$shellList = $this->_findShells($shellList, $appPath[0], 'app', $skipFiles);
$appPath = App::classPath('Command');
$shellList = $this->_findShells($shellList, $appPath[0], 'app', $skipFiles);
$skipCore = array_merge($skipFiles, $hiddenCommands, $shellList['app']);
$corePath = dirname(__DIR__);
$shellList = $this->_findShells($shellList, $corePath, 'CORE', $skipCore);
$corePath = dirname(dirname(__DIR__)) . DIRECTORY_SEPARATOR . 'Command';
$shellList = $this->_findShells($shellList, $corePath, 'CORE', $skipCore);
foreach ($plugins as $plugin) {
$pluginPath = Plugin::classPath($plugin) . 'Shell';
$shellList = $this->_findShells($shellList, $pluginPath, $plugin, []);
}
return array_filter($shellList);
}
/**
* Find shells in $path and add them to $shellList
*
* @param array $shellList The shell listing array.
* @param string $path The path to look in.
* @param string $key The key to add shells to
* @param string[] $skip A list of commands to exclude.
* @return array The updated list of shells.
*/
protected function _findShells(array $shellList, string $path, string $key, array $skip): array
{
$shells = $this->_scanDir($path);
return $this->_appendShells($key, $shells, $shellList, $skip);
}
/**
* Scan the provided paths for shells, and append them into $shellList
*
* @param string $type The type of object.
* @param string[] $shells The shell names.
* @param array $shellList List of shells.
* @param string[] $skip List of command names to skip.
* @return array The updated $shellList
*/
protected function _appendShells(string $type, array $shells, array $shellList, array $skip): array
{
if (!isset($shellList[$type])) {
$shellList[$type] = [];
}
foreach ($shells as $shell) {
$name = Inflector::underscore(preg_replace('/(Shell|Command)$/', '', $shell));
if (!in_array($name, $skip, true)) {
$shellList[$type][] = $name;
}
}
sort($shellList[$type]);
return $shellList;
}
/**
* Scan a directory for .php files and return the class names that
* should be within them.
*
* @param string $dir The directory to read.
* @return array The list of shell classnames based on conventions.
*/
protected function _scanDir(string $dir): array
{
if (!is_dir($dir)) {
return [];
}
$fs = new Filesystem();
$files = $fs->find($dir, '/\.php$/');
$shells = [];
foreach ($files as $file) {
$shells[] = $file->getBasename('.php');
}
sort($shells);
return $shells;
}
}