| Total Complexity | 127 |
| Total Lines | 802 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Console often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Console, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class Console |
||
|
1 ignored issue
–
show
|
|||
| 22 | { |
||
| 23 | |||
| 24 | private $name; |
||
| 25 | private $version; |
||
| 26 | |||
| 27 | /** @var Command[] */ |
||
| 28 | private $commands = []; |
||
| 29 | |||
| 30 | private $wantHelps = false; |
||
| 31 | |||
| 32 | private $catchExceptions = true; |
||
| 33 | private $autoExit = true; |
||
| 34 | private $definition; |
||
| 35 | private $defaultCommand; |
||
| 36 | |||
| 37 | private static $defaultCommands = [ |
||
| 38 | 'help' => "think\\console\\command\\Help", |
||
| 39 | 'list' => "think\\console\\command\\Lists", |
||
| 40 | 'build' => "think\\console\\command\\Build", |
||
| 41 | 'clear' => "think\\console\\command\\Clear", |
||
| 42 | 'make:command' => "think\\console\\command\\make\\Command", |
||
| 43 | 'make:controller' => "think\\console\\command\\make\\Controller", |
||
| 44 | 'make:model' => "think\\console\\command\\make\\Model", |
||
| 45 | 'make:middleware' => "think\\console\\command\\make\\Middleware", |
||
| 46 | 'make:validate' => "think\\console\\command\\make\\Validate", |
||
| 47 | 'optimize:autoload' => "think\\console\\command\\optimize\\Autoload", |
||
| 48 | 'optimize:config' => "think\\console\\command\\optimize\\Config", |
||
| 49 | 'optimize:schema' => "think\\console\\command\\optimize\\Schema", |
||
| 50 | 'optimize:route' => "think\\console\\command\\optimize\\Route", |
||
| 51 | 'run' => "think\\console\\command\\RunServer", |
||
| 52 | 'version' => "think\\console\\command\\Version", |
||
| 53 | 'route:list' => "think\\console\\command\\RouteList", |
||
| 54 | ]; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Console constructor. |
||
| 58 | * @access public |
||
| 59 | * @param string $name 名称 |
||
| 60 | * @param string $version 版本 |
||
| 61 | * @param null|string $user 执行用户 |
||
|
1 ignored issue
–
show
|
|||
| 62 | */ |
||
| 63 | public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN', $user = null) |
||
| 64 | { |
||
| 65 | $this->name = $name; |
||
| 66 | $this->version = $version; |
||
| 67 | |||
| 68 | if ($user) { |
||
| 69 | $this->setUser($user); |
||
| 70 | } |
||
| 71 | |||
| 72 | $this->defaultCommand = 'list'; |
||
| 73 | $this->definition = $this->getDefaultInputDefinition(); |
||
| 74 | } |
||
| 75 | |||
| 76 | /** |
||
| 77 | * 设置执行用户 |
||
| 78 | * @param $user |
||
| 79 | */ |
||
| 80 | public function setUser($user) |
||
| 81 | { |
||
| 82 | if (DIRECTORY_SEPARATOR == '\\') { |
||
| 83 | return; |
||
| 84 | } |
||
| 85 | |||
| 86 | $user = posix_getpwnam($user); |
||
| 87 | if ($user) { |
||
| 88 | posix_setuid($user['uid']); |
||
| 89 | posix_setgid($user['gid']); |
||
| 90 | } |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * 初始化 Console |
||
| 95 | * @access public |
||
| 96 | * @param bool $run 是否运行 Console |
||
| 97 | * @return int|Console |
||
| 98 | */ |
||
| 99 | public static function init($run = true) |
||
| 100 | { |
||
| 101 | static $console; |
||
| 102 | |||
| 103 | if (!$console) { |
||
| 104 | $config = Container::get('config')->pull('console'); |
||
| 105 | $console = new self($config['name'], $config['version'], $config['user']); |
||
| 106 | |||
| 107 | $commands = $console->getDefinedCommands($config); |
||
| 108 | |||
| 109 | // 添加指令集 |
||
| 110 | $console->addCommands($commands); |
||
| 111 | } |
||
| 112 | |||
| 113 | if ($run) { |
||
| 114 | // 运行 |
||
| 115 | return $console->run(); |
||
| 116 | } else { |
||
| 117 | return $console; |
||
| 118 | } |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * @access public |
||
| 123 | * @param array $config |
||
| 124 | * @return array |
||
| 125 | */ |
||
| 126 | public function getDefinedCommands(array $config = []) |
||
| 127 | { |
||
| 128 | $commands = self::$defaultCommands; |
||
| 129 | |||
| 130 | if (!empty($config['auto_path']) && is_dir($config['auto_path'])) { |
||
| 131 | // 自动加载指令类 |
||
| 132 | $files = scandir($config['auto_path']); |
||
| 133 | |||
| 134 | if (count($files) > 2) { |
||
| 135 | $beforeClass = get_declared_classes(); |
||
| 136 | |||
| 137 | foreach ($files as $file) { |
||
| 138 | if (pathinfo($file, PATHINFO_EXTENSION) == 'php') { |
||
| 139 | include $config['auto_path'] . $file; |
||
| 140 | } |
||
| 141 | } |
||
| 142 | |||
| 143 | $afterClass = get_declared_classes(); |
||
| 144 | $commands = array_merge($commands, array_diff($afterClass, $beforeClass)); |
||
| 145 | } |
||
| 146 | } |
||
| 147 | |||
| 148 | $file = Container::get('env')->get('app_path') . 'command.php'; |
||
| 149 | |||
| 150 | if (is_file($file)) { |
||
| 151 | $appCommands = include $file; |
||
| 152 | |||
| 153 | if (is_array($appCommands)) { |
||
| 154 | $commands = array_merge($commands, $appCommands); |
||
| 155 | } |
||
| 156 | } |
||
| 157 | |||
| 158 | return $commands; |
||
| 159 | } |
||
| 160 | |||
| 161 | /** |
||
| 162 | * @access public |
||
| 163 | * @param string $command |
||
| 164 | * @param array $parameters |
||
| 165 | * @param string $driver |
||
| 166 | * @return Output|Buffer |
||
| 167 | */ |
||
| 168 | public static function call($command, array $parameters = [], $driver = 'buffer') |
||
| 169 | { |
||
| 170 | $console = self::init(false); |
||
| 171 | |||
| 172 | array_unshift($parameters, $command); |
||
| 173 | |||
| 174 | $input = new Input($parameters); |
||
| 175 | $output = new Output($driver); |
||
| 176 | |||
| 177 | $console->setCatchExceptions(false); |
||
| 178 | $console->find($command)->run($input, $output); |
||
| 179 | |||
| 180 | return $output; |
||
| 181 | } |
||
| 182 | |||
| 183 | /** |
||
| 184 | * 执行当前的指令 |
||
| 185 | * @access public |
||
| 186 | * @return int |
||
| 187 | * @throws \Exception |
||
| 188 | * @api |
||
| 189 | */ |
||
| 190 | public function run() |
||
| 191 | { |
||
| 192 | $input = new Input(); |
||
| 193 | $output = new Output(); |
||
| 194 | |||
| 195 | $this->configureIO($input, $output); |
||
| 196 | |||
| 197 | try { |
||
| 198 | $exitCode = $this->doRun($input, $output); |
||
| 199 | } catch (\Exception $e) { |
||
| 200 | if (!$this->catchExceptions) { |
||
| 201 | throw $e; |
||
| 202 | } |
||
| 203 | |||
| 204 | $output->renderException($e); |
||
| 205 | |||
| 206 | $exitCode = $e->getCode(); |
||
| 207 | if (is_numeric($exitCode)) { |
||
| 208 | $exitCode = (int) $exitCode; |
||
| 209 | if (0 === $exitCode) { |
||
| 210 | $exitCode = 1; |
||
| 211 | } |
||
| 212 | } else { |
||
| 213 | $exitCode = 1; |
||
| 214 | } |
||
| 215 | } |
||
| 216 | |||
| 217 | if ($this->autoExit) { |
||
| 218 | if ($exitCode > 255) { |
||
| 219 | $exitCode = 255; |
||
| 220 | } |
||
| 221 | |||
| 222 | exit($exitCode); |
||
| 223 | } |
||
| 224 | |||
| 225 | return $exitCode; |
||
| 226 | } |
||
| 227 | |||
| 228 | /** |
||
| 229 | * 执行指令 |
||
| 230 | * @access public |
||
| 231 | * @param Input $input |
||
| 232 | * @param Output $output |
||
| 233 | * @return int |
||
| 234 | */ |
||
| 235 | public function doRun(Input $input, Output $output) |
||
| 236 | { |
||
| 237 | if (true === $input->hasParameterOption(['--version', '-V'])) { |
||
| 238 | $output->writeln($this->getLongVersion()); |
||
| 239 | |||
| 240 | return 0; |
||
| 241 | } |
||
| 242 | |||
| 243 | $name = $this->getCommandName($input); |
||
| 244 | |||
| 245 | if (true === $input->hasParameterOption(['--help', '-h'])) { |
||
| 246 | if (!$name) { |
||
| 247 | $name = 'help'; |
||
| 248 | $input = new Input(['help']); |
||
| 249 | } else { |
||
| 250 | $this->wantHelps = true; |
||
| 251 | } |
||
| 252 | } |
||
| 253 | |||
| 254 | if (!$name) { |
||
| 255 | $name = $this->defaultCommand; |
||
| 256 | $input = new Input([$this->defaultCommand]); |
||
| 257 | } |
||
| 258 | |||
| 259 | $command = $this->find($name); |
||
| 260 | |||
| 261 | $exitCode = $this->doRunCommand($command, $input, $output); |
||
| 262 | |||
| 263 | return $exitCode; |
||
| 264 | } |
||
| 265 | |||
| 266 | /** |
||
| 267 | * 设置输入参数定义 |
||
| 268 | * @access public |
||
| 269 | * @param InputDefinition $definition |
||
| 270 | */ |
||
| 271 | public function setDefinition(InputDefinition $definition) |
||
| 272 | { |
||
| 273 | $this->definition = $definition; |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * 获取输入参数定义 |
||
| 278 | * @access public |
||
| 279 | * @return InputDefinition The InputDefinition instance |
||
| 280 | */ |
||
| 281 | public function getDefinition() |
||
| 282 | { |
||
| 283 | return $this->definition; |
||
| 284 | } |
||
| 285 | |||
| 286 | /** |
||
| 287 | * Gets the help message. |
||
| 288 | * @access public |
||
| 289 | * @return string A help message. |
||
| 290 | */ |
||
| 291 | public function getHelp() |
||
| 292 | { |
||
| 293 | return $this->getLongVersion(); |
||
| 294 | } |
||
| 295 | |||
| 296 | /** |
||
| 297 | * 是否捕获异常 |
||
| 298 | * @access public |
||
| 299 | * @param bool $boolean |
||
| 300 | * @api |
||
| 301 | */ |
||
| 302 | public function setCatchExceptions($boolean) |
||
| 303 | { |
||
| 304 | $this->catchExceptions = (bool) $boolean; |
||
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | * 是否自动退出 |
||
| 309 | * @access public |
||
| 310 | * @param bool $boolean |
||
| 311 | * @api |
||
| 312 | */ |
||
| 313 | public function setAutoExit($boolean) |
||
| 314 | { |
||
| 315 | $this->autoExit = (bool) $boolean; |
||
| 316 | } |
||
| 317 | |||
| 318 | /** |
||
| 319 | * 获取名称 |
||
| 320 | * @access public |
||
| 321 | * @return string |
||
| 322 | */ |
||
| 323 | public function getName() |
||
| 324 | { |
||
| 325 | return $this->name; |
||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * 设置名称 |
||
| 330 | * @access public |
||
| 331 | * @param string $name |
||
| 332 | */ |
||
| 333 | public function setName($name) |
||
| 334 | { |
||
| 335 | $this->name = $name; |
||
| 336 | } |
||
| 337 | |||
| 338 | /** |
||
| 339 | * 获取版本 |
||
| 340 | * @access public |
||
| 341 | * @return string |
||
| 342 | * @api |
||
| 343 | */ |
||
| 344 | public function getVersion() |
||
| 345 | { |
||
| 346 | return $this->version; |
||
| 347 | } |
||
| 348 | |||
| 349 | /** |
||
| 350 | * 设置版本 |
||
| 351 | * @access public |
||
| 352 | * @param string $version |
||
| 353 | */ |
||
| 354 | public function setVersion($version) |
||
| 355 | { |
||
| 356 | $this->version = $version; |
||
| 357 | } |
||
| 358 | |||
| 359 | /** |
||
| 360 | * 获取完整的版本号 |
||
| 361 | * @access public |
||
| 362 | * @return string |
||
| 363 | */ |
||
| 364 | public function getLongVersion() |
||
| 365 | { |
||
| 366 | if ('UNKNOWN' !== $this->getName() && 'UNKNOWN' !== $this->getVersion()) { |
||
| 367 | return sprintf('<info>%s</info> version <comment>%s</comment>', $this->getName(), $this->getVersion()); |
||
| 368 | } |
||
| 369 | |||
| 370 | return '<info>Console Tool</info>'; |
||
| 371 | } |
||
| 372 | |||
| 373 | /** |
||
| 374 | * 注册一个指令 (便于动态创建指令) |
||
| 375 | * @access public |
||
| 376 | * @param string $name 指令名 |
||
| 377 | * @return Command |
||
| 378 | */ |
||
| 379 | public function register($name) |
||
| 380 | { |
||
| 381 | return $this->add(new Command($name)); |
||
| 382 | } |
||
| 383 | |||
| 384 | /** |
||
| 385 | * 添加指令集 |
||
| 386 | * @access public |
||
| 387 | * @param array $commands |
||
| 388 | */ |
||
| 389 | public function addCommands(array $commands) |
||
| 390 | { |
||
| 391 | foreach ($commands as $key => $command) { |
||
| 392 | if (is_subclass_of($command, "\\think\\console\\Command")) { |
||
| 393 | // 注册指令 |
||
| 394 | $this->add($command, is_numeric($key) ? '' : $key); |
||
| 395 | } |
||
| 396 | } |
||
| 397 | } |
||
| 398 | |||
| 399 | /** |
||
| 400 | * 注册一个指令(对象) |
||
| 401 | * @access public |
||
| 402 | * @param mixed $command 指令对象或者指令类名 |
||
| 403 | * @param string $name 指令名 留空则自动获取 |
||
| 404 | * @return mixed |
||
| 405 | */ |
||
| 406 | public function add($command, $name) |
||
| 407 | { |
||
| 408 | if ($name) { |
||
| 409 | $this->commands[$name] = $command; |
||
| 410 | return; |
||
| 411 | } |
||
| 412 | |||
| 413 | if (is_string($command)) { |
||
| 414 | $command = new $command(); |
||
| 415 | } |
||
| 416 | |||
| 417 | $command->setConsole($this); |
||
| 418 | |||
| 419 | if (!$command->isEnabled()) { |
||
| 420 | $command->setConsole(null); |
||
| 421 | return; |
||
| 422 | } |
||
| 423 | |||
| 424 | if (null === $command->getDefinition()) { |
||
| 425 | throw new \LogicException(sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', get_class($command))); |
||
| 426 | } |
||
| 427 | |||
| 428 | $this->commands[$command->getName()] = $command; |
||
| 429 | |||
| 430 | foreach ($command->getAliases() as $alias) { |
||
| 431 | $this->commands[$alias] = $command; |
||
| 432 | } |
||
| 433 | |||
| 434 | return $command; |
||
| 435 | } |
||
| 436 | |||
| 437 | /** |
||
| 438 | * 获取指令 |
||
| 439 | * @access public |
||
| 440 | * @param string $name 指令名称 |
||
| 441 | * @return Command |
||
| 442 | * @throws \InvalidArgumentException |
||
| 443 | */ |
||
| 444 | public function get($name) |
||
| 445 | { |
||
| 446 | if (!isset($this->commands[$name])) { |
||
| 447 | throw new \InvalidArgumentException(sprintf('The command "%s" does not exist.', $name)); |
||
| 448 | } |
||
| 449 | |||
| 450 | $command = $this->commands[$name]; |
||
| 451 | |||
| 452 | if (is_string($command)) { |
||
| 453 | $command = new $command(); |
||
| 454 | } |
||
| 455 | |||
| 456 | $command->setConsole($this); |
||
| 457 | |||
| 458 | if ($this->wantHelps) { |
||
| 459 | $this->wantHelps = false; |
||
| 460 | |||
| 461 | /** @var HelpCommand $helpCommand */ |
||
| 462 | $helpCommand = $this->get('help'); |
||
| 463 | $helpCommand->setCommand($command); |
||
| 464 | |||
| 465 | return $helpCommand; |
||
| 466 | } |
||
| 467 | |||
| 468 | return $command; |
||
| 469 | } |
||
| 470 | |||
| 471 | /** |
||
| 472 | * 某个指令是否存在 |
||
| 473 | * @access public |
||
| 474 | * @param string $name 指令名称 |
||
| 475 | * @return bool |
||
| 476 | */ |
||
| 477 | public function has($name) |
||
| 478 | { |
||
| 479 | return isset($this->commands[$name]); |
||
| 480 | } |
||
| 481 | |||
| 482 | /** |
||
| 483 | * 获取所有的命名空间 |
||
| 484 | * @access public |
||
| 485 | * @return array |
||
| 486 | */ |
||
| 487 | public function getNamespaces() |
||
| 488 | { |
||
| 489 | $namespaces = []; |
||
| 490 | foreach ($this->commands as $command) { |
||
| 491 | $namespaces = array_merge($namespaces, $this->extractAllNamespaces($command->getName())); |
||
| 492 | |||
| 493 | foreach ($command->getAliases() as $alias) { |
||
| 494 | $namespaces = array_merge($namespaces, $this->extractAllNamespaces($alias)); |
||
| 495 | } |
||
| 496 | } |
||
| 497 | |||
| 498 | return array_values(array_unique(array_filter($namespaces))); |
||
| 499 | } |
||
| 500 | |||
| 501 | /** |
||
| 502 | * 查找注册命名空间中的名称或缩写。 |
||
| 503 | * @access public |
||
| 504 | * @param string $namespace |
||
| 505 | * @return string |
||
| 506 | * @throws \InvalidArgumentException |
||
| 507 | */ |
||
| 508 | public function findNamespace($namespace) |
||
| 509 | { |
||
| 510 | $allNamespaces = $this->getNamespaces(); |
||
| 511 | $expr = preg_replace_callback('{([^:]+|)}', function ($matches) { |
||
| 512 | return preg_quote($matches[1]) . '[^:]*'; |
||
| 513 | }, $namespace); |
||
| 514 | $namespaces = preg_grep('{^' . $expr . '}', $allNamespaces); |
||
| 515 | |||
| 516 | if (empty($namespaces)) { |
||
| 517 | $message = sprintf('There are no commands defined in the "%s" namespace.', $namespace); |
||
| 518 | |||
| 519 | if ($alternatives = $this->findAlternatives($namespace, $allNamespaces)) { |
||
| 520 | if (1 == count($alternatives)) { |
||
| 521 | $message .= "\n\nDid you mean this?\n "; |
||
| 522 | } else { |
||
| 523 | $message .= "\n\nDid you mean one of these?\n "; |
||
| 524 | } |
||
| 525 | |||
| 526 | $message .= implode("\n ", $alternatives); |
||
| 527 | } |
||
| 528 | |||
| 529 | throw new \InvalidArgumentException($message); |
||
| 530 | } |
||
| 531 | |||
| 532 | $exact = in_array($namespace, $namespaces, true); |
||
| 533 | if (count($namespaces) > 1 && !$exact) { |
||
| 534 | throw new \InvalidArgumentException(sprintf('The namespace "%s" is ambiguous (%s).', $namespace, $this->getAbbreviationSuggestions(array_values($namespaces)))); |
||
| 535 | } |
||
| 536 | |||
| 537 | return $exact ? $namespace : reset($namespaces); |
||
| 538 | } |
||
| 539 | |||
| 540 | /** |
||
| 541 | * 查找指令 |
||
| 542 | * @access public |
||
| 543 | * @param string $name 名称或者别名 |
||
| 544 | * @return Command |
||
| 545 | * @throws \InvalidArgumentException |
||
| 546 | */ |
||
| 547 | public function find($name) |
||
| 548 | { |
||
| 549 | $allCommands = array_keys($this->commands); |
||
| 550 | |||
| 551 | $expr = preg_replace_callback('{([^:]+|)}', function ($matches) { |
||
| 552 | return preg_quote($matches[1]) . '[^:]*'; |
||
| 553 | }, $name); |
||
| 554 | |||
| 555 | $commands = preg_grep('{^' . $expr . '}', $allCommands); |
||
| 556 | |||
| 557 | if (empty($commands) || count(preg_grep('{^' . $expr . '$}', $commands)) < 1) { |
||
| 558 | if (false !== $pos = strrpos($name, ':')) { |
||
| 559 | $this->findNamespace(substr($name, 0, $pos)); |
||
| 560 | } |
||
| 561 | |||
| 562 | $message = sprintf('Command "%s" is not defined.', $name); |
||
| 563 | |||
| 564 | if ($alternatives = $this->findAlternatives($name, $allCommands)) { |
||
| 565 | if (1 == count($alternatives)) { |
||
| 566 | $message .= "\n\nDid you mean this?\n "; |
||
| 567 | } else { |
||
| 568 | $message .= "\n\nDid you mean one of these?\n "; |
||
| 569 | } |
||
| 570 | $message .= implode("\n ", $alternatives); |
||
| 571 | } |
||
| 572 | |||
| 573 | throw new \InvalidArgumentException($message); |
||
| 574 | } |
||
| 575 | |||
| 576 | $exact = in_array($name, $commands, true); |
||
| 577 | if (count($commands) > 1 && !$exact) { |
||
| 578 | $suggestions = $this->getAbbreviationSuggestions(array_values($commands)); |
||
| 579 | |||
| 580 | throw new \InvalidArgumentException(sprintf('Command "%s" is ambiguous (%s).', $name, $suggestions)); |
||
| 581 | } |
||
| 582 | |||
| 583 | return $this->get($exact ? $name : reset($commands)); |
||
| 584 | } |
||
| 585 | |||
| 586 | /** |
||
| 587 | * 获取所有的指令 |
||
| 588 | * @access public |
||
| 589 | * @param string $namespace 命名空间 |
||
| 590 | * @return Command[] |
||
| 591 | * @api |
||
| 592 | */ |
||
| 593 | public function all($namespace = null) |
||
| 594 | { |
||
| 595 | if (null === $namespace) { |
||
| 596 | return $this->commands; |
||
| 597 | } |
||
| 598 | |||
| 599 | $commands = []; |
||
| 600 | foreach ($this->commands as $name => $command) { |
||
| 601 | if ($this->extractNamespace($name, substr_count($namespace, ':') + 1) === $namespace) { |
||
| 602 | $commands[$name] = $command; |
||
| 603 | } |
||
| 604 | } |
||
| 605 | |||
| 606 | return $commands; |
||
| 607 | } |
||
| 608 | |||
| 609 | /** |
||
| 610 | * 获取可能的指令名 |
||
| 611 | * @access public |
||
| 612 | * @param array $names |
||
| 613 | * @return array |
||
| 614 | */ |
||
| 615 | public static function getAbbreviations($names) |
||
| 616 | { |
||
| 617 | $abbrevs = []; |
||
| 618 | foreach ($names as $name) { |
||
| 619 | for ($len = strlen($name); $len > 0; --$len) { |
||
| 620 | $abbrev = substr($name, 0, $len); |
||
| 621 | $abbrevs[$abbrev][] = $name; |
||
| 622 | } |
||
| 623 | } |
||
| 624 | |||
| 625 | return $abbrevs; |
||
| 626 | } |
||
| 627 | |||
| 628 | /** |
||
| 629 | * 配置基于用户的参数和选项的输入和输出实例。 |
||
| 630 | * @access protected |
||
| 631 | * @param Input $input 输入实例 |
||
| 632 | * @param Output $output 输出实例 |
||
| 633 | */ |
||
| 634 | protected function configureIO(Input $input, Output $output) |
||
| 635 | { |
||
| 636 | if (true === $input->hasParameterOption(['--ansi'])) { |
||
| 637 | $output->setDecorated(true); |
||
| 638 | } elseif (true === $input->hasParameterOption(['--no-ansi'])) { |
||
| 639 | $output->setDecorated(false); |
||
| 640 | } |
||
| 641 | |||
| 642 | if (true === $input->hasParameterOption(['--no-interaction', '-n'])) { |
||
| 643 | $input->setInteractive(false); |
||
| 644 | } |
||
| 645 | |||
| 646 | if (true === $input->hasParameterOption(['--quiet', '-q'])) { |
||
| 647 | $output->setVerbosity(Output::VERBOSITY_QUIET); |
||
| 648 | } else { |
||
| 649 | if ($input->hasParameterOption('-vvv') || $input->hasParameterOption('--verbose=3') || $input->getParameterOption('--verbose') === 3) { |
||
| 650 | $output->setVerbosity(Output::VERBOSITY_DEBUG); |
||
| 651 | } elseif ($input->hasParameterOption('-vv') || $input->hasParameterOption('--verbose=2') || $input->getParameterOption('--verbose') === 2) { |
||
| 652 | $output->setVerbosity(Output::VERBOSITY_VERY_VERBOSE); |
||
| 653 | } elseif ($input->hasParameterOption('-v') || $input->hasParameterOption('--verbose=1') || $input->hasParameterOption('--verbose') || $input->getParameterOption('--verbose')) { |
||
| 654 | $output->setVerbosity(Output::VERBOSITY_VERBOSE); |
||
| 655 | } |
||
| 656 | } |
||
| 657 | } |
||
| 658 | |||
| 659 | /** |
||
| 660 | * 执行指令 |
||
| 661 | * @access protected |
||
| 662 | * @param Command $command 指令实例 |
||
| 663 | * @param Input $input 输入实例 |
||
| 664 | * @param Output $output 输出实例 |
||
| 665 | * @return int |
||
| 666 | * @throws \Exception |
||
| 667 | */ |
||
| 668 | protected function doRunCommand(Command $command, Input $input, Output $output) |
||
| 669 | { |
||
| 670 | return $command->run($input, $output); |
||
| 671 | } |
||
| 672 | |||
| 673 | /** |
||
| 674 | * 获取指令的基础名称 |
||
| 675 | * @access protected |
||
| 676 | * @param Input $input |
||
| 677 | * @return string |
||
| 678 | */ |
||
| 679 | protected function getCommandName(Input $input) |
||
| 680 | { |
||
| 681 | return $input->getFirstArgument(); |
||
| 682 | } |
||
| 683 | |||
| 684 | /** |
||
| 685 | * 获取默认输入定义 |
||
| 686 | * @access protected |
||
| 687 | * @return InputDefinition |
||
| 688 | */ |
||
| 689 | protected function getDefaultInputDefinition() |
||
| 690 | { |
||
| 691 | return new InputDefinition([ |
||
| 692 | new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'), |
||
| 693 | new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display this help message'), |
||
| 694 | new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this console version'), |
||
| 695 | new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'), |
||
| 696 | new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'), |
||
| 697 | new InputOption('--ansi', '', InputOption::VALUE_NONE, 'Force ANSI output'), |
||
| 698 | new InputOption('--no-ansi', '', InputOption::VALUE_NONE, 'Disable ANSI output'), |
||
| 699 | new InputOption('--no-interaction', '-n', InputOption::VALUE_NONE, 'Do not ask any interactive question'), |
||
| 700 | ]); |
||
| 701 | } |
||
| 702 | |||
| 703 | public static function addDefaultCommands(array $classnames) |
||
| 704 | { |
||
| 705 | self::$defaultCommands = array_merge(self::$defaultCommands, $classnames); |
||
| 706 | } |
||
| 707 | |||
| 708 | /** |
||
| 709 | * 获取可能的建议 |
||
| 710 | * @access private |
||
| 711 | * @param array $abbrevs |
||
| 712 | * @return string |
||
| 713 | */ |
||
| 714 | private function getAbbreviationSuggestions($abbrevs) |
||
| 715 | { |
||
| 716 | return sprintf('%s, %s%s', $abbrevs[0], $abbrevs[1], count($abbrevs) > 2 ? sprintf(' and %d more', count($abbrevs) - 2) : ''); |
||
| 717 | } |
||
| 718 | |||
| 719 | /** |
||
| 720 | * 返回命名空间部分 |
||
| 721 | * @access public |
||
| 722 | * @param string $name 指令 |
||
| 723 | * @param string $limit 部分的命名空间的最大数量 |
||
| 724 | * @return string |
||
| 725 | */ |
||
| 726 | public function extractNamespace($name, $limit = null) |
||
| 727 | { |
||
| 728 | $parts = explode(':', $name); |
||
| 729 | array_pop($parts); |
||
| 730 | |||
| 731 | return implode(':', null === $limit ? $parts : array_slice($parts, 0, $limit)); |
||
| 732 | } |
||
| 733 | |||
| 734 | /** |
||
| 735 | * 查找可替代的建议 |
||
| 736 | * @access private |
||
| 737 | * @param string $name |
||
| 738 | * @param array|\Traversable $collection |
||
| 739 | * @return array |
||
| 740 | */ |
||
| 741 | private function findAlternatives($name, $collection) |
||
| 783 | } |
||
| 784 | |||
| 785 | /** |
||
| 786 | * 设置默认的指令 |
||
| 787 | * @access public |
||
| 788 | * @param string $commandName The Command name |
||
| 789 | */ |
||
| 790 | public function setDefaultCommand($commandName) |
||
| 791 | { |
||
| 792 | $this->defaultCommand = $commandName; |
||
| 793 | } |
||
| 794 | |||
| 795 | /** |
||
| 796 | * 返回所有的命名空间 |
||
| 797 | * @access private |
||
| 798 | * @param string $name |
||
| 799 | * @return array |
||
| 800 | */ |
||
| 801 | private function extractAllNamespaces($name) |
||
| 802 | { |
||
| 803 | $parts = explode(':', $name, -1); |
||
| 804 | $namespaces = []; |
||
| 805 | |||
| 806 | foreach ($parts as $part) { |
||
| 807 | if (count($namespaces)) { |
||
| 808 | $namespaces[] = end($namespaces) . ':' . $part; |
||
| 809 | } else { |
||
| 810 | $namespaces[] = $part; |
||
| 811 | } |
||
| 812 | } |
||
| 813 | |||
| 814 | return $namespaces; |
||
| 815 | } |
||
| 816 | |||
| 817 | public function __debugInfo() |
||
| 823 | } |
||
| 824 | } |
||
| 825 |