netfocusinc / argh

src/netfocusinc/argh/CommandParameter.php

Spacing +4 added lines, -4 removed lines

@@ -49,11 +49,11 @@ 
 		* @param array $options
 		*/
 		
-	public function __construct(string $name, string $flag=null, bool $required=FALSE, $default=null, string $description=null, array $options=array())
+	public function __construct(string $name, string $flag = null, bool $required = FALSE, $default = null, string $description = null, array $options = array())
 	{
 		
 		// Required a non-empty 'options'
-		if( count($options) < 1 )
+		if (count($options)<1)
 		{
 			throw(new ArghException('CommandParameter must have options'));
 		}
@@ -87,12 +87,12 @@ 
 		*/
 	public function setValue($value)
 	{		
-		if(is_array($value))
+		if (is_array($value))
 		{
 			throw(new ArghException('Command value cannot be set to an array'));
 		}
 		
-		if( ($this->hasOptions()) && (!$this->isOption($value)) )
+		if (($this->hasOptions()) && (!$this->isOption($value)))
 		{
 			throw(new ArghException('Not a valid option for \'' . $this->getName() . '\''));
 		}

src/netfocusinc/argh/StringParameter.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
 		*/
 	public function setValue($value)
 	{		
-		if(is_array($value))
+		if (is_array($value))
 		{
 			throw(new ArghException('StringParameter values cannot be set to an array'));
 		}

src/netfocusinc/argh/ArgumentParser.php

Spacing +31 added lines, -31 removed lines

@@ -68,7 +68,7 @@ 
 		// Init an array of Arguments
 		$arguments = array();
 			
-		if(count($args) == 0)
+		if (count($args) == 0)
 		{
 			// Nothing to parse
 			return $arguments;
@@ -80,12 +80,12 @@ 
 		// Get all Parameters from ParameterCollection
 		$params = $this->parameterCollection->all();
 		
-		if( count($rules) == 0 )
+		if (count($rules) == 0)
 		{
 			throw new ArghException(__CLASS__ . ': Language needs at least one rule to parse arguments.');
 		}
 		
-		if( count($params) == 0 )
+		if (count($params) == 0)
 		{
 			throw new ArghException(__CLASS__ . ': ParameterCollection needs at least one parameter to parse arguments.');
 		}
@@ -144,13 +144,13 @@ 
 				// END DEBUG
 				//
 				
-				foreach($rules as $rule)
+				foreach ($rules as $rule)
 				{
 					//echo "DEBUG: Checking for match with rule: " . $rule->name() . " (" . $rule->syntax() . ")" . "\n";
 					
 					$tokens = array(); // init array to capture matching tokens from Rule->match()
 					
-					if( $rule->match($argsS, $tokens) )
+					if ($rule->match($argsS, $tokens))
 					{
 						// Count the number of arguments that were matched
 						$count = count($argsL);
@@ -158,11 +158,11 @@ 
 						//echo "* MATCHED $count \$argv elements *\n";
 						
 						// Empty $argsL; prevent this inner foreach loop from continuing
-						for($i=0; $i<$count; $i++) array_shift($argsL);
+						for ($i = 0; $i<$count; $i++) array_shift($argsL);
 						
 						// Remove (shift) matching elements from $args
 						// These arguments have been consumed by the parser and are no longer needed
-						for($i=0; $i<$count; $i++) array_shift($args);
+						for ($i = 0; $i<$count; $i++) array_shift($args);
  						
  						//
  						// Try yielding Arguments from this Rule
@@ -171,12 +171,12 @@ 
  						
  						$yield = $this->yieldArgumentsFromRule($rule, $tokens);
 						
-	 					if( count($yield) > 0 )
+	 					if (count($yield)>0)
 	 					{
 		 					//? TODO: Validate Arguments before adding them to the Arguments array?
 		 					
 		 					// Add the new Arguments yielded from this Rule
-		 					foreach($yield as $y) $arguments[] = $y;
+		 					foreach ($yield as $y) $arguments[] = $y;
 	 						
 	 						// !IMPORTANT! Stop checking Rules
 	 						break; 
@@ -191,7 +191,7 @@ 
 					
 				} // END: foreach($rules as $rule)
 				
-				if( count($tokens) == 0 )
+				if (count($tokens) == 0)
 				{
 					// $argsS did NOT match any rules
 					
@@ -201,7 +201,7 @@ 
 					// Prepend popped elemented to beginning of $argsR
 					array_unshift($argsR, $arg);
 					
-					if( count($argsL) == 0 )
+					if (count($argsL) == 0)
 					{
 						// There was no match, and there are no arguments left to pop from $argsL
 						throw new ArghException(__METHOD__ . ': Syntax Error: ' . $argsS);
@@ -210,10 +210,10 @@ 
 				} // END: if( count($tokens) == 0 )
 				
 			} // END do
-			while( count($argsL) > 0 );
+			while (count($argsL)>0);
 			
 		} // END: do
-		while( count($args) > 0 );
+		while (count($args)>0);
 		
 		// Return Arguments array
 		return $arguments;
@@ -246,21 +246,21 @@ 
 		$argument = array();
 
 		// Loop through $tokens and define Argument(s) based on the current rules semantics
-		for($i=1; $i<count($tokens); $i++)
+		for ($i = 1; $i<count($tokens); $i++)
 		{
 			$token = $tokens[$i];
 			$semantics = $rule->semantics()[$i-1];
 
 			//echo __METHOD__ . ": token: $token (" . Rule::semanticsToString($semantics) . ")\n";
 
-			switch( $semantics )
+			switch ($semantics)
 			{ 
 				case ARGH_SEMANTICS_FLAG:
 				
-					if( $this->parameterCollection->exists($token) )
+					if ($this->parameterCollection->exists($token))
 					{	
 						// This Rule will create a single Argument
-						if(count($argument)==0) $argument[0] = new Argument($token);								
+						if (count($argument) == 0) $argument[0] = new Argument($token);								
 					}
 					else
 					{
@@ -274,15 +274,15 @@ 
 				case ARGH_SEMANTICS_FLAGS:
 					
 					// Check every character of this $token for a matching parameter 'flag'
-					for($j=0; $j<strlen($token); $j++)
+					for ($j = 0; $j<strlen($token); $j++)
 					{
-						if( $this->parameterCollection->exists( $token{$j} ) )
+						if ($this->parameterCollection->exists($token{$j} ))
 						{
 							// This Rule can only apply to ARGH_TYPE_BOOLEAN Parameters
-							if( ARGH_TYPE_BOOLEAN == $this->parameterCollection->get($token{$j})->getParameterType() )
+							if (ARGH_TYPE_BOOLEAN == $this->parameterCollection->get($token{$j})->getParameterType())
 							{
 								// Create new Argument for each flag
-								if( !array_key_exists($j, $argument) ) $argument[$j] = new Argument($token{$j});
+								if (!array_key_exists($j, $argument)) $argument[$j] = new Argument($token{$j});
 							}
 						}
 						else
@@ -301,10 +301,10 @@ 
 					
 				case ARGH_SEMANTICS_NAME:
 			
-					if( $this->parameterCollection->exists($token) )
+					if ($this->parameterCollection->exists($token))
 					{
 						// This Rule will create a single Argument
-						if(count($argument)==0) $argument[0] = new Argument($token); 								
+						if (count($argument) == 0) $argument[0] = new Argument($token); 								
 					}
 					else
 					{
@@ -320,7 +320,7 @@ 
 					// Usually, the Argument will have already been created by another token in this Rule
 				
 					// If no new Argument created by this Rule yet, create one now
-					if(count($argument)==0) $argument[0] = new Argument();
+					if (count($argument) == 0) $argument[0] = new Argument();
 					
 					// The new Argument's 'key' should be set by another token in this Rule
 					$argument[0]->setValue($token);
@@ -332,7 +332,7 @@ 
 					// Usually, the Argument will have already been created by another token in this Rule
 				
 					// If no new Argument created by this Rule yet, create one now
-					if(count($argument)==0) $argument[0] = new Argument();
+					if (count($argument) == 0) $argument[0] = new Argument();
 				
 					// Trim brackets from the $token (list)
 					$token = trim($token, "[]");
@@ -342,28 +342,28 @@ 
 					
 					// Use the $elements array as the 'value' for all new Argument created by this Rule
 					// Usually, this will only apply to a single Argument, unless this Rule contains ARGH_SEMANTICS_FLAGS
-					foreach($argument as &$a) $a->setValue($elements);
+					foreach ($argument as &$a) $a->setValue($elements);
 				
 					break;
 					
 				case ARGH_SEMANTICS_COMMAND:
 				
 					// Check if ParameterCollection contains any commands
-					if($this->parameterCollection->hasCommand())
+					if ($this->parameterCollection->hasCommand())
 					{
 						// Retrieve all ARGH_TYPE_COMMAND Parameters
 						$commands = $this->parameterCollection->getCommands();
 							
-						foreach($commands as $p)
+						foreach ($commands as $p)
 						{
-							if($p->hasOptions())
+							if ($p->hasOptions())
 							{
-								if( in_array($token, $p->getOptions()) )
+								if (in_array($token, $p->getOptions()))
 								{
 									// $token matches an option of this ARGH_TYPE_COMMAND Parameter	
 									
 				 					// If no new Argument created by this Rule yet, create one now
-				 					if(count($argument)==0) $argument[0] = new Argument($p->getName(), $token);
+				 					if (count($argument) == 0) $argument[0] = new Argument($p->getName(), $token);
 									
 									// Stop searching this Parameters options
 									break;

src/netfocusinc/argh/Rule.php

Spacing +12 added lines, -12 removed lines

@@ -40,8 +40,8 @@ 
 	const ARGH_SEMANTICS_NAME			= 3;
 	const ARGH_SEMANTICS_VALUE		= 4;
 	const ARGH_SEMANTICS_LIST			= 5;
-	const ARGH_SEMANTICS_COMMAND	= 6;
-	const ARGH_SEMANTICS_VARIABLE	= 7;
+	const ARGH_SEMANTICS_COMMAND = 6;
+	const ARGH_SEMANTICS_VARIABLE = 7;
 	
 	//
 	// PUBLIC PROPERTIES
@@ -80,10 +80,10 @@ 
 		$syntax = null;
 		$semantics = null;
 		
-		if( array_key_exists('name', $attributes) ) $name = $attributes['name'];
-		if( array_key_exists('example', $attributes) ) $example = $attributes['example'];
-		if( array_key_exists('syntax', $attributes) ) $syntax = $attributes['syntax'];
-		if( array_key_exists('semantics', $attributes) ) $semantics = $attributes['semantics'];
+		if (array_key_exists('name', $attributes)) $name = $attributes['name'];
+		if (array_key_exists('example', $attributes)) $example = $attributes['example'];
+		if (array_key_exists('syntax', $attributes)) $syntax = $attributes['syntax'];
+		if (array_key_exists('semantics', $attributes)) $semantics = $attributes['semantics'];
 		
 		return new self($name, $example, $syntax, $semantics);
 
@@ -100,7 +100,7 @@ 
 		*/
 	public static function semanticsToString(int $semantics)
 	{
-		switch($semantics)
+		switch ($semantics)
 		{
 			case self::ARGH_SEMANTICS_FLAG:			return 'FLAG';
 			case self::ARGH_SEMANTICS_FLAGS:		return 'FLAGS';
@@ -136,13 +136,13 @@ 
 		
 		// Validate the syntax regular expression
 		// Suppress error messages
-		if( @preg_match($syntax, '') === FALSE )
+		if (@preg_match($syntax, '') === FALSE)
 		{
-			throw new ArghException('Rule \'' . $name . '\' syntax \'' . $syntax .  '\' is not a valid regular expression');
+			throw new ArghException('Rule \'' . $name . '\' syntax \'' . $syntax . '\' is not a valid regular expression');
 		}
 		
 		// Confirm count(semantics) matches number of parenthesized subpatterns defined by the syntax regular expression
-		if( substr_count($syntax, '(') != count($semantics) )
+		if (substr_count($syntax, '(') != count($semantics))
 		{
 			throw new ArghException('Rule \'' . $name . '\' syntax defines ' . substr_count($syntax, '(') . ' sub-patterns, but semantics defines ' . count($semantics));
 		}
@@ -202,9 +202,9 @@ 
 		*
 		* @return bool
 	  */	
-	public function match($string, &$tokens=array()): bool
+	public function match($string, &$tokens = array()): bool
 	{
-		if( preg_match($this->syntax(), $string, $tokens) )
+		if (preg_match($this->syntax(), $string, $tokens))
 		{
 			return TRUE;
 		}

src/netfocusinc/argh/ArgvPreprocessor.php

Spacing +12 added lines, -12 removed lines

@@ -34,7 +34,7 @@ 
 	 */
 	public static function process(array $argv)
 	{
-		if(count($argv) < 1)
+		if (count($argv)<1)
 		{
 			throw(new ArghException(__CLASS__ . ': $argv is empty'));
 		}
@@ -49,32 +49,32 @@ 
 		// Lists
 		//
 		
-		for($i=0; $i<count($args); $i++)
+		for ($i = 0; $i<count($args); $i++)
 		{
 			// Lists begin with an opening bracket '['
-			if( strpos($args[$i], '[') !== FALSE )
+			if (strpos($args[$i], '[') !== FALSE)
 			{
 				// Found the beginning of a list at $i
 				//echo "DEBUG: Found beginning of a list at $i\n";
 				
 				// Search for the end of the list; starting at the current element				
-				for($j=$i; $j<count($args); $j++)
+				for ($j = $i; $j<count($args); $j++)
 				{
-					if( strpos($args[$j], ']') !== FALSE )
+					if (strpos($args[$j], ']') !== FALSE)
 					{
 						// Found the end of a list at $j
 						//echo "DEBUG: Found end of a list at $j\n";
 						
-						if($j != $i)
+						if ($j != $i)
 						{
 							// List does NOT open and close in the same element; elements must be re-combined
 						
 							// List closing bracket should always be the last character of the element
-							if( strpos($args[$j], ']') == (strlen($args[$j])-1) )
+							if (strpos($args[$j], ']') == (strlen($args[$j])-1))
 							{
 								// Create a new string for $args $i thru $j
 								$list = "";
-								for($k=$i; $k<=$j; $k++) $list .= $args[$k];
+								for ($k = $i; $k<=$j; $k++) $list .= $args[$k];
 								
 								//echo "DEBUG: Replace elements $i thru $j with: $list\n";
 								
@@ -108,13 +108,13 @@ 
 		//
 		
 		// Check for arguments with spaces, these were originally quoted on the command line
-		for($i=0; $i<count($args); $i++)
+		for ($i = 0; $i<count($args); $i++)
 		{
-			if( strpos($args[$i], ' ') !== FALSE )
+			if (strpos($args[$i], ' ') !== FALSE)
 			{
 
 				// Check if argument is a list
-				if( strpos($args[$i], '[') !== FALSE )
+				if (strpos($args[$i], '[') !== FALSE)
 				{
 					
 					//
@@ -128,7 +128,7 @@ 
 					//!TODO: handle --msg="Hello World"; We don't want "--msg=Hello World"
 					//! TODO: FIX. THIS IS BROKEN
 					
-					if( strpos($args[$i], '=') === FALSE )
+					if (strpos($args[$i], '=') === FALSE)
 					{
 						// Wrap (space containing) argument in quotes
 						$args[$i] = "'" . $args[$i] . "'";

src/netfocusinc/argh/ParameterCollection.php

Spacing +17 added lines, -17 removed lines

@@ -83,7 +83,7 @@ 
 		*/
 	public function exists(string $key): bool
 	{
-		if( array_key_exists($key, $this->map) )
+		if (array_key_exists($key, $this->map))
 		{
 			return true;
 		}
@@ -100,9 +100,9 @@ 
 		*/
 	public function hasCommand(): bool
 	{
-		foreach($this->parameters as $p)
+		foreach ($this->parameters as $p)
 		{
-			if( Parameter::ARGH_TYPE_COMMAND == $p->getParameterType() )
+			if (Parameter::ARGH_TYPE_COMMAND == $p->getParameterType())
 			{
 				return true;
 			}
@@ -119,9 +119,9 @@ 
 		*/
 	public function hasVariable(): bool
 	{
-		foreach($this->parameters as $p)
+		foreach ($this->parameters as $p)
 		{
-			if( Parameter::ARGH_TYPE_VARIABLE == $p->getParameterType() )
+			if (Parameter::ARGH_TYPE_VARIABLE == $p->getParameterType())
 			{
 				return true;
 			}
@@ -141,7 +141,7 @@ 
 		*/
 	public function get(string $key): Parameter
 	{
-		if($this->exists($key))
+		if ($this->exists($key))
 		{
 			$index = $this->map[$key];
 			
@@ -167,9 +167,9 @@ 
 	{
 		$commands = array();
 		
-		foreach($this->parameters as $p)
+		foreach ($this->parameters as $p)
 		{
-			if( Parameter::ARGH_TYPE_COMMAND == $p->getParameterType() )
+			if (Parameter::ARGH_TYPE_COMMAND == $p->getParameterType())
 			{
 				$commands[] = $p;
 			}
@@ -189,7 +189,7 @@ 
 		*/
 	public function addParameter(Parameter $param)
 	{
-		if( !$this->exists($param->getName()) )
+		if (!$this->exists($param->getName()))
 		{
 			// Add $param to $parameters array
 			$this->parameters[] = $param;
@@ -198,7 +198,7 @@ 
 			$this->map[$param->getName()] = count($this->parameters)-1;
 			
 			// Map the new parameter's 'flag' to its corresponding index in the $parameters array
-			if(!empty($param->getFlag())) $this->map[$param->getFlag()] = count($this->parameters)-1;
+			if (!empty($param->getFlag())) $this->map[$param->getFlag()] = count($this->parameters)-1;
 		}
 		else
 		{
@@ -219,21 +219,21 @@ 
 	public function mergeArguments(array $arguments): void
 	{
 		
-		foreach($arguments as $a)
+		foreach ($arguments as $a)
 		{	
 			// Check for a Parameter with this Arguments key
-			if( $this->exists($a->getKey()) )
+			if ($this->exists($a->getKey()))
 			{	
 				// Enforce limitations of Parameters
 				// 1. Do NOT allow value to be redefined
 				// 2. ARGH_TYPE_VARIABLE (VariableParameter) can have values appended
 				
-				if( Parameter::ARGH_TYPE_VARIABLE == $this->parameters[$this->map[$a->getKey()]]->getParameterType() )
+				if (Parameter::ARGH_TYPE_VARIABLE == $this->parameters[$this->map[$a->getKey()]]->getParameterType())
 				{
 					// Call VariableParameters::addValue() method
 					$this->parameters[$this->map[$a->getKey()]]->addValue($a->getValue());
 				}
-				else if( null !== $this->parameters[$this->map[$a->getKey()]]->getValue() )
+				else if (null !== $this->parameters[$this->map[$a->getKey()]]->getValue())
 				{
 					//
 					// Do NOT allow a Parameter's value to be redefined
@@ -255,11 +255,11 @@ 
 		} // END: foreach($arguments as $a)
 		
 		// Check for REQUIRED Parameters without any value
-		foreach($this->parameters as $p)
+		foreach ($this->parameters as $p)
 		{
-			if( ($p->isRequired() ) && (null == $p->getValue()) )
+			if (($p->isRequired()) && (null == $p->getValue()))
 			{
-				throw(new ArghException(__CLASS__ . ': Missing required parameter \'' . $p->getName() .  '\'.'));
+				throw(new ArghException(__CLASS__ . ': Missing required parameter \'' . $p->getName() . '\'.'));
 			}
 		}
 	}

src/netfocusinc/argh/Parameter.php

Spacing +11 added lines, -11 removed lines

@@ -31,7 +31,7 @@ 
 	// Parameter Data Types
 	const ARGH_TYPE_BOOLEAN		= 1;
 	const ARGH_TYPE_INT				= 2;
-	const ARGH_TYPE_STRING		= 3;
+	const ARGH_TYPE_STRING = 3;
 	const ARGH_TYPE_LIST			= 4;
 	const ARGH_TYPE_COMMAND		= 5;
 	const ARGH_TYPE_VARIABLE	= 6;
@@ -97,12 +97,12 @@ 
 		$options = array();
 		
 		// Extract parameter attributes from array
-		if( array_key_exists('name', $attributes) ) $name = $attributes['name'];
-		if( array_key_exists('flag', $attributes) ) $flag = $attributes['flag'];
-		if( array_key_exists('required', $attributes) ) $required = $attributes['required'];
-		if( array_key_exists('default', $attributes) ) $default = $attributes['default'];
-		if( array_key_exists('description', $attributes) ) $description = $attributes['description'];
-		if( array_key_exists('options', $attributes) ) $options = $attributes['options'];
+		if (array_key_exists('name', $attributes)) $name = $attributes['name'];
+		if (array_key_exists('flag', $attributes)) $flag = $attributes['flag'];
+		if (array_key_exists('required', $attributes)) $required = $attributes['required'];
+		if (array_key_exists('default', $attributes)) $default = $attributes['default'];
+		if (array_key_exists('description', $attributes)) $description = $attributes['description'];
+		if (array_key_exists('options', $attributes)) $options = $attributes['options'];
 		
 		// Construct a new Parameter instance
 		// Late static binding results in new instance of (calling) subclass
@@ -134,10 +134,10 @@ 
 		* @return Parameter
 		* @throws ArghException
 		*/
-	public function __construct(string $name, string $flag=null, bool $required=FALSE, $default=null, string $description=null, array $options=array())
+	public function __construct(string $name, string $flag = null, bool $required = FALSE, $default = null, string $description = null, array $options = array())
 	{ 
 		// Required a non-empty 'name'
-		if(empty($name))
+		if (empty($name))
 		{
 			throw(new ArghException('Parameter must have a name'));
 		}
@@ -221,7 +221,7 @@ 
 		*/
 	public function hasOptions(): bool
 	{
-		if(count($this->options) > 0)
+		if (count($this->options)>0)
 		{
 			return TRUE;
 		}
@@ -242,7 +242,7 @@ 
 		*/
 	public function isOption($value): bool
 	{
-		if( in_array($value, $this->options) )
+		if (in_array($value, $this->options))
 		{
 			return TRUE;
 		}

src/netfocusinc/argh/BooleanParameter.php

Spacing +4 added lines, -4 removed lines

@@ -45,7 +45,7 @@ 
 	{
 		// Interpret any non-empty value as TRUE
 		// Note that FALSE is considered to be empty()
-		if( !empty( parent::getDefault() ) )
+		if (!empty(parent::getDefault()))
 		{
 			return TRUE;
 		}	
@@ -79,17 +79,17 @@ 
 	public function setValue($value)
 	{
 				
-		if( null === $value )
+		if (null === $value)
 		{
 			// null (no value) considered TRUE (this is how flags work; e.g. the presence of a boolean flag -x without value means TRUE)
 			$this->value = TRUE;
 		}
-		else if( FALSE == $value )
+		else if (FALSE == $value)
 		{
 			// 'Falsey' (boolean) FALSE, (int) 0, (float 0.0), (string) '0', (string) '', NULL
 			$this->value = FALSE;
 		}
-		else if( in_array($value, array('0', 'false', 'False', 'FALSE', 'off', 'Off', 'OFF')) )
+		else if (in_array($value, array('0', 'false', 'False', 'FALSE', 'off', 'Off', 'OFF')))
 		{
 			// Certain character values should be considered to mean FALSE
 			$this->value = FALSE;

src/netfocusinc/argh/ListParameter.php

Spacing +4 added lines, -4 removed lines

@@ -55,7 +55,7 @@ 
 		*/
 	public function setValue($value)
 	{		
-		if(is_array($value))
+		if (is_array($value))
 		{
 			$this->value = $value;
 		}
@@ -77,14 +77,14 @@ 
 	public function addValue($value)
 	{
 		// Check if this Parameter has a previously set value
-		if($this->value === null)
+		if ($this->value === null)
 		{
 			// Initialize this Parameters value to a new array
 			$this->value = array();
 		}
 		
 		// Check if the new value is an array
-		if(!is_array($value))
+		if (!is_array($value))
 		{
 			// Append new single value to this Parameters value array
 			$this->value[] = $value;
@@ -92,7 +92,7 @@ 
 		else
 		{
 			// Append every new value to this Parameters value array
-			foreach($value as $v) $this->value[] = $v;
+			foreach ($value as $v) $this->value[] = $v;
 		}
 	}