Merge pull request getopt-php#46 from sabl0r/argument_description

ulrichsg · ulrichsg · commit 26ee0cdb1dc2 · 2014-12-28T10:57:23.000+01:00
Add support for optional argument description
diff --git a/src/Ulrichsg/Getopt/Argument.php b/src/Ulrichsg/Getopt/Argument.php
@@ -8,6 +8,8 @@ class Argument
     private $default;
     /** @var callable */
     private $validation;
+    /** @var string */
+    private $description;
 
     /**
      * Creates a new argument.
@@ -16,14 +18,15 @@ class Argument
      * @param callable|null $validation a validation function (optional)
      * @throws \InvalidArgumentException
      */
-    public function __construct($default = null, $validation = null)
+    public function __construct($default = null, $validation = null, $description = "arg")
     {
         if (!is_null($default)) {
             $this->setDefaultValue($default);
         }
         if (!is_null($validation)) {
             $this->setValidation($validation);
         }
+        $this->description = $description;
     }
 
     /**
@@ -99,4 +102,14 @@ public function getDefaultValue()
     {
         return $this->default;
     }
+
+    /**
+     * Retrieve the descriptopm
+     *
+     * @return string
+     */
+    public function getDescription()
+    {
+        return $this->description;
+    }
 }
diff --git a/src/Ulrichsg/Getopt/Getopt.php b/src/Ulrichsg/Getopt/Getopt.php
@@ -225,10 +225,10 @@ public function getHelpText($padding = 25)
                     $mode = '';
                     break;
                 case self::REQUIRED_ARGUMENT:
-                    $mode = "<arg>";
+                    $mode = "<".$option->getArgument()->getDescription().">";
                     break;
                 case self::OPTIONAL_ARGUMENT:
-                    $mode = "[<arg>]";
+                    $mode = "[<".$option->getArgument()->getDescription().">]";
                     break;
             }
             $short = ($option->short()) ? '-'.$option->short() : '';

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ class Argument`
`8`	`8`	`private $default;`
`9`	`9`	`/** @var callable */`
`10`	`10`	`private $validation;`
	`11`	`+ /** @var string */`
	`12`	`+ private $description;`
`11`	`13`
`12`	`14`	`/**`
`13`	`15`	`* Creates a new argument.`
`@@ -16,14 +18,15 @@ class Argument`
`16`	`18`	`* @param callable\|null $validation a validation function (optional)`
`17`	`19`	`* @throws \InvalidArgumentException`
`18`	`20`	`*/`
`19`		`- public function __construct($default = null, $validation = null)`
	`21`	`+ public function __construct($default = null, $validation = null, $description = "arg")`
`20`	`22`	`{`
`21`	`23`	`if (!is_null($default)) {`
`22`	`24`	`$this->setDefaultValue($default);`
`23`	`25`	`}`
`24`	`26`	`if (!is_null($validation)) {`
`25`	`27`	`$this->setValidation($validation);`
`26`	`28`	`}`
	`29`	`+ $this->description = $description;`
`27`	`30`	`}`
`28`	`31`
`29`	`32`	`/**`
`@@ -99,4 +102,14 @@ public function getDefaultValue()`
`99`	`102`	`{`
`100`	`103`	`return $this->default;`
`101`	`104`	`}`
	`105`	`+`
	`106`	`+ /**`
	`107`	`+ * Retrieve the descriptopm`
	`108`	`+ *`
	`109`	`+ * @return string`
	`110`	`+ */`
	`111`	`+ public function getDescription()`
	`112`	`+ {`
	`113`	`+ return $this->description;`
	`114`	`+ }`
`102`	`115`	`}`