netfocusinc / argh

src/netfocusinc/argh/CommandParameter.php

Indentation +44 added lines, -44 removed lines

@@ -1,27 +1,27 @@ 
 <?php
 
 /**
-	* CommandParameter.php
-	*/
+ * CommandParameter.php
+ */
 	
 namespace netfocusinc\argh;
 
 use netfocusinc\argh\Parameter;
 
 /**
-	* A Command Parameter.
-	*
-	* Subtype of Parameter that represents a command string
-	* Command parameters must define an array of 'options'.
-	* When interpreting command line arguments, commands will only be matched with command line input
-	* when the command line argument matches one of the pre-defined 'options'.
-	*
-	* @author Benjamin Hough
-	*
-	* @api
-	*
-	* @since 1.0.0
-	*/
+ * A Command Parameter.
+ *
+ * Subtype of Parameter that represents a command string
+ * Command parameters must define an array of 'options'.
+ * When interpreting command line arguments, commands will only be matched with command line input
+ * when the command line argument matches one of the pre-defined 'options'.
+ *
+ * @author Benjamin Hough
+ *
+ * @api
+ *
+ * @since 1.0.0
+ */
 class CommandParameter extends Parameter
 {
 	
@@ -35,19 +35,19 @@ 
 	//
 	
 	/**
-		* Construct a new CommandParameter.
-		*
-		* Overrides Parameter constructor to enforce required 'options'
-		*
-		* @since 1.0.0
-		*
-		* @param string $name
-		* @param string $flag
-		* @param bool $required
-		* @param string $default The default 'option' to use for this command, when none is specified on the command line
-		* @param string $description
-		* @param array $options
-		*/
+	 * Construct a new CommandParameter.
+	 *
+	 * Overrides Parameter constructor to enforce required 'options'
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $name
+	 * @param string $flag
+	 * @param bool $required
+	 * @param string $default The default 'option' to use for this command, when none is specified on the command line
+	 * @param string $description
+	 * @param array $options
+	 */
 		
 	public function __construct(string $name, string $flag=null, bool $required=FALSE, $default=null, string $description=null, array $options=array())
 	{
@@ -63,28 +63,28 @@ 
 	}
 	
 	/**
-		* Returns ARGH_TYPE_COMMAND
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Returns ARGH_TYPE_COMMAND
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function getParameterType(): int
 	{
 		return Parameter::ARGH_TYPE_COMMAND;
 	}
 
 	/**
-		* Sets the string value of this Parameter.
-		*
-		* Checks that the given 'value' matches one of this Commands 'options' before settings its value.
-		*
-		* @since 1.0.0
-		*
-		* @param string $value
-		*
-		* @throws ArghException When $value is not one of this CommandsParameter's 'options'
-		*/
+	 * Sets the string value of this Parameter.
+	 *
+	 * Checks that the given 'value' matches one of this Commands 'options' before settings its value.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $value
+	 *
+	 * @throws ArghException When $value is not one of this CommandsParameter's 'options'
+	 */
 	public function setValue($value)
 	{		
 		if(is_array($value))

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

Indentation +28 added lines, -28 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 
 /**
-	* StringParameter.php
-	*/
+ * StringParameter.php
+ */
 	
 namespace netfocusinc\argh;
 
@@ -11,16 +11,16 @@ 
 
 
 /**
-	* String parameter
-	*
-	* Subtype of Parameter that represents a string value.
-	*
-	* @api
-	*
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * String parameter
+ *
+ * Subtype of Parameter that represents a string value.
+ *
+ * @api
+ *
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class StringParameter extends Parameter
 {
 	
@@ -33,28 +33,28 @@ 
 	//
 	
 	/**
-		* Returns ARGH_TYPE_STRING
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Returns ARGH_TYPE_STRING
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function getParameterType(): int
 	{
 		return Parameter::ARGH_TYPE_STRING;
 	}
 
 	/**
-		* Sets the string value of this Parameter.
-		*
-		* Casts all values to string.
-		*
-		* @since 1.0.0
-		*
-		* @param mixed $value
-		*
-		* @throws ArghExpception If $value is an array.
-		*/
+	 * Sets the string value of this Parameter.
+	 *
+	 * Casts all values to string.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $value
+	 *
+	 * @throws ArghExpception If $value is an array.
+	 */
 	public function setValue($value)
 	{		
 		if(is_array($value))

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

Indentation +46 added lines, -46 removed lines

@@ -1,22 +1,22 @@ 
 <?php
 	
 /**
-	* ArgumentParser.php
-	*/
+ * ArgumentParser.php
+ */
 	
 namespace netfocusinc\argh;
 
 /**
-	* Internal class that performs the work of parsing command line arguments.
-	*
-	* Uses the provided Language and ParameterCollection to interpret an array of command line arguments.
-	*
-	* @author Benjamin Hough
-	*
-	* @internal
-	*
-	* @since 1.0.0
-	*/
+ * Internal class that performs the work of parsing command line arguments.
+ *
+ * Uses the provided Language and ParameterCollection to interpret an array of command line arguments.
+ *
+ * @author Benjamin Hough
+ *
+ * @internal
+ *
+ * @since 1.0.0
+ */
 class ArgumentParser
 {
 	
@@ -35,13 +35,13 @@ 
 	//
 	
 	/**
-		* Constructs a new ArgumentParser
-		*
-		* Creates a new ArgumentParser instance with the specified Langugage and ParameterCollection
-		* The resulting instance is ready for parsing an array of arguments.
-		*
-		* @since 1.0.0
-		*/
+	 * Constructs a new ArgumentParser
+	 *
+	 * Creates a new ArgumentParser instance with the specified Langugage and ParameterCollection
+	 * The resulting instance is ready for parsing an array of arguments.
+	 *
+	 * @since 1.0.0
+	 */
 	public function __construct(Language $language, ParameterCollection $parameterCollection)
 	{
 		// Init properties on this instance
@@ -51,18 +51,18 @@ 
 	
 		
 	/**
-		* Parse an array of command line arguments.
-		*
-		* Interprets an array of command line arguments using the Language and ParameterCollection
-		* that was configured during construction.
-		* When successful, this results in an array of Arguments (with key,value pairs).
-		*
-		* @param array $args A pre-processed $argv array
-		*
-		* @return Argument[]
-		*
-		* @throws ArgumentException
-		*/
+	 * Parse an array of command line arguments.
+	 *
+	 * Interprets an array of command line arguments using the Language and ParameterCollection
+	 * that was configured during construction.
+	 * When successful, this results in an array of Arguments (with key,value pairs).
+	 *
+	 * @param array $args A pre-processed $argv array
+	 *
+	 * @return Argument[]
+	 *
+	 * @throws ArgumentException
+	 */
 	public function parse(array $args): array
 	{
 		// Init an array of Arguments
@@ -221,21 +221,21 @@ 
 	} // END: public static function parse()
 	
 	/**
-		* Attempts to create Arguments given a Rule and matching tokens (from the command line arguments string)
-		*
-		* When a set of matching tokens (from a command line argument string) is matched with a Rule (by the parse method)
-		* This function is used to determine if the matching tokens can yield an Argument from the matched Rule.
-		* This requires checking that the SEMANTICS of the Rule correspond with the matched tokens
-		* For example, if -xvf matches the Rule (hypenated multi flag), each character (of xvf) must also correspond to the flag of a 
-		* Parameter that was defined by the client. When no Argument is yielded, the parser can then attempt to match the tokens with another Rule.
-		*
-		* @internal
-		*
-		* @param $rule Rule
-		* @param $tokens string[]
-		*
-		* @return Argument[] An array of Arguments
-		*/
+	 * Attempts to create Arguments given a Rule and matching tokens (from the command line arguments string)
+	 *
+	 * When a set of matching tokens (from a command line argument string) is matched with a Rule (by the parse method)
+	 * This function is used to determine if the matching tokens can yield an Argument from the matched Rule.
+	 * This requires checking that the SEMANTICS of the Rule correspond with the matched tokens
+	 * For example, if -xvf matches the Rule (hypenated multi flag), each character (of xvf) must also correspond to the flag of a 
+	 * Parameter that was defined by the client. When no Argument is yielded, the parser can then attempt to match the tokens with another Rule.
+	 *
+	 * @internal
+	 *
+	 * @param $rule Rule
+	 * @param $tokens string[]
+	 *
+	 * @return Argument[] An array of Arguments
+	 */
 	public function yieldArgumentsFromRule(Rule $rule, array $tokens): array
 	{
 		

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;

Braces +33 added lines, -16 removed lines

@@ -158,11 +158,15 @@ 
 						//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
@@ -176,7 +180,9 @@ 
 		 					//? 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; 
@@ -260,9 +266,10 @@ 
 					if( $this->parameterCollection->exists($token) )
 					{	
 						// This Rule will create a single Argument
-						if(count($argument)==0) $argument[0] = new Argument($token);								
-					}
-					else
+						if(count($argument)==0) {
+							$argument[0] = new Argument($token);
+						}
+					} else
 					{
 						// This token does NOT match the flag of any defined parameter
 						// This Rule will NOT yield any arguments
@@ -282,10 +289,11 @@ 
 							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
+						} else
 						{
 							// A character in $token, does not match a defined Parameter flag
 							// This Rule will NOT yield any arguments
@@ -304,9 +312,10 @@ 
 					if( $this->parameterCollection->exists($token) )
 					{
 						// This Rule will create a single Argument
-						if(count($argument)==0) $argument[0] = new Argument($token); 								
-					}
-					else
+						if(count($argument)==0) {
+							$argument[0] = new Argument($token);
+						}
+					} else
 					{
 						// This token does NOT match the flag of any defined parameter
 						// This Rule will NOT yield any arguments
@@ -320,7 +329,9 @@ 
 					// 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 +343,9 @@ 
 					// 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,7 +355,9 @@ 
 					
 					// 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;
 					
@@ -363,7 +378,9 @@ 
 									// $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

Indentation +76 added lines, -76 removed lines

@@ -1,22 +1,22 @@ 
 <?php
 	
 /**
-	* Rule.php
-	*/
+ * Rule.php
+ */
 	
 namespace netfocusinc\argh;
 
 /**
-	* Representation of a Rule used to interpret command line arguments
-	*
-	* Rules are a combination of syntax and semantics used to interpret command line arguments.
-	* When a command line string matches the syntax of a rule, and its character content matches the sematics of the rule
-	* this command line string can be used to create an Argument.
-	*
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * Representation of a Rule used to interpret command line arguments
+ *
+ * Rules are a combination of syntax and semantics used to interpret command line arguments.
+ * When a command line string matches the syntax of a rule, and its character content matches the sematics of the rule
+ * this command line string can be used to create an Argument.
+ *
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class Rule
 {
 	//
@@ -64,14 +64,14 @@ 
 	//
 	
 	/**
-		* Creates a new Rule with the specified $attributes
-		*
-		* Convenience method for creating new Rules with the specified $attributes
-		*
-		* @since 1.0.0
-		*
-		* @returns Rule
-		*/
+	 * Creates a new Rule with the specified $attributes
+	 *
+	 * Convenience method for creating new Rules with the specified $attributes
+	 *
+	 * @since 1.0.0
+	 *
+	 * @returns Rule
+	 */
 	public static function createWithAttributes(array $attributes): Rule
 	{
 		// Defaults
@@ -90,14 +90,14 @@ 
 	}
 	
 	/**
-		* Returns a (human friendly) string representation of a semantic int
-		*
-		* @since 1.0.0
-		*
-		* @param int $semantics
-		*
-		* @returns string
-		*/
+	 * Returns a (human friendly) string representation of a semantic int
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param int $semantics
+	 *
+	 * @returns string
+	 */
 	public static function semanticsToString(int $semantics)
 	{
 		switch($semantics)
@@ -118,19 +118,19 @@ 
 	//
 	
 	/**
-		* Rule contructor.
-		*
-		* Constructs a new Rule.
-		*
-		* @since 1.0.0
-		*
-		* @param string $name
-		* @param string $example
-		* @param string $syntax
-		* @param array $semantics
-		*
-		* @throws ArghException
-		*/
+	 * Rule contructor.
+	 *
+	 * Constructs a new Rule.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $name
+	 * @param string $example
+	 * @param string $syntax
+	 * @param array $semantics
+	 *
+	 * @throws ArghException
+	 */
 	public function __construct(string $name, string $example, string $syntax, array $semantics)
 	{
 		
@@ -155,53 +155,53 @@ 
 	}
 
 	/**
-		* Gets the 'name' property of this Rule
-		*
-		* @since 1.0.0
-		*
-		* @return string
-	*/
+	 * Gets the 'name' property of this Rule
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function name(): string { return $this->name; }
 
 	/**
-		* Gets the 'syntax' property of this Rule
-		*
-		* @since 1.0.0
-		*
-		* @return string
-	*/
+	 * Gets the 'syntax' property of this Rule
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function syntax(): string { return $this->syntax; }
 	
 	/**
-		* Gets the 'semantics' property of this Rule
-		*
-		* @since 1.0.0
-		*
-		* @return array
-	*/
+	 * Gets the 'semantics' property of this Rule
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array
+	 */
 	public function semantics(): array { return $this->semantics; }
 	
 	/**
-		* Gets the 'sample' of this Rule
-		*
-		* @since 1.0.0
-		*
-		* @return string
-	*/
+	 * Gets the 'sample' of this Rule
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function example(): string { return $this->example; }
 
 	/**
-		* Does this Rule match a $string
-		*
-		* Note that matching a Rule does not guarantee the Rule will result
-		* in a new Argument. Ultimately, the argument string may not meet all the 
-		* requirements of the Rule, e.g. matching defined parameter name|flag|options
-		*
-		* @param $string string A string to check for match with this Rule
-		* @param $tokens array Reference to an array, on match will contain matching elements
-		*
-		* @return bool
-	  */	
+	 * Does this Rule match a $string
+	 *
+	 * Note that matching a Rule does not guarantee the Rule will result
+	 * in a new Argument. Ultimately, the argument string may not meet all the 
+	 * requirements of the Rule, e.g. matching defined parameter name|flag|options
+	 *
+	 * @param $string string A string to check for match with this Rule
+	 * @param $tokens array Reference to an array, on match will contain matching elements
+	 *
+	 * @return bool
+	 */	
 	public function match($string, &$tokens=array()): bool
 	{
 		if( preg_match($this->syntax(), $string, $tokens) )

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;
 		}

Braces +13 added lines, -6 removed lines

@@ -80,10 +80,18 @@ 
 		$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);
 
@@ -207,8 +215,7 @@ 
 		if( preg_match($this->syntax(), $string, $tokens) )
 		{
 			return TRUE;
-		}
-		else
+		} else
 		{
 			return FALSE;
 		}

src/netfocusinc/argh/ArgvPreprocessor.php

Indentation +10 added lines, -10 removed lines

@@ -1,20 +1,20 @@
 <?php
 	
 /**
-	* ArgvPreprocessor.php
-	*/
+ * ArgvPreprocessor.php
+ */
 	
 namespace netfocusinc\argh;
 
 /**
-	* Handles the preparation of PHP $argv arrays that is required before parsing
-	*
-	* @author Benjamin Hough
-	*
-	* @internal
-	*
-	* @since 1.0.0
-	*/
+ * Handles the preparation of PHP $argv arrays that is required before parsing
+ *
+ * @author Benjamin Hough
+ *
+ * @internal
+ *
+ * @since 1.0.0
+ */
 class ArgvPreprocessor
 {
 	

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] . "'";

Braces +5 added lines, -5 removed lines

@@ -74,7 +74,9 @@ 
 							{
 								// 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";
 								
@@ -83,8 +85,7 @@ 
 								
 								// Stop searching for the end of the list
 								break;
-							}
-							else
+							} else
 							{
 								throw new ArghException(__METHOD__ . ': Syntax Error: Invalid list.');
 							}
@@ -132,8 +133,7 @@ 
 					{
 						// Wrap (space containing) argument in quotes
 						$args[$i] = "'" . $args[$i] . "'";
-					}
-					else
+					} else
 					{
 						// Wrap (space containing) argument value - after '=' sign in quotes
 						

src/netfocusinc/argh/ParameterCollection.php

Indentation +95 added lines, -95 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 
 /**
-	* ParameterCollection.php
-	*/
+ * ParameterCollection.php
+ */
 		
 namespace netfocusinc\argh;
 
@@ -10,19 +10,19 @@ 
 use netfocusinc\argh\Parameter;
 
 /**
-	* Representation of a collection of Parameters
-	*
-	* A ParameterCollection maintains a list of the Parameters used to interpret command line arguments
-	* In addition to maintaining the Parameter list, this class is also responsible for "merging" Arguments
-	* with Parameters. This process involves using the Arguments (as parsed from the command line) to set
-	* values of Parameters in the collection.
-	*
-	* @internal
-	*
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * Representation of a collection of Parameters
+ *
+ * A ParameterCollection maintains a list of the Parameters used to interpret command line arguments
+ * In addition to maintaining the Parameter list, this class is also responsible for "merging" Arguments
+ * with Parameters. This process involves using the Arguments (as parsed from the command line) to set
+ * values of Parameters in the collection.
+ *
+ * @internal
+ *
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class ParameterCollection
 {	
 	//
@@ -40,12 +40,12 @@ 
 	//
 	
 	/**
-		* Magic function returns a string representation of this ParameterCollection
-		*
-		* @since 1.0.0
-		*
-		* @return string
-		*/
+	 * Magic function returns a string representation of this ParameterCollection
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function __toString()
 	{
 		return $this->toString();
@@ -56,13 +56,13 @@ 
 	//
 	
 	/**
-		* ParameterCollection constructor
-		*
-		* Constructs a new ParameterCollection with an empty list of Parameters
-		* and a "map" that can be used to reference Parameters in the collection by 'name' or 'tag'
-		*
-		* @since 1.0.0
-		*/
+	 * ParameterCollection constructor
+	 *
+	 * Constructs a new ParameterCollection with an empty list of Parameters
+	 * and a "map" that can be used to reference Parameters in the collection by 'name' or 'tag'
+	 *
+	 * @since 1.0.0
+	 */
 	public function __construct()
 	{
 		// Create a Parameter array
@@ -73,14 +73,14 @@ 
 	}
 	
 	/**
-		* Returns TRUE when the specified $key matches the 'name' or 'flag' of a Parameter in the collection
-		*
-		* @since 1.0.0
-		* 
-		* @param string $key
-		*
-		* @return bool Returns TRUE when the specified $key matches a Parameter in the collection; FALSE otherwise.
-		*/
+	 * Returns TRUE when the specified $key matches the 'name' or 'flag' of a Parameter in the collection
+	 *
+	 * @since 1.0.0
+	 * 
+	 * @param string $key
+	 *
+	 * @return bool Returns TRUE when the specified $key matches a Parameter in the collection; FALSE otherwise.
+	 */
 	public function exists(string $key): bool
 	{
 		if( array_key_exists($key, $this->map) )
@@ -92,12 +92,12 @@ 
 	}
 
 	/**
-		* Returns a boolean indicating if this collection contains a CommandParameter
-		*
-		* @since 1.0.0
-		*
-		* @return bool Returns TRUE when the collection contains a CommandParameter
-		*/
+	 * Returns a boolean indicating if this collection contains a CommandParameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return bool Returns TRUE when the collection contains a CommandParameter
+	 */
 	public function hasCommand(): bool
 	{
 		foreach($this->parameters as $p)
@@ -111,12 +111,12 @@ 
 	}
 	
 	/**
-		* Returns a boolean indicating if this collection contains a VariableParameter
-		*
-		* @since 1.0.0
-		*
-		* @return bool Returns TRUE when the collection contains a VariableParameter
-		*/
+	 * Returns a boolean indicating if this collection contains a VariableParameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return bool Returns TRUE when the collection contains a VariableParameter
+	 */
 	public function hasVariable(): bool
 	{
 		foreach($this->parameters as $p)
@@ -130,15 +130,15 @@ 
 	}
 	
 	/**
-		* Retrieves a Parameter in this collection by 'name' or 'flag'
-		*
-		* @since 1.0.0
-		*
-		* @param string $key The 'name' or 'flag' of a Parameter
-		* 
-		* @return Parameter
-		* @throws ArghException When there is no Parameter in the collection matching the specified $key
-		*/
+	 * Retrieves a Parameter in this collection by 'name' or 'flag'
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $key The 'name' or 'flag' of a Parameter
+	 * 
+	 * @return Parameter
+	 * @throws ArghException When there is no Parameter in the collection matching the specified $key
+	 */
 	public function get(string $key): Parameter
 	{
 		if($this->exists($key))
@@ -154,15 +154,15 @@ 
 	}
 	
 	/**
-		* Returns an array of command strings
-		*
-		* If this collection contains any CommandParameters,
-		* this method will return an array of the values defined by these commands.
-		*
-		* @since 1.0.0
-		*
-		* @return array
-		*/
+	 * Returns an array of command strings
+	 *
+	 * If this collection contains any CommandParameters,
+	 * this method will return an array of the values defined by these commands.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array
+	 */
 	public function getCommands(): array
 	{
 		$commands = array();
@@ -179,14 +179,14 @@ 
 	}
 
 	/**
-		* Adds a Parameter to the array of Parameters maintained by this collection.
-		*
-		* @since 1.0.0
-		*
-		* @param Parameter $param
-		* 
-		* @throws ArghException If a Parameter with the same 'name' already exists
-		*/
+	 * Adds a Parameter to the array of Parameters maintained by this collection.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param Parameter $param
+	 * 
+	 * @throws ArghException If a Parameter with the same 'name' already exists
+	 */
 	public function addParameter(Parameter $param)
 	{
 		if( !$this->exists($param->getName()) )
@@ -207,15 +207,15 @@ 
 	}
 	
 	/**
-		* Given an array of Arguments, this method sets the 'value' of Parameters in the collection
-		* with the 'value' of its corresponding Argument.
-		*
-		* @since 1.0.0
-		*
-		* @param array $arguments An array of Arguments
-		*
-		* @throws ArgumentException
-		*/
+	 * Given an array of Arguments, this method sets the 'value' of Parameters in the collection
+	 * with the 'value' of its corresponding Argument.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $arguments An array of Arguments
+	 *
+	 * @throws ArgumentException
+	 */
 	public function mergeArguments(array $arguments): void
 	{
 		
@@ -265,24 +265,24 @@ 
 	}
 	
 	/**
-		* Returns the array of Parameters in this collection.
-		*
-		* @since 1.0.0
-		*
-		* @return array Array of Parameters in this collection.
-		*/
+	 * Returns the array of Parameters in this collection.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array Array of Parameters in this collection.
+	 */
 	public function all()
 	{
 		return $this->parameters;
 	}
 	
 	/**
-		* Returns a string representation of this ParameterCollection.
-		*
-		* @since 1.0.0
-		*
-		* @return string Returns
-		*/
+	 * Returns a string representation of this ParameterCollection.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Returns
+	 */
 	public function toString()
 	{
 		return print_r($this->parameters, TRUE);

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() . '\'.'));
 			}
 		}
 	}

Braces +8 added lines, -11 removed lines

@@ -146,8 +146,7 @@ 
 			$index = $this->map[$key];
 			
 			return $this->parameters[$index];
-		}
-		else
+		} else
 		{
 			throw new ArghException('Parameter \'' . $key . '\' not in collection');
 		}	
