Updated for PHP7.2+

Author: pointybeard

composer.json

@@ -6,19 +6,19 @@
     "authors": [
         {
             "name": "Alannah Kearney",
-            "email": "alannah@ruleandmake.com"
+            "email": "hi@alannahkearney.com"
         }
     ],
     "autoload": {
         "psr-4": {
             "CLILib\\": "src/CLILib"
         }
     },
-    "minimum-stability": "dev",
+    "minimum-stability": "stable",
     "require": {
-        "php": "^5.6"
+        "php": ">=7.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5"
+        "phpunit/phpunit": "^8"
     }
 }

src/CLILib/Argument.php

@@ -17,7 +17,7 @@ public function __construct($name, $value)
      *
      * @return string
      */
-    public function name()
+    public function name() : string
     {
         return $this->name;
     }

src/CLILib/Argument/Iterator.php

@@ -65,7 +65,7 @@ public function __construct(array $args = null, $ignoreFirst = true)
      * @param  string|array $name
      * @return array
      */
-    public function find($names)
+    public function find($names) : ?CLILib\Argument
     {
         if (!is_array($names)) {
             $names = [$names];
@@ -77,35 +77,35 @@ public function find($names)
             };
         }
 
-        return false;
+        return null;
     }
 
-    public function rewind()
+    public function rewind() : void
     {
         $this->position = 0;
     }
 
-    public function current()
+    public function current() : CLILib\Argument
     {
         return $this->args[$this->position];
     }
 
-    public function key()
+    public function key() : int
     {
         return $this->position;
     }
 
-    public function next()
+    public function next() : void
     {
         ++$this->position;
     }
 
-    public function valid()
+    public function valid() : bool
     {
         return isset($this->args[$this->position]);
     }
 
-    public function count()
+    public function count() : int
     {
         return count($this->keys);
     }

src/CLILib/Message.php

@@ -64,13 +64,13 @@ public function __construct($message = null)
         $this->dateFormat("H:i:s > ");
     }
 
-    public function message($message)
+    public function message($message) : self
     {
         $this->message = $message;
         return $this;
     }
 
-    public function foreground($colour)
+    public function foreground($colour) : self
     {
         if (!is_null($colour) && !array_key_exists($colour, self::$foregroundColours)) {
             throw new \Exception('No such foreground colour `'.$colour.'`');
@@ -79,7 +79,7 @@ public function foreground($colour)
         return $this;
     }
 
-    public function background($colour)
+    public function background($colour) : self
     {
         if (!is_null($colour) && !array_key_exists($colour, self::$backgroundColours)) {
             throw new \Exception('No such background colour `'.$colour.'`');
@@ -88,25 +88,25 @@ public function background($colour)
         return $this;
     }
 
-    public function prependDate($prependDate)
+    public function prependDate($prependDate) : self
     {
         $this->prependDate = $prependDate;
         return $this;
     }
 
-    public function dateFormat($format)
+    public function dateFormat($format) : self
     {
         $this->dateFormat = $format;
         return $this;
     }
 
-    public function appendNewLine($appendNewLine)
+    public function appendNewLine($appendNewLine) : self
     {
         $this->appendNewLine = $appendNewLine;
         return $this;
     }
 
-    public function display($target=STDOUT)
+    public function display($target=STDOUT) : bool
     {
         return fputs($target, (string)$this);
     }

src/CLILib/Prompt.php

@@ -10,7 +10,7 @@ class Prompt
      *
      * @return boolean true if the flag is set
      */
-    protected static function isFlagSet($flags, $flag)
+    protected static function isFlagSet($flags, $flag) : bool
     {
         // Flags support bitwise operators so it's easy to see
         // if one has been set.
@@ -34,7 +34,7 @@ protected static function isFlagSet($flags, $flag)
      *                        for passwords. Only works if bash is avilable.
      * @return string
      */
-    public static function display($prompt, $flags = null, $default = null, \Closure $validator = null, $character = ":", $target=STDIN)
+    public static function display($prompt, $flags = null, $default = null, \Closure $validator = null, $character = ":", $target=STDIN) : string
     {
         $silent = self::isFlagSet($flags, self::FLAG_SILENT);
 
@@ -90,7 +90,7 @@ public static function display($prompt, $flags = null, $default = null, \Closure
      *
      * @return bool
      */
-    protected static function canInvokeBash()
+    protected static function canInvokeBash() : bool
     {
         return (strcmp(trim(shell_exec("/usr/bin/env bash -c 'echo OK'")), 'OK') === 0);
     }

tests/Argument/Iterator/Test.php

@@ -49,7 +49,7 @@ public function testValidPassArgsToConstructor()
     public function testEmptyArgumentArray()
     {
         $it = new Iterator([], false);
-        $this->assertFalse($it->find('hithere'));
+        $this->assertNull($it->find('hithere'));
         $this->assertEquals(0, $it->count());
     }
 
@@ -63,7 +63,7 @@ public function testValidIgnoreFirstArg()
             '--hithere',
         ]);
         $this->assertEquals(1, iterator_count($it));
-        $this->assertFalse($it->find('../blah/blah'));
+        $this->assertNull($it->find('../blah/blah'));
     }
 
     /**
@@ -117,6 +117,6 @@ public function testValidFindArgumentArray()
      */
     public function testInvalidFindArgumentArray($it)
     {
-        $this->assertFalse($it->find(['f', 'file']));
+        $this->assertNull($it->find(['f', 'file']));
     }
 }