Merge branch 'pr/8'

splitbrain · splitbrain · commit 8b32e269225d · 2021-02-05T12:18:12.000+01:00
* pr/8:
  Add the ability to change the help text for commands
diff --git a/src/Options.php b/src/Options.php
@@ -77,6 +77,16 @@ public function setHelp($help)
         $this->setup['']['help'] = $help;
     }
 
+    /**
+     * Sets the help text for the tools commands itself
+     *
+     * @param string $help
+     */
+    public function setCommandHelp($help)
+    {
+        $this->setup['']['commandhelp'] = $help;
+    }
+
     /**
      * Register the names of arguments for help generation and number checking
      *
@@ -342,6 +352,8 @@ public function help()
         $text = '';
 
         $hascommands = (count($this->setup) > 1);
+        $commandhelp = $this->setup[""]["commandhelp"]
+                     ?: 'This tool accepts a command as first parameter as outlined below:';
         foreach ($this->setup as $command => $config) {
             $hasopts = (bool)$this->setup[$command]['opts'];
             $hasargs = (bool)$this->setup[$command]['args'];
@@ -441,7 +453,7 @@ public function help()
                 $text .= "\n";
                 $text .= $tf->format(
                     array($mv, '*'),
-                    array('', 'This tool accepts a command as first parameter as outlined below:')
+                    array('', $commandhelp)
                 );
                 $text .= "\n";
             }
