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))

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))

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
 	{
 		

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) )

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
 {
 	

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

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

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)
 	{
 				

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