@@ -198,9 +197,10 @@ 
 			$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;
-		}
-		else
+			if(!empty($param->getFlag())) {
+				$this->map[$param->getFlag()] = count($this->parameters)-1;
+			}
+		} else
 		{
 			throw(new ArghException(__CLASS__ . ': Parameter \'' . $param->name() . '\' cannot be redefined.'));
 		}
@@ -232,22 +232,19 @@ 
 				{
 					// 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
 					//
 					
 					throw(new ArghException(__CLASS__ . ': Parameter \'' . $a->getKey() . '\' value cannot be redefined.'));
-				}
-				else
+				} else
 				{
 					// Set Parameter value	
 					$this->parameters[$this->map[$a->getKey()]]->setValue($a->getValue());
 				}
-			}
-			else
+			} else
 			{
 				throw(new ArghException(__CLASS__ . ': Cannot merge Argument \'' . $a->getKey() . '\'. Parameter not defined.'));
 			}

src/netfocusinc/argh/Parameter.php

Indentation +119 added lines, -119 removed lines

@@ -1,23 +1,23 @@ 
 <?php
 
 /**
-	* Parameter.php
-	*/
+ * Parameter.php
+ */
 
 namespace netfocusinc\argh;
 
 /**
-	* Parameters define the arguments your CLI application can recieve.
-	*
-	* Parameters are pre-configured arguments that your CLI application can retrieve
-	* from command line arguments.
-	*
-	* @api
-	*
-	* @author  Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * Parameters define the arguments your CLI application can recieve.
+ *
+ * Parameters are pre-configured arguments that your CLI application can retrieve
+ * from command line arguments.
+ *
+ * @api
+ *
+ * @author  Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 abstract class Parameter
 {
 	
@@ -59,12 +59,12 @@ 
 	private $options;
 	
 	/** 
-		* @var mixed The value of this parameter.
-		*
-		* Null indicates no Argument was supplied on the command line.
-		* 
-		* Each Parameter may have its own type of value (e.g. int, string, array)
-		*/
+	 * @var mixed The value of this parameter.
+	 *
+	 * Null indicates no Argument was supplied on the command line.
+	 * 
+	 * Each Parameter may have its own type of value (e.g. int, string, array)
+	 */
 	protected $value;
 		
 	//
@@ -72,20 +72,20 @@ 
 	//
 	
 	/**
-		* Creates a new Parameter (sub-type) using the provided attributes
-		*
-		* This function is called statically on the subtypes of Parameter (e.g. BooleanParameter)
-		* It uses the supplied attributes to construct a new Parameter.
-		*
-		* @api
-		*
-		* @since 1.0.0
-		*
-		* @param array $attributes
-		*
-		* @return Parameter
-		* @throws ArghException
-		*/
+	 * Creates a new Parameter (sub-type) using the provided attributes
+	 *
+	 * This function is called statically on the subtypes of Parameter (e.g. BooleanParameter)
+	 * It uses the supplied attributes to construct a new Parameter.
+	 *
+	 * @api
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $attributes
+	 *
+	 * @return Parameter
+	 * @throws ArghException
+	 */
 	public static function createWithAttributes(array $attributes): Parameter
 	{
 		// Init default attributes for a new Parameter
@@ -116,24 +116,24 @@ 
 	//
 	
 	/**
-		* Parameter contructor.
-		*
-		* This function defines a constructor that is leveraged by Parameter sub-types.
-		* Normally, Parameter (sub-types, e.g. BooleanParameter) are creating using the static Parameter:createWithAttributes() function.
-		* Parameter is an abstract class, and as such cannot be instantiated directly.
-		*
-		* @since 1.0.0
-		*
-		* @param string $name
-		* @param string $flag
-		* @param bool $required
-		* @param mixed $default
-		* @param string $description
-		* @param array $options
-		*
-		* @return Parameter
-		* @throws ArghException
-		*/
+	 * Parameter contructor.
+	 *
+	 * This function defines a constructor that is leveraged by Parameter sub-types.
+	 * Normally, Parameter (sub-types, e.g. BooleanParameter) are creating using the static Parameter:createWithAttributes() function.
+	 * Parameter is an abstract class, and as such cannot be instantiated directly.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $name
+	 * @param string $flag
+	 * @param bool $required
+	 * @param mixed $default
+	 * @param string $description
+	 * @param array $options
+	 *
+	 * @return Parameter
+	 * @throws ArghException
+	 */
 	public function __construct(string $name, string $flag=null, bool $required=FALSE, $default=null, string $description=null, array $options=array())
 	{ 
 		// Required a non-empty 'name'
@@ -159,66 +159,66 @@ 
 	//
 	
 	/**
-		* Returns the text 'name' of this Parameter
-		*
-		* @since 1.0.0
-		*
-		* @return string
-		*/
+	 * Returns the text 'name' of this Parameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function getName(): string { return $this->name; }
 	
 	/**
-		* Returns the character 'flag' of this Parameter
-		*
-		* @since 1.0.0
-		*
-		* @return string
-		*/
+	 * Returns the character 'flag' of this Parameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function getFlag() { return $this->flag; }
 	
 	/**
-		* Returns the a boolean value indicating if this Parameter is required
-		*
-		* @since 1.0.0
-		*
-		* @return boolean
-		*/
+	 * Returns the a boolean value indicating if this Parameter is required
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return boolean
+	 */
 	public function isRequired(): bool { return $this->required; }
 	
 	/**
-		* Returns the 'default' value of this Parmater
-		*
-		* @since 1.0.0
-		*
-		* @return mixed
-		*/
+	 * Returns the 'default' value of this Parmater
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return mixed
+	 */
 	public function getDefault() { return $this->default; }
 	
 	/**
-		* Returns the text 'description' of this Parameter
-		*
-		* @since 1.0.0
-		*
-		* @return string
-		*/
+	 * Returns the text 'description' of this Parameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
 	public function getDescription() { return $this->description; }
 
 	/**
-		* Returns an array of 'options' that are legal for this Parameters 'value'
-		*
-		* @since 1.0.0
-		*
-		* @return array
-		*/
+	 * Returns an array of 'options' that are legal for this Parameters 'value'
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array
+	 */
 	public function	getOptions(): array { return $this->options; }
 	
 	/**
-		* Returns a boolean indicating if this Parameter has any defined 'options'
-		*
-		* @since 1.0.0
-		*
-		* @return bool
-		*/
+	 * Returns a boolean indicating if this Parameter has any defined 'options'
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return bool
+	 */
 	public function hasOptions(): bool
 	{
 		if(count($this->options) > 0)
@@ -232,14 +232,14 @@ 
 	}
 	
 	/**
-		* Returns a boolean indicating if the specified $value is a permissible 'option' of this Parameter
-		*
-		* @since 1.0.0
-		*
-		* @param mixed $value
-		* 
-		* @return bool
-		*/
+	 * Returns a boolean indicating if the specified $value is a permissible 'option' of this Parameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $value
+	 * 
+	 * @return bool
+	 */
 	public function isOption($value): bool
 	{
 		if( in_array($value, $this->options) )
@@ -253,12 +253,12 @@ 
 	}
 
 	/**
-		* Returns the 'value' of this Parameter
-		*
-		* @since 1.0.0
-		*
-		* @return mixed
-		*/	
+	 * Returns the 'value' of this Parameter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return mixed
+	 */	
 	public function getValue()
 	{
 		return $this->value;
@@ -269,21 +269,21 @@ 
 	//
 	
 	/**
-		* Returns an int corresponding to this Parameters type
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Returns an int corresponding to this Parameters type
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	abstract public function getParameterType(): int;
 	
 	/**
-		* Sets the 'value' of this Paramter
-		*
-		* @since 1.0.0
-		*
-		* @param mixed $value
-		*/
+	 * Sets the 'value' of this Paramter
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $value
+	 */
 	abstract public function setValue($value);
 	
 }

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;
 		}

Braces +20 added lines, -10 removed lines

@@ -97,12 +97,24 @@ 
 		$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
@@ -224,8 +236,7 @@ 
 		if(count($this->options) > 0)
 		{
 			return TRUE;
-		}
-		else
+		} else
 		{
 			return FALSE;
 		}
@@ -245,8 +256,7 @@ 
 		if( in_array($value, $this->options) )
 		{
 			return TRUE;
-		}
-		else
+		} else
 		{
 			return FALSE;
 		}

src/netfocusinc/argh/BooleanParameter.php

Indentation +35 added lines, -35 removed lines

@@ -1,25 +1,25 @@ 
 <?php
 	
 /**
-	* BooleanParameter.php
-	*/
+ * BooleanParameter.php
+ */
 	
 namespace netfocusinc\argh;
 
 use netfocusinc\argh\Parameter;
 
 /**
-	* Boolean parameter.
-	*
-	* Subtype of Parameter that represents a boolean value.
-	* Boolean parameters values are restricted to boolean literal values.
-	*
-	* @api
-	*
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * Boolean parameter.
+ *
+ * Subtype of Parameter that represents a boolean value.
+ * Boolean parameters values are restricted to boolean literal values.
+ *
+ * @api
+ *
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class BooleanParameter extends Parameter
 {
 	
@@ -33,14 +33,14 @@ 
 	//
 
 	/**
-		* Returns a boolean default value for this Parameter.
-		*
-		* Overrides Parameter::getDefault() to ensure a boolean return value
-		*
-		* @since 1.0.0
-		*
-		* @return bool
-		*/	
+	 * Returns a boolean default value for this Parameter.
+	 *
+	 * Overrides Parameter::getDefault() to ensure a boolean return value
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return bool
+	 */	
 	public function getDefault()
 	{
 		// Interpret any non-empty value as TRUE
@@ -56,26 +56,26 @@ 
 	}
 	
 	/**
-		* Returns ARGH_TYPE_BOOLEAN
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Returns ARGH_TYPE_BOOLEAN
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function getParameterType(): int
 	{
 		return Parameter::ARGH_TYPE_BOOLEAN;
 	}
 
 	/**
-		* Sets the boolean value of this Parameter.
-		*
-		* Translates any non boolean values to their boolean equivalents.
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Sets the boolean value of this Parameter.
+	 *
+	 * Translates any non boolean values to their boolean equivalents.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function setValue($value)
 	{
 				

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;

Braces +4 added lines, -8 removed lines

@@ -48,8 +48,7 @@ 
 		if( !empty( parent::getDefault() ) )
 		{
 			return TRUE;
-		}	
-		else
+		} else
 		{
 			return FALSE;
 		}
@@ -83,18 +82,15 @@ 
 		{
 			// 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;
-		}
-		else
+		} else
 		{
 			// Everything else considered TRUE
 			$this->value = TRUE;

src/netfocusinc/argh/ListParameter.php

Indentation +34 added lines, -34 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 
 /**
-	* ListParameter.php
-	*/
+ * ListParameter.php
+ */
 	
 namespace netfocusinc\argh;
 
@@ -11,16 +11,16 @@ 
 
 
 /**
-	* A List Parameter.
-	*
-	* Subtype of Parameter that represents a list of text values.
-	*
-	* @api
-	*
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * A List Parameter.
+ *
+ * Subtype of Parameter that represents a list of text values.
+ *
+ * @api
+ *
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class ListParameter extends Parameter
 {
 	
@@ -33,26 +33,26 @@ 
 	//
 	
 	/**
-		* ReturnsParameter::ARGH_TYPE_LIST
-		*
-		* Identifies this Parameter subtype as a ListParameter by returning constant ARGH_TYPE_LIST
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * ReturnsParameter::ARGH_TYPE_LIST
+	 *
+	 * Identifies this Parameter subtype as a ListParameter by returning constant ARGH_TYPE_LIST
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function getParameterType(): int
 	{
 		return Parameter::ARGH_TYPE_LIST;
 	}
 
 	/**
-		* Sets the array value of this Parameter.
-		*
-		* Forces all values into an array
-		*
-		* @since 1.0.0
-		*/
+	 * Sets the array value of this Parameter.
+	 *
+	 * Forces all values into an array
+	 *
+	 * @since 1.0.0
+	 */
 	public function setValue($value)
 	{		
 		if(is_array($value))
@@ -66,14 +66,14 @@ 
 	}
 
 	/**
-		* Adds an element to the value of this Parameter
-		*
-		* Forces all values into an array
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/	
+	 * Adds an element to the value of this Parameter
+	 *
+	 * Forces all values into an array
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */	
 	public function addValue($value)
 	{
 		// Check if this Parameter has a previously set value

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;
 		}
 	}
 	

Braces +5 added lines, -5 removed lines

@@ -58,8 +58,7 @@ 
 		if(is_array($value))
 		{
 			$this->value = $value;
-		}
-		else
+		} else
 		{
 			$this->value = array($value);
 		}
@@ -88,11 +87,12 @@ 
 		{
 			// Append new single value to this Parameters value array
 			$this->value[] = $value;
-		}
-		else
+		} else
 		{
 			// Append every new value to this Parameters value array
-			foreach($value as $v) $this->value[] = $v;
+			foreach($value as $v) {
+				$this->value[] = $v;
+			}
 		}
 	}