Methods
All methods in the Solar_Getopt class.
Public
-
__construct() -
Constructor.
-
__destruct() -
Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
-
dump() -
Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
-
getInvalid() -
Returns a list of invalid options and their error messages (if any).
-
locale() -
Looks up class-specific locale strings based on a key.
-
populate() -
Populates the options with values from $argv.
-
setOption() -
Sets one option for recognition.
-
setOptions() -
Sets multiple acceptable options.
-
validate() -
Applies validation and sanitizing filters to the option values.
-
values() -
Returns the populated option values.
Protected
-
_buildConfig() -
Builds and returns the default config for a class, including all configs inherited from its parents.
-
_exception() -
Convenience method for returning exceptions with localized text.
-
_getOptionName() -
Gets an option name from its short or long format.
-
_parseLong() -
Parse a long-form option.
-
_parseParam() -
Parse the parameter value for a named option.
-
_parseShort() -
Parse a short-form option (or cluster of options).
-
_postConfig() -
A hook that activates after _buildConfig() in the constructor.
-
_postConstruct() -
Post-construction tasks to complete object construction.
-
_preConfig() -
A hook that activates before _buildConfig() in the constructor.
Private
None.