You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
143 lines
5.0 KiB
143 lines
5.0 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\console; |
|
|
|
use yii\console\controllers\HelpController; |
|
|
|
/** |
|
* UnknownCommandException represents an exception caused by incorrect usage of a console command. |
|
* |
|
* @author Carsten Brandt <mail@cebe.cc> |
|
* @since 2.0.11 |
|
*/ |
|
class UnknownCommandException extends Exception |
|
{ |
|
/** |
|
* @var string the name of the command that could not be recognized. |
|
*/ |
|
public $command; |
|
|
|
/** |
|
* @var Application |
|
*/ |
|
protected $application; |
|
|
|
|
|
/** |
|
* Construct the exception. |
|
* |
|
* @param string $route the route of the command that could not be found. |
|
* @param Application $application the console application instance involved. |
|
* @param int $code the Exception code. |
|
* @param \Exception $previous the previous exception used for the exception chaining. |
|
*/ |
|
public function __construct($route, $application, $code = 0, \Exception $previous = null) |
|
{ |
|
$this->command = $route; |
|
$this->application = $application; |
|
parent::__construct("Unknown command \"$route\".", $code, $previous); |
|
} |
|
|
|
/** |
|
* @return string the user-friendly name of this exception |
|
*/ |
|
public function getName() |
|
{ |
|
return 'Unknown command'; |
|
} |
|
|
|
/** |
|
* Suggest alternative commands for [[$command]] based on string similarity. |
|
* |
|
* Alternatives are searched using the following steps: |
|
* |
|
* - suggest alternatives that begin with `$command` |
|
* - find typos by calculating the Levenshtein distance between the unknown command and all |
|
* available commands. The Levenshtein distance is defined as the minimal number of |
|
* characters you have to replace, insert or delete to transform str1 into str2. |
|
* |
|
* @see http://php.net/manual/en/function.levenshtein.php |
|
* @return array a list of suggested alternatives sorted by similarity. |
|
*/ |
|
public function getSuggestedAlternatives() |
|
{ |
|
$help = $this->application->createController('help'); |
|
if ($help === false || $this->command === '') { |
|
return []; |
|
} |
|
/** @var $helpController HelpController */ |
|
list($helpController, $actionID) = $help; |
|
|
|
$availableActions = []; |
|
$commands = $helpController->getCommands(); |
|
foreach ($commands as $command) { |
|
$result = $this->application->createController($command); |
|
if ($result === false) { |
|
continue; |
|
} |
|
// add the command itself (default action) |
|
$availableActions[] = $command; |
|
|
|
// add all actions of this controller |
|
/** @var $controller Controller */ |
|
list($controller, $actionID) = $result; |
|
$actions = $helpController->getActions($controller); |
|
if (!empty($actions)) { |
|
$prefix = $controller->getUniqueId(); |
|
foreach ($actions as $action) { |
|
$availableActions[] = $prefix . '/' . $action; |
|
} |
|
} |
|
} |
|
|
|
return $this->filterBySimilarity($availableActions, $this->command); |
|
} |
|
|
|
/** |
|
* Find suggest alternative commands based on string similarity. |
|
* |
|
* Alternatives are searched using the following steps: |
|
* |
|
* - suggest alternatives that begin with `$command` |
|
* - find typos by calculating the Levenshtein distance between the unknown command and all |
|
* available commands. The Levenshtein distance is defined as the minimal number of |
|
* characters you have to replace, insert or delete to transform str1 into str2. |
|
* |
|
* @see http://php.net/manual/en/function.levenshtein.php |
|
* @param array $actions available command names. |
|
* @param string $command the command to compare to. |
|
* @return array a list of suggested alternatives sorted by similarity. |
|
*/ |
|
private function filterBySimilarity($actions, $command) |
|
{ |
|
$alternatives = []; |
|
|
|
// suggest alternatives that begin with $command first |
|
foreach ($actions as $action) { |
|
if (strpos($action, $command) === 0) { |
|
$alternatives[] = $action; |
|
} |
|
} |
|
|
|
// calculate the Levenshtein distance between the unknown command and all available commands. |
|
$distances = array_map(function ($action) use ($command) { |
|
$action = strlen($action) > 255 ? substr($action, 0, 255) : $action; |
|
$command = strlen($command) > 255 ? substr($command, 0, 255) : $command; |
|
return levenshtein($action, $command); |
|
}, array_combine($actions, $actions)); |
|
|
|
// we assume a typo if the levensthein distance is no more than 3, i.e. 3 replacements needed |
|
$relevantTypos = array_filter($distances, function ($distance) { |
|
return $distance <= 3; |
|
}); |
|
asort($relevantTypos); |
|
$alternatives = array_merge($alternatives, array_flip($relevantTypos)); |
|
|
|
return array_unique($alternatives); |
|
} |
|
}
|
|
|