netfocusinc / argh

src/netfocusinc/argh/VariableParameter.php

Indentation +56 added lines, -56 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 	
 /**
-	* VariableParameter.php
-	*/
+ * VariableParameter.php
+ */
 	
 namespace netfocusinc\argh;
 
@@ -10,18 +10,18 @@ 
 use netfocusinc\argh\Parameter;
 
 /**
-	* Variable parameter.
-	*
-	* Subtype of Parameter that represents an (unmarked) variable.
-	* Variable Parameters are used to save unmakred input (naked variables)
-	* Their value always consists of an array.
-	*
-	* @api
-	*
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * Variable parameter.
+ *
+ * Subtype of Parameter that represents an (unmarked) variable.
+ * Variable Parameters are used to save unmakred input (naked variables)
+ * Their value always consists of an array.
+ *
+ * @api
+ *
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class VariableParameter extends Parameter
 {
 	
@@ -30,14 +30,14 @@ 
 	//
 	
 	/**
-		* Returns an instance of VariableParameter
-		*
-		* VariableParameters are always named with the ARGH_NAME_VARIABLE constant
-		*
-		* @since 1.0.1
-		*
-		* @return Parameter
-		*/
+	 * Returns an instance of VariableParameter
+	 *
+	 * VariableParameters are always named with the ARGH_NAME_VARIABLE constant
+	 *
+	 * @since 1.0.1
+	 *
+	 * @return Parameter
+	 */
 	public static function create() : Parameter
 	{	
 		return parent::createWithAttributes(
@@ -50,17 +50,17 @@ 
 	}
 	
 	/**
-		* Returns an instance of VariableParameter
-		*
-		* Overriding Parameter::createWithAttribute() here prevents this from being called with a custom 'name' attribute
-		* VariableParameters need to be named with ARGH_NAME_VARIABLE constant; Argh uses this 'name' to find variables
-		*
-		* @since 1.0.2
-		*
-		* @param array $attributes
-		*
-		* @return Parameter
-		*/
+	 * Returns an instance of VariableParameter
+	 *
+	 * Overriding Parameter::createWithAttribute() here prevents this from being called with a custom 'name' attribute
+	 * VariableParameters need to be named with ARGH_NAME_VARIABLE constant; Argh uses this 'name' to find variables
+	 *
+	 * @since 1.0.2
+	 *
+	 * @param array $attributes
+	 *
+	 * @return Parameter
+	 */
 	public static function createWithAttributes(array $attributes) : Parameter
 	{	
 		// Force VariableParameters to use a constant name
@@ -77,26 +77,26 @@ 
 	//
 	
 	/**
-		* Returns ARGH_TYPE_VARIABLE
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Returns ARGH_TYPE_VARIABLE
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function getParameterType(): int
 	{
 		return Parameter::ARGH_TYPE_VARIABLE;
 	}
 
 	/**
-		* Sets the array value of this Parameter.
-		*
-		* Forces all values into an array
-		*
-		* @since 1.0.0
-		*
-		* @param mixed $value
-		*/
+	 * Sets the array value of this Parameter.
+	 *
+	 * Forces all values into an array
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $value
+	 */
 	public function setValue($value)
 	{	
 		if(is_array($value))
@@ -110,15 +110,15 @@ 
 	}
 
 	/**
-		* Adds an element to the value of this Parameter
-		*
-		* Forces all values into an array
-		*
-		* @since 1.0.0
-		*
-		* @param mixed $value
-		*
-		*/	
+	 * Adds an element to the value of this Parameter
+	 *
+	 * Forces all values into an array
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $value
+	 *
+	 */	
 	public function addValue($value)
 	{
 		// Check if this Parameter has a previously set value

Spacing +5 added lines, -5 removed lines

@@ -64,7 +64,7 @@ 
 	public static function createWithAttributes(array $attributes) : Parameter
 	{	
 		// Force VariableParameters to use a constant name
-		if(array_key_exists('name', $attributes))
+		if (array_key_exists('name', $attributes))
 		{
 			$attributes['name'] = Parameter::ARGH_NAME_VARIABLE;
 		}
@@ -99,7 +99,7 @@ 
 		*/
 	public function setValue($value)
 	{	
-		if(is_array($value))
+		if (is_array($value))
 		{
 			$this->value = $value;
 		}
@@ -122,14 +122,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;
@@ -137,7 +137,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;
 		}
 	}
 	

src/netfocusinc/argh/ParameterCollection.php

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->getName() . '\' 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/Language.php

Spacing +1 added lines, -1 removed lines

@@ -254,7 +254,7 @@
 			// Create an array of Rules
 			$this->rules = array();
 		}
-		catch(\Exception $e)
+		catch (\Exception $e)
 		{
 			throw($e);
 		}

Braces +1 added lines, -2 removed lines

@@ -253,8 +253,7 @@
 		{
 			// Create an array of Rules
 			$this->rules = array();
-		}
-		catch(\Exception $e)
+		} catch(\Exception $e)
 		{
 			throw($e);
 		}

src/netfocusinc/argh/Rule.php

Spacing +11 added lines, -11 removed lines

@@ -32,7 +32,7 @@ 
 	const ARGH_SYNTAX_LIST			= '[a-z0-9_\-,\' ]+';
 	const ARGH_SYNTAX_COMMAND	= '[a-z0-9_]{2,}';
 	const ARGH_SYNTAX_QUOTED		= '[a-z0-9_\-\'\\/\. ]+';
-	const ARGH_SYNTAX_VARIABLE	= '[a-z0-9_\.\/]*';
+	const ARGH_SYNTAX_VARIABLE = '[a-z0-9_\.\/]*';
 	
 	// Semantic Contants
 	const ARGH_SEMANTICS_FLAG			= 1;
@@ -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/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;
@@ -248,21 +248,21 @@ 
 		// Loop through $tokens and define Argument(s) based on the current rules semantics
 		$count_tokens = count($tokens);
 		
-		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
 					{
@@ -276,15 +276,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
@@ -303,10 +303,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
 					{
@@ -322,7 +322,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);
@@ -334,7 +334,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, "[]");
@@ -344,28 +344,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/ArghException.php

Indentation +35 added lines, -35 removed lines

@@ -1,51 +1,51 @@
 <?php
 	
 /**
-	* ArghException.php
-	*/
+ * ArghException.php
+ */
 	
 namespace netfocusinc\argh;
 	
 /**
- 	* An exception that is thrown by Argh
- 	*
- 	* A subclass of Exception that is thrown by Argh.
- 	* 
- 	* @author Benjamin Hough
- 	*
- 	* @since 1.0.0
- 	* 
- 	*/
+ * An exception that is thrown by Argh
+ *
+ * A subclass of Exception that is thrown by Argh.
+ * 
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ * 
+ */
 class ArghException extends \Exception
 {
 		/**
-			* Contruct a new ArghException with a required message
-			*
-			* @since 1.0.0
-			*
-			* @param string $message Custom message describing this Exception
-			* @param int $code Custom error code
-			* @param Exception $previous The previous Exception to occurr
-			*
-			*/
-    public function __construct($message, $code = 0, \Exception $previous = null) {
-        // some code
+		 * Contruct a new ArghException with a required message
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param string $message Custom message describing this Exception
+		 * @param int $code Custom error code
+		 * @param Exception $previous The previous Exception to occurr
+		 *
+		 */
+	public function __construct($message, $code = 0, \Exception $previous = null) {
+		// some code
     
-        // make sure everything is assigned properly
-        parent::__construct($message, $code, $previous);
-    }
+		// make sure everything is assigned properly
+		parent::__construct($message, $code, $previous);
+	}
 
 
 		/**
-			* Returns a descriptive string indentifying this Exception
-			*
-			* @since 1.0.0
-			*
-			* @return string
-			*
-			*/
-    public function __toString() {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
+		 * Returns a descriptive string indentifying this Exception
+		 *
+		 * @since 1.0.0
+		 *
+		 * @return string
+		 *
+		 */
+	public function __toString() {
+		return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+	}
     
 }
\ No newline at end of file