mirror of
https://github.com/Icinga/icingaweb2.git
synced 2026-05-28 04:02:39 -04:00
662de28f85
Add SPDX license headers and mark source files as GPL-3.0-or-later to preserve the option to relicense under later GPL versions.
45 lines
1.2 KiB
PHP
45 lines
1.2 KiB
PHP
<?php
|
|
|
|
// SPDX-FileCopyrightText: 2018 Icinga GmbH <https://icinga.com>
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
namespace Icinga\Clicommands;
|
|
|
|
use Icinga\Cli\Command;
|
|
use Icinga\Cli\Loader;
|
|
use Icinga\Cli\Documentation;
|
|
|
|
/**
|
|
* Help for modules, commands and actions
|
|
*
|
|
* The help command shows help for a given command, module and also for a
|
|
* given module's command or a specific command's action.
|
|
*
|
|
* Usage: icingacli help [<module>] [<command> [<action>]]
|
|
*/
|
|
class HelpCommand extends Command
|
|
{
|
|
protected $defaultActionName = 'show';
|
|
|
|
/**
|
|
* Show help for modules, commands and actions [default]
|
|
*
|
|
* The help command shows help for a given command, module and also for a
|
|
* given module's command or a specific command's action.
|
|
*
|
|
* Usage: icingacli help [<module>] [<command> [<action>]]
|
|
*/
|
|
public function showAction()
|
|
{
|
|
$module = null;
|
|
$command = null;
|
|
$action = null;
|
|
$loader = new Loader($this->app);
|
|
$loader->parseParams();
|
|
echo $this->docs()->usage(
|
|
$loader->getModuleName(),
|
|
$loader->getCommandName(),
|
|
$loader->getActionName()
|
|
);
|
|
}
|
|
}
|