netfocusinc / argh

src/netfocusinc/argh/IntegerParameter.php

Indentation +26 added lines, -26 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 	
 /**
-	* IntegerParameter.php
-	*/
+ * IntegerParameter.php
+ */
 	
 namespace netfocusinc\argh;
 
@@ -11,16 +11,16 @@ 
 
 
 /**
-	* A Integer Parameter.
-	*
-	* Subtype of Parameter that represents an integer.
-	*
-	* @author Benjamin Hough
-	*
-	* @api
-	*
-	* @since 1.0.0
-	*/
+ * A Integer Parameter.
+ *
+ * Subtype of Parameter that represents an integer.
+ *
+ * @author Benjamin Hough
+ *
+ * @api
+ *
+ * @since 1.0.0
+ */
 class IntegerParameter extends Parameter
 {
 	
@@ -33,26 +33,26 @@ 
 	//
 	
 	/**
-		* Returns one of the ARGH_TYPE_INT
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Returns one of the ARGH_TYPE_INT
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function getParameterType(): int
 	{
 		return Parameter::ARGH_TYPE_INT;
 	}
 
 	/**
-		* Sets the int value of this Parameter.
-		*
-		* Casts all values to int.
-		*
-		* @since 1.0.0
-		*
-		* @return int
-		*/
+	 * Sets the int value of this Parameter.
+	 *
+	 * Casts all values to int.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return int
+	 */
 	public function setValue($value)
 	{		
 		if(!is_numeric($value))

src/netfocusinc/argh/Argh.php

Indentation +167 added lines, -167 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 	
 /**
-	* Argh.php
-	*/ 
+ * Argh.php
+ */ 
 	
 namespace netfocusinc\argh;
 
@@ -18,17 +18,17 @@ 
 define('ARGH_TYPE_VARIABLE', Parameter::ARGH_TYPE_VARIABLE, true);
 
 /**
-	* Argument Helper
-	* 
-	* The main class to be used by clients for parsing command line arguments.
-	*
-	* @api
-	*
-	* @author  Benjamin Hough - Net Focus, Inc.
-	*
-	* @since 1.0.0
-	*
-	*/
+ * Argument Helper
+ * 
+ * The main class to be used by clients for parsing command line arguments.
+ *
+ * @api
+ *
+ * @author  Benjamin Hough - Net Focus, Inc.
+ *
+ * @since 1.0.0
+ *
+ */
 class Argh
 {
 	
@@ -50,20 +50,20 @@ 
 	//
 	
 	/**
-		* Create a new Argh instance and parses the arguments from $argv array
-		*
-		* This convenience method accepts both the PHP $argv array, and an array of Parameters used to interpret them.
-		* After creating a new instance of Argh, the $argv array is interpreted against the specificed Parameters.
-		*
-		* @api
-		*
-		* @since 1.0.0
-		*
-		* @param array $argv
-		* @param array $parameters Array of Parameters
-		*
-		* @return Argh
-		*/
+	 * Create a new Argh instance and parses the arguments from $argv array
+	 *
+	 * This convenience method accepts both the PHP $argv array, and an array of Parameters used to interpret them.
+	 * After creating a new instance of Argh, the $argv array is interpreted against the specificed Parameters.
+	 *
+	 * @api
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $argv
+	 * @param array $parameters Array of Parameters
+	 *
+	 * @return Argh
+	 */
 	public static function parse(array $argv, array $parameters) : Argh
 	{
 		$argh = new Argh($parameters);
@@ -74,20 +74,20 @@ 
 	}
 	
 	/**
-		* Create a new Argh instance and parses the arguments from $args string
-		*
-		* This convenience method accepts both a string of command line arguments, and an array of Parameters used to interpret them.
-		* After creating a new instance of Argh, the $args string is interpreted against the specified Parameters.
-		* 
-		* @api
-		*
-		* @since 1.0.0
-		*
-		* @param string $args A string simulating command line entry
-		* @param array $parameters Array of Parameters
-		*
-		* @return Argh
-		*/
+	 * Create a new Argh instance and parses the arguments from $args string
+	 *
+	 * This convenience method accepts both a string of command line arguments, and an array of Parameters used to interpret them.
+	 * After creating a new instance of Argh, the $args string is interpreted against the specified Parameters.
+	 * 
+	 * @api
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $args A string simulating command line entry
+	 * @param array $parameters Array of Parameters
+	 *
+	 * @return Argh
+	 */
 	public static function parseString(string $args, array $parameters) : Argh
 	{
 		// Force $args into an array
@@ -107,17 +107,17 @@ 
 	//
 
 	/** 
-		* Magic method providing access to parameter values via object properties syntax
-		*
-		* Forward requests for undefined object properties to Argh->get() method
-		*
-		*	@internal
-		* @since 1.0.0
-		*		 
-		* @param string $name The name (or flag) of a defined Parameter
-		*
-		* @return mixed The value of a Parameter (type depends on the Parameter's type)
-		*/	
+	 * Magic method providing access to parameter values via object properties syntax
+	 *
+	 * Forward requests for undefined object properties to Argh->get() method
+	 *
+	 *	@internal
+	 * @since 1.0.0
+	 *		 
+	 * @param string $name The name (or flag) of a defined Parameter
+	 *
+	 * @return mixed The value of a Parameter (type depends on the Parameter's type)
+	 */	
 	public function __get(string $key)
 	{
 		// Get parameters from this instance
@@ -125,15 +125,15 @@ 
 	}
 	
 	/**
-		* Magic method checks if a parameter value has been set via object property syntax
-		*
-		* @internal
-		* @since 1.0.0
-		*
-		* @param string $key The name (of flag) of a parameter
-		*
-		* @return boolean TRUE when the named parameter exists, otherwise FALSE
-		*/
+	 * Magic method checks if a parameter value has been set via object property syntax
+	 *
+	 * @internal
+	 * @since 1.0.0
+	 *
+	 * @param string $key The name (of flag) of a parameter
+	 *
+	 * @return boolean TRUE when the named parameter exists, otherwise FALSE
+	 */
 	public function __isset(string $key): bool
 	{
 		if( $this->parameters->exists($key) )
@@ -151,21 +151,21 @@ 
 	//
 
 	/**
-		* Contructs a new Argh instance
-		*
-		* Constructs a new instance of Argh with the specified Parameters.
-		* The resulting Argh instance is ready to interpret command line arguments.
-		* It is usually preferred to use Argh:parse() to create new Argh instances.
-		* Direct contruction is only necessary if you want to re-use the same Argh instance
-		* for parsing multiple sets of command line arguments. 
-		*
-		* @api
-		*
-		* @since 1.0.0
-		*
-		* @param array $parameters An array of Parameters to use for interpreting command line arguments
-		*
-		*/
+	 * Contructs a new Argh instance
+	 *
+	 * Constructs a new instance of Argh with the specified Parameters.
+	 * The resulting Argh instance is ready to interpret command line arguments.
+	 * It is usually preferred to use Argh:parse() to create new Argh instances.
+	 * Direct contruction is only necessary if you want to re-use the same Argh instance
+	 * for parsing multiple sets of command line arguments. 
+	 *
+	 * @api
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $parameters An array of Parameters to use for interpreting command line arguments
+	 *
+	 */
 	public function __construct(array $parameters)
 	{ 
 		// Init Language
@@ -183,18 +183,18 @@ 
 	} // END: public function __construct()
 	
 	/**
-		* Interprets an array of command line arguments
-		* 
-		* Parses the given $argv array using this instances pre-defined set of Parameters
-		*
-		* @api
-		*
-		* @since 1.0.0
-		*
-		* @param array $argv An array of command line arguments to interpret
-		*
-		* @throws ArghException
-		*/
+	 * Interprets an array of command line arguments
+	 * 
+	 * Parses the given $argv array using this instances pre-defined set of Parameters
+	 *
+	 * @api
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $argv An array of command line arguments to interpret
+	 *
+	 * @throws ArghException
+	 */
 	public function parseArguments(array $argv)
 	{
 		// Set properties on this object
@@ -221,19 +221,19 @@ 
 	}
 
 	/**
-		* Access elements of the original $argv array
-		*
-		* Provides access to the $argv array (and its elements) as registered by PHP CLI
-		*
-		*	@api
-		*
-		* @since 1.0.0
-		*		 
-		* @param int|null $i The index of an $argv element; or null to return the entire $argv array
-		*
-		* @return mixed The value of an element of the $argv array; or the entire $argv array (when param $i is null)
-		* @throws ArghException if $i is not a valid index of $argv
-		*/	
+	 * Access elements of the original $argv array
+	 *
+	 * Provides access to the $argv array (and its elements) as registered by PHP CLI
+	 *
+	 *	@api
+	 *
+	 * @since 1.0.0
+	 *		 
+	 * @param int|null $i The index of an $argv element; or null to return the entire $argv array
+	 *
+	 * @return mixed The value of an element of the $argv array; or the entire $argv array (when param $i is null)
+	 * @throws ArghException if $i is not a valid index of $argv
+	 */	
 	public function argv(int $i=null)
 	{
 		if($i !== null)
@@ -254,21 +254,21 @@ 
 	}
 	
 	/**
-		* Retrieves the value of a defined Parameter.
-		*
-		* Find the value of an Parameter
-		* Either the value of an Argument, if supplied on the command line,
-		* or, the default value as defined by the arguments corresponding Parameter.
-		*
-		*	@api
-		*
-		* @since 1.0.0
-		*		 
-		* @param string $key The name (or flag) of a defined Parameter
-		*
-		* @return mixed The value of a Parameter (type depends on the Parameter's type)
-		* @throws ArghException if the $key is not the name of a defined Parameter.
-		*/
+	 * Retrieves the value of a defined Parameter.
+	 *
+	 * Find the value of an Parameter
+	 * Either the value of an Argument, if supplied on the command line,
+	 * or, the default value as defined by the arguments corresponding Parameter.
+	 *
+	 *	@api
+	 *
+	 * @since 1.0.0
+	 *		 
+	 * @param string $key The name (or flag) of a defined Parameter
+	 *
+	 * @return mixed The value of a Parameter (type depends on the Parameter's type)
+	 * @throws ArghException if the $key is not the name of a defined Parameter.
+	 */
 	public function get($key)
 	{
 		
@@ -295,21 +295,21 @@ 
 	}
 
 	/**
-		* Retrieves any (unmarked) variables that were supplied as command line arguments.
-		*
-		* Variables are a type of Parameter that are unmarked (they have no name or flag).
-		* To parse variables, a VariableParameter must be added when creating a new Argh instance.
-		* This function is used to retrieve unmarked variables supplied as command line arguments.
-		* Any variables will be returned as an array of values.
-		*
-		*	@api
-		*
-		* @since 1.0.0
-		*		 
-		* @param string $key The name (or flag) of a defined Parameter
-		*
-		* @return mixed An array of strings when variables are present, otherwise FALSE
-		*/	
+	 * Retrieves any (unmarked) variables that were supplied as command line arguments.
+	 *
+	 * Variables are a type of Parameter that are unmarked (they have no name or flag).
+	 * To parse variables, a VariableParameter must be added when creating a new Argh instance.
+	 * This function is used to retrieve unmarked variables supplied as command line arguments.
+	 * Any variables will be returned as an array of values.
+	 *
+	 *	@api
+	 *
+	 * @since 1.0.0
+	 *		 
+	 * @param string $key The name (or flag) of a defined Parameter
+	 *
+	 * @return mixed An array of strings when variables are present, otherwise FALSE
+	 */	
 	public function variables()
 	{
 		if($this->parameters->hasVariable())
@@ -322,37 +322,37 @@ 
 	}
 	
 	/**
-		* Retrieves the ParameterCollection maintained by this Argh instance.
-		*
-		* Variables are a type of Parameter that are unmarked (they have no name or flag).
-		* To parse variables, a VariableParameter must be added when creating a new Argh instance.
-		* This function is used to retrieve unmarked variables supplied as command line arguments.
-		* Any variables will be returned as an array of values.
-		*
-		*	@api
-		*
-		* @since 1.0.0
-		*		 
-		* @param string $key The name (or flag) of a defined Parameter
-		*
-		* @return ParameterCollection A collection of Parameters maintained by Argh
-		*/	
+	 * Retrieves the ParameterCollection maintained by this Argh instance.
+	 *
+	 * Variables are a type of Parameter that are unmarked (they have no name or flag).
+	 * To parse variables, a VariableParameter must be added when creating a new Argh instance.
+	 * This function is used to retrieve unmarked variables supplied as command line arguments.
+	 * Any variables will be returned as an array of values.
+	 *
+	 *	@api
+	 *
+	 * @since 1.0.0
+	 *		 
+	 * @param string $key The name (or flag) of a defined Parameter
+	 *
+	 * @return ParameterCollection A collection of Parameters maintained by Argh
+	 */	
 	public function parameters() : ParameterCollection { return $this->parameters; }
 
 	/**
-		* Creates a 'usage string' useful for describing the command line arguments accepted by your program.
-		*
-		* This method can be used to create a string of descriptive text that details the command line arguments your 
-		* program accepts. This can be displayed to users when your program is invoked with a 'help' flag, or 
-		* when invalid command line arguments are used.
-		*
-		*	@api
-		*
-		* @since 1.0.0
-		*		 
-		*
-		* @return string Descriptive text that details the command line arguments accepted by your program.
-		*/	
+	 * Creates a 'usage string' useful for describing the command line arguments accepted by your program.
+	 *
+	 * This method can be used to create a string of descriptive text that details the command line arguments your 
+	 * program accepts. This can be displayed to users when your program is invoked with a 'help' flag, or 
+	 * when invalid command line arguments are used.
+	 *
+	 *	@api
+	 *
+	 * @since 1.0.0
+	 *		 
+	 *
+	 * @return string Descriptive text that details the command line arguments accepted by your program.
+	 */	
 	public function usageString()
 	{
 		//! TODO: Accept a formatting string/array (e.g. ['-f', '--name', 'text'])
@@ -409,14 +409,14 @@ 
 	}
 	
 	/**
-		* An alias of function usage()
-		*
-		*	@api
-		*
-		* @since 1.0.0
-		*
-		* @return string Descriptive text that details the command line arguments accepted by your program.
-		*/	
+	 * An alias of function usage()
+	 *
+	 *	@api
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Descriptive text that details the command line arguments accepted by your program.
+	 */	
 	public function usage() { return $this->usageString(); }
 	
 }

src/netfocusinc/argh/Language.php

Indentation +42 added lines, -42 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 	
 /**
-	* Language.php
-	*/
+ * Language.php
+ */
 	
 namespace netfocusinc\argh;
 
@@ -30,17 +30,17 @@ 
 define('ARGH_SEMANTICS_VARIABLE', Rule::ARGH_SEMANTICS_VARIABLE, true);
 
 /**
-	* Langugage is a set of Rules (with Syntax and Semantics) used to interpret command line arguments.
-	*
-	* The Language class manages the Rules used to interpret command line arguments during parsing.
-	* This class is a container for Rules, and features convenience methods for constructing a language complete with a set of standard rules.
-	*
-	* @api
-	* 
-	* @author Benjamin Hough
-	*
-	* @since 1.0.0
-	*/
+ * Langugage is a set of Rules (with Syntax and Semantics) used to interpret command line arguments.
+ *
+ * The Language class manages the Rules used to interpret command line arguments during parsing.
+ * This class is a container for Rules, and features convenience methods for constructing a language complete with a set of standard rules.
+ *
+ * @api
+ * 
+ * @author Benjamin Hough
+ *
+ * @since 1.0.0
+ */
 class Language
 {	
 	
@@ -56,14 +56,14 @@ 
 	//
 	
 	/**
-		* Creates a Language, complete with a set of Rules used for interpreting command line arguments
-		*
-		* This is the main function to use when creating a new Langugage.
-		*
-		* @since 1.0.0
-		*
-		* @return Language
-		*/
+	 * Creates a Language, complete with a set of Rules used for interpreting command line arguments
+	 *
+	 * This is the main function to use when creating a new Langugage.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return Language
+	 */
 	public static function createWithRules()
 	{
 		// Create a new Language instance
@@ -238,15 +238,15 @@ 
 	//
 	
 	/**
-		* Langugage Constructor
-		*
-		* The preferred way of constructing a new Language, is with the static createWithRules() method.
-		* This constructor is useful for creating custom languages, with non-standard rule sets.
-		*
-		* @since 1.0.0
-		*
-		* @throws Exception
-		*/
+	 * Langugage Constructor
+	 *
+	 * The preferred way of constructing a new Language, is with the static createWithRules() method.
+	 * This constructor is useful for creating custom languages, with non-standard rule sets.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @throws Exception
+	 */
 	public function __construct()
 	{
 		try
@@ -262,24 +262,24 @@ 
 	} // END: __construct()
 	
 	/**
-		* Returns the set of Rules maintained by this Language.
-		*
-		* @since 1.0.0
-		*
-		* @return array An array of Rules
-		*/
+	 * Returns the set of Rules maintained by this Language.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array An array of Rules
+	 */
 	public function rules()
 	{
 		return $this->rules;
 	}
 	
 	/**
-		* Adds a Rule to the set of rules maintained by this Language.
-		*
-		* @since 1.0.0
-		*
-		* @param $rule Rule
-		*/
+	 * Adds a Rule to the set of rules maintained by this Language.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param $rule Rule
+	 */
 	public function addRule(Rule $rule)
 	{
 		$this->rules[] = $rule;

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

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