← Older revision
Revision as of 10:37, 9 March 2014
Line 3:
Line 3:
==Functions==
==Functions==
+
===addDescription()===
*addDescription( $text); // Set the description text.
*addDescription( $text); // Set the description text.
+
===addArg()===
*addArg( $arg, $description, $required = true ); // arg: name of the arg $description: short description of the arg $required: is this required?
*addArg( $arg, $description, $required = true ); // arg: name of the arg $description: short description of the arg $required: is this required?
+
===addOption()===
*addOption($name, $description, $required=false, $withArg=false, $shortName=false); // $required: is the param required? $withArg: is an argument required with this option? $shortName: character to use as short name
*addOption($name, $description, $required=false, $withArg=false, $shortName=false); // $required: is the param required? $withArg: is an argument required with this option? $shortName: character to use as short name
+
The shortname would be, e.g., 'm' if you wanted -mFast to be an alternative to --mode=Fast.
+
===getArg()===
*getArg( $argId = 0, $default = null ); // $argId: the integer value (from zero) for the arg $default: the default if it doesn't exist
*getArg( $argId = 0, $default = null ); // $argId: the integer value (from zero) for the arg $default: the default if it doesn't exist
+
===outPut()===
*output( $output, $channel = null );
*output( $output, $channel = null );
+
===runChild()===
*runChild( $mainClass, $classFile = null ); // maintClass: a name of a child maintenance class $classFile: full path of where the child is
*runChild( $mainClass, $classFile = null ); // maintClass: a name of a child maintenance class $classFile: full path of where the child is