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.
121 lines
3.0 KiB
121 lines
3.0 KiB
<?php
|
|
|
|
/**
|
|
* CodeIgniter
|
|
*
|
|
* An open source application development framework for PHP
|
|
*
|
|
* This content is released under the MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
|
* Copyright (c) 2019 CodeIgniter Foundation
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* @package CodeIgniter
|
|
* @author CodeIgniter Dev Team
|
|
* @copyright 2019 CodeIgniter Foundation
|
|
* @license https://opensource.org/licenses/MIT MIT License
|
|
* @link https://codeigniter.com
|
|
* @since Version 4.0.0
|
|
* @filesource
|
|
*/
|
|
|
|
namespace CodeIgniter\Commands;
|
|
|
|
use CodeIgniter\CLI\BaseCommand;
|
|
|
|
/**
|
|
* CI Help command for the spark script.
|
|
*
|
|
* Lists the basic usage information for the spark script,
|
|
* and provides a way to list help for other commands.
|
|
*
|
|
* @package CodeIgniter\Commands
|
|
*/
|
|
class Help extends BaseCommand
|
|
{
|
|
|
|
/**
|
|
* The group the command is lumped under
|
|
* when listing commands.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $group = 'CodeIgniter';
|
|
|
|
/**
|
|
* The Command's name
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $name = 'help';
|
|
|
|
/**
|
|
* the Command's short description
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $description = 'Displays basic usage information.';
|
|
|
|
/**
|
|
* the Command's usage
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $usage = 'help command_name';
|
|
|
|
/**
|
|
* the Command's Arguments
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $arguments = [
|
|
'command_name' => 'The command name [default: "help"]',
|
|
];
|
|
|
|
/**
|
|
* the Command's Options
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $options = [];
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Displays the help for the spark cli script itself.
|
|
*
|
|
* @param array $params
|
|
*/
|
|
public function run(array $params)
|
|
{
|
|
$command = array_shift($params);
|
|
if (is_null($command))
|
|
{
|
|
$command = 'help';
|
|
}
|
|
|
|
$commands = $this->commands->getCommands();
|
|
$class = new $commands[$command]['class']($this->logger, $this->commands);
|
|
|
|
$class->showHelp();
|
|
}
|
|
|
|
}
|
|
|