Merge pull request getopt-php#34 from mfn/mf-banner

ulrichsg · ulrichsg · commit 8f7a8ffb0472 · 2014-09-13T15:53:27.000+02:00
helptext: add support for custom banner message
diff --git a/src/Ulrichsg/Getopt/Getopt.php b/src/Ulrichsg/Getopt/Getopt.php
@@ -26,6 +26,8 @@ class Getopt implements \Countable, \ArrayAccess, \IteratorAggregate
     private $options = array();
     /** @var array */
     private $operands = array();
+    /** @var string */
+    private $banner =  "Usage: %s [options] [operands]\n";
 
     /**
      * Creates a new Getopt object.
@@ -184,14 +186,37 @@ public function getOperand($i)
         return ($i < count($this->operands)) ? $this->operands[$i] : null;
     }
 
+    /**
+     * Returns the banner string
+     *
+     * @return string
+     */
+    public function getBanner()
+    {
+        return $this->banner;
+    }
+
+    /**
+     * Set the banner string
+     *
+     * @param string $banner    The banner string; will be passed to sprintf(), can include %s for current scripts name.
+     *                          Be sure to include a trailing line feed.
+     * @return Getopt
+     */
+    public function setBanner($banner)
+    {
+        $this->banner = $banner;
+        return $this;
+    }
+
     /**
      * Returns an usage information text generated from the given options.
      * @param int $padding Number of characters to pad output of options to
      * @return string
      */
     public function getHelpText($padding = 25)
     {
-        $helpText = sprintf("Usage: %s [options] [operands]\n", $this->scriptName);
+        $helpText = sprintf($this->getBanner(), $this->scriptName);
         $helpText .= "Options:\n";
         foreach ($this->optionList as $option) {
             $mode = '';
diff --git a/test/Ulrichsg/Getopt/GetoptTest.php b/test/Ulrichsg/Getopt/GetoptTest.php
@@ -177,4 +177,23 @@ public function testHelpTextWithoutDescriptions()
 
         $this->assertEquals($expected, $getopt->getHelpText());
     }
+
+    public function testHelpTextNoParse()
+    {
+        $getopt = new Getopt();
+        $expected = "Usage:  [options] [operands]\nOptions:\n";
+        $this->assertSame($expected, $getopt->getHelpText());
+    }
+
+    public function testHelpTextWithCustomBanner()
+    {
+        $script = $_SERVER['PHP_SELF'];
+        
+        $getopt = new Getopt();
+        $getopt->setBanner("My custom Banner %s\n");
+        $this->assertSame("My custom Banner \nOptions:\n", $getopt->getHelpText());
+
+        $getopt->parse();
+        $this->assertSame("My custom Banner $script\nOptions:\n", $getopt->getHelpText());
+    }
 }
