Scribd
Upload
2 views

Commands

Uploaded by

ali.zairov.1994
Copyright
© © All Rights Reserved
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
2 views

Commands

Uploaded by

ali.zairov.1994
Copyright
© © All Rights Reserved
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 4

<?

php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <[email protected]>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\CLI;

use CodeIgniter\Autoloader\FileLocator;
use CodeIgniter\Log\Logger;
use ReflectionClass;
use ReflectionException;

/**
* Core functionality for running, listing, etc commands.
*/
class Commands
{
/**
* The found commands.
*
* @var array
*/
protected $commands = [];

/**
* Logger instance.
*
* @var Logger
*/
protected $logger;

/**
* Constructor
*
* @param Logger|null $logger
*/
public function __construct($logger = null)
{
$this->logger = $logger ?? service('logger');
$this->discoverCommands();
}

/**
* Runs a command given
*
* @return int|void
*/
public function run(string $command, array $params)
{
if (! $this->verifyCommand($command, $this->commands)) {
return;
}
// The file would have already been loaded during the
// createCommandList function...
$className = $this->commands[$command]['class'];
$class = new $className($this->logger, $this);

return $class->run($params);
}

/**
* Provide access to the list of commands.
*
* @return array
*/
public function getCommands()
{
return $this->commands;
}

/**
* Discovers all commands in the framework and within user code,
* and collects instances of them to work with.
*/
public function discoverCommands()
{
if ($this->commands !== []) {
return;
}

/** @var FileLocator $locator */


$locator = service('locator');
$files = $locator->listFiles('Commands/');

// If no matching command files were found, bail


// This should never happen in unit testing.
if ($files === []) {
return; // @codeCoverageIgnore
}

// Loop over each file checking to see if a command with that


// alias exists in the class.
foreach ($files as $file) {
$className = $locator->getClassname($file);

if ($className === '' || ! class_exists($className)) {


continue;
}

try {
$class = new ReflectionClass($className);

if (! $class->isInstantiable() || ! $class-
>isSubclassOf(BaseCommand::class)) {
continue;
}

/** @var BaseCommand $class */


$class = new $className($this->logger, $this);

if (isset($class->group)) {
$this->commands[$class->name] = [
'class' => $className,
'file' => $file,
'group' => $class->group,
'description' => $class->description,
];
}

unset($class);
} catch (ReflectionException $e) {
$this->logger->error($e->getMessage());
}
}

asort($this->commands);
}

/**
* Verifies if the command being sought is found
* in the commands list.
*/
public function verifyCommand(string $command, array $commands): bool
{
if (isset($commands[$command])) {
return true;
}

$message = lang('CLI.commandNotFound', [$command]);

if ($alternatives = $this->getCommandAlternatives($command, $commands)) {


if (count($alternatives) === 1) {
$message .= "\n\n" . lang('CLI.altCommandSingular') . "\n ";
} else {
$message .= "\n\n" . lang('CLI.altCommandPlural') . "\n ";
}

$message .= implode("\n ", $alternatives);


}

CLI::error($message);
CLI::newLine();

return false;
}

/**
* Finds alternative of `$name` among collection
* of commands.
*/
protected function getCommandAlternatives(string $name, array $collection):
array
{
$alternatives = [];

foreach (array_keys($collection) as $commandName) {


$lev = levenshtein($name, $commandName);

if ($lev <= strlen($commandName) / 3 || strpos($commandName, $name) !==


false) {
$alternatives[$commandName] = $lev;
}
}

ksort($alternatives, SORT_NATURAL | SORT_FLAG_CASE);

return array_keys($alternatives);
}
}

You might also like