Part way through line length and psalm cleanup

backporting pull request for substr bug

Author: hexmode

src/CLI.php

@@ -19,7 +19,8 @@ abstract class CLI {
 /** @var Colors */
 public $colors;
 
-/** @var array PSR-3 compatible loglevels and their prefix, color, output channel */
+/** @var array PSR-3 compatible loglevels and their prefix, color,
+ * output channel */
 protected $loglevel = [
 'debug' => [ '', Colors::C_LIGHTGRAY, STDOUT ],
 'info' => [ 'ℹ ', Colors::C_CYAN, STDOUT ],
@@ -246,21 +247,21 @@ public function critical( $message, array $context = [] ) :void {
 }
 
 /**
- * Runtime errors that do not require immediate action but should typically
- * be logged and monitored.
+ * Runtime errors that do not require immediate action but should
+ * typically be logged and monitored.
  *
  * @param string $message
  * @param array $context
  */
-public function error( string $message, array $context = [] ) :void {
+public function error( $message, array $context = [] ) :void {
 $this->log( 'error', $message, $context );
 }
 
 /**
  * Exceptional occurrences that are not errors.
  *
- * Example: Use of deprecated APIs, poor use of an API, undesirable things
- * that are not necessarily wrong.
+ * Example: Use of deprecated APIs, poor use of an API, undesirable
+ * things that are not necessarily wrong.
  *
  * @param string $message
  * @param array $context
@@ -344,8 +345,11 @@ function interpolate( string $message, array $context = [] ) :string {
 $replace = [];
 foreach ( $context as $key => $val ) {
 // check that the value can be casted to string
-if ( !is_array( $val ) &&
- ( !is_object( $val ) || method_exists( $val, '__toString' ) )
+if (
+!is_array( $val ) && (
+ !is_object( $val ) ||
+ method_exists( $val, '__toString' )
+)
 ) {
 $replace['{' . $key . '}'] = $val;
 }

src/Options.php

@@ -5,8 +5,9 @@
 /**
  * Class Options
  *
- * Parses command line options passed to the CLI script. Allows CLI scripts to easily register all accepted options and
- * commands and even generates a help text from this setup.
+ * Parses command line options passed to the CLI script. Allows CLI
+ * scripts to easily register all accepted options and commands and
+ * even generates a help text from this setup.
  *
  * @author Andreas Gohr <andi@splitbrain.org>
  * @license MIT
@@ -62,7 +63,7 @@ public function __construct( Colors $colors = null ) {
  *
  * @param string $help
  */
-public function setHelp( $help ) {
+public function setHelp( $help ) :void {
 $this->setup['']['help'] = $help;
 }
 
@@ -71,7 +72,7 @@ public function setHelp( $help ) {
  *
  * @param string $help
  */
-public function setCommandHelp( $help ) {
+public function setCommandHelp( $help ) :void {
 $this->setup['']['commandhelp'] = $help;
 }
 
@@ -80,12 +81,13 @@ public function setCommandHelp( $help ) {
  *
  * @param bool $compact
  */
-public function setCompactHelp( $compact = true ) {
+public function setCompactHelp( $compact = true ) :void {
 $this->setup['']['compacthelp'] = $compact;
 }
 
 /**
- * Register the names of arguments for help generation and number checking
+ * Register the names of arguments for help generation and number
+ * checking
  *
  * This has to be called in the order arguments are expected
  *
@@ -95,7 +97,12 @@ public function setCompactHelp( $compact = true ) {
  * @param string $command if theses apply to a sub command only
  * @throws Exception
  */
-public function registerArgument( $arg, $help, $required = true, $command = '' ) {
+public function registerArgument(
+string $arg,
+string $help,
+bool $required = true,
+string $command = ''
+) :void {
 if ( !isset( $this->setup[$command] ) ) {
 throw new Exception( "Command $command not registered" );
 }
@@ -110,13 +117,14 @@ public function registerArgument( $arg, $help, $required = true, $command = '' )
 /**
  * This registers a sub command
  *
- * Sub commands have their own options and use their own function (not main()).
+ * Sub commands have their own options and use their own function
+ * (not main()).
  *
  * @param string $command
  * @param string $help
  * @throws Exception
  */
-public function registerCommand( $command, $help ) {
+public function registerCommand( $command, $help ) :void {
 if ( isset( $this->setup[$command] ) ) {
 throw new Exception( "Command $command already registered" );
 }
@@ -134,11 +142,18 @@ public function registerCommand( $command, $help ) {
  * @param string $long multi character option (specified with --)
  * @param string $help help text for this option
  * @param string|null $short one character option (specified with -)
- * @param bool|string $needsarg does this option require an argument? give it a name here
+ * @param bool|string $needsarg does this option require an argument?
+ * give it a name here
  * @param string $command what command does this option apply to
  * @throws Exception
  */
-public function registerOption( $long, $help, $short = null, $needsarg = false, $command = '' ) {
+public function registerOption(
+string $long,
+string $help,
+?string $short = null,
+$needsarg = false,
+string $command = ''
+) :void {
 if ( !isset( $this->setup[$command] ) ) {
 throw new Exception( "Command $command not registered" );
 }
@@ -163,11 +178,13 @@ public function registerOption( $long, $help, $short = null, $needsarg = false,
  *
  * Throws an exception if arguments are missing.
  *
- * This is run from CLI automatically and usually does not need to be called directly
+ * This is run from CLI automatically and usually does not need to
+ * be called directly
  *
- * @throws Exception
+ * @returns bool true if all is ok
+ * @throws UsageException
  */
-public function checkArguments() {
+public function checkArguments() :bool {
 $argc = count( $this->args );
 
 $req = 0;
@@ -179,46 +196,60 @@ public function checkArguments() {
 }
 
 if ( $req > $argc ) {
-throw new Exception( "Not enough arguments", Exception::E_OPT_ARG_REQUIRED );
+throw new UsageException(
+"Not enough arguments", Exception::E_OPT_ARG_REQUIRED
+);
 }
+
+return true;
 }
 
 /**
  * Parses the given arguments for known options and command
  *
- * The given $args array should NOT contain the executed file as first item anymore! The $args
- * array is stripped from any options and possible command. All found otions can be accessed via the
- * getOpt() function
+ * The given $args array should NOT contain the executed file as
+ * first item anymore! The $args array is stripped from any
+ * options and possible command. All found otions can be accessed
+ * via the getOpt() function
  *
- * Note that command options will overwrite any global options with the same name
+ * Note that command options will overwrite any global options
+ * with the same name
  *
- * This is run from CLI automatically and usually does not need to be called directly
+ * This is run from CLI automatically and usually does not need to
+ * be called directly
  *
  * @throws Exception
  */
-public function parseOptions() {
+public function parseOptions() :void {
 $non_opts = [];
 
 $argc = count( $this->args );
 for ( $i = 0; $i < $argc; $i++ ) {
 $arg = $this->args[$i];
 
-// The special element '--' means explicit end of options. Treat the rest of the arguments as non-options
+// The special element '--' means explicit end of
+// options. Treat the rest of the arguments as non-options
 // and end the loop.
 if ( $arg == '--' ) {
-$non_opts = array_merge( $non_opts, array_slice( $this->args, $i + 1 ) );
+$non_opts = array_merge(
+$non_opts, array_slice( $this->args, $i + 1 )
+);
 break;
 }
 
 // '-' is stdin - a normal argument
 if ( $arg == '-' ) {
-$non_opts = array_merge( $non_opts, array_slice( $this->args, $i ) );
+$non_opts = array_merge(
+$non_opts, array_slice( $this->args, $i )
+);
 break;
 }
 
 // first non-option
 if ( $arg{0} != '-' ) {
-$non_opts = array_merge( $non_opts, array_slice( $this->args, $i ) );
+$non_opts = array_merge(
+$non_opts, array_slice( $this->args, $i )
+);
 break;
 }
 
@@ -229,12 +260,17 @@ public function parseOptions() {
 $val = array_shift( $arg );
 
 if ( !isset( $this->setup[$this->command]['opts'][$opt] ) ) {
-throw new Exception( "No such option '$opt'", Exception::E_UNKNOWN_OPT );
+throw new UsageException(
+"No such option '$opt'", Exception::E_UNKNOWN_OPT
+);
 }
 
 // argument required?
 if ( $this->setup[$this->command]['opts'][$opt]['needsarg'] ) {
-if ( is_null( $val ) && $i + 1 < $argc && !preg_match( '/^--?[\w]/', $this->args[$i + 1] ) ) {
+if (
+is_null( $val ) && $i + 1 < $argc &&
+!preg_match( '/^--?[\w]/', $this->args[$i + 1] )
+) {
 $val = $this->args[++$i];
 }
 if ( is_null( $val ) ) {
@@ -252,15 +288,21 @@ public function parseOptions() {
 // short option
 $opt = substr( $arg, 1 );
 if ( !isset( $this->setup[$this->command]['short'][$opt] ) ) {
-throw new Exception( "No such option $arg", Exception::E_UNKNOWN_OPT );
+throw new UsageException(
+"No such option $arg", Exception::E_UNKNOWN_OPT
+);
 } else {
-$opt = $this->setup[$this->command]['short'][$opt]; // store it under long name
+// store it under long name
+$opt = $this->setup[$this->command]['short'][$opt];
 }
 
 // argument required?
 if ( $this->setup[$this->command]['opts'][$opt]['needsarg'] ) {
 $val = null;
-if ( $i + 1 < $argc && !preg_match( '/^--?[\w]/', $this->args[$i + 1] ) ) {
+if (
+$i + 1 < $argc &&
+!preg_match( '/^--?[\w]/', $this->args[$i + 1] )
+) {
 $val = $this->args[++$i];
 }
 if ( is_null( $val ) ) {
@@ -276,8 +318,12 @@ public function parseOptions() {
 // parsing is now done, update args array
 $this->args = $non_opts;
 
-// if not done yet, check if first argument is a command and reexecute argument parsing if it is
-if ( !$this->command && $this->args && isset( $this->setup[$this->args[0]] ) ) {
+// if not done yet, check if first argument is a command and
+// reexecute argument parsing if it is
+if (
+!$this->command && $this->args &&
+isset( $this->setup[$this->args[0]] )
+) {
 // it is a command!
 $this->command = array_shift( $this->args );
 $this->parseOptions(); // second pass

src/TableFormatter.php

@@ -54,7 +54,7 @@ public function getBorder() {
  *
  * @param string $border
  */
-public function setBorder( $border ) {
+public function setBorder( $border ) :void {
 $this->border = $border;
 }
 
@@ -74,7 +74,7 @@ public function getMaxWidth() {
  *
  * @param int $max
  */
-public function setMaxWidth( $max ) {
+public function setMaxWidth( $max ) :void {
 $this->max = $max;
 }
 
@@ -241,7 +241,7 @@ protected function pad( $string, $len ) {
  * @param $string
  * @return int
  */
-protected function strlen( $string ) {
+protected function strlen( $string ) :int {
 // don't count color codes
 $string = preg_replace( "/\33\\[\\d+(;\\d+)?m/", '', $string );
 
@@ -262,7 +262,12 @@ protected function substr( $string, $start = 0, $length = null ) {
 if ( function_exists( 'mb_substr' ) ) {
 return mb_substr( $string, $start, $length );
 } else {
-return substr( $string, $start, $length );
+// substr() treats the third parameter different than mb_substr()
+if ( $length ) {
+return substr( $string, $start, $length );
+} else {
+return substr( $string, $start );
+}
 }
 }