init III

Perl OTRS/Kernel/System/Console/Command/Help.pm

@@ -0,0 +1,56 @@
+# --
+# Copyright (C) 2001-2019 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;