1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::System::Console::Command::Help;
use strict;
use warnings;
use parent qw(
Kernel::System::Console::BaseCommand
Kernel::System::Console::Command::Search
);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Main',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Display help for an existing command or search for commands.');
$Self->AddArgument(
Name => 'command',
Description =>
"Print usage information for this command (if command is available) or search for commands with similar names.",
ValueRegex => qr/[a-zA-Z0-9:_]+/,
Required => 1,
);
return;
}
sub Run {
my ( $Self, %Param ) = @_;
my $SearchCommand = $Self->GetArgument('command');
my $CommandModule = "Kernel::System::Console::Command::$SearchCommand";
# Is it an existing command? Then show help for it.
if ( $Kernel::OM->Get('Kernel::System::Main')->Require( $CommandModule, Silent => 1 ) ) {
my $Command = $Kernel::OM->Get($CommandModule);
$Command->ANSI( $Self->ANSI() );
print $Command->GetUsageHelp();
return $Self->ExitCodeOk();
}
# Otherwise, search for commands with a similar name
return $Self->HandleSearch( SearchCommand => $SearchCommand ); # From "Search" command
}
1;
|
