|
Previous Class |
Solar_Getopt |
Next Page |
Solar_Getopt
Retrieves and validates command-line options and parameter values.
Catalog
This class is part of the Solar_Getopt package.
Inheritance:
- Solar_Base
- Solar_Getopt
Constants
None.
Public Properties
These are all the public properties in the Solar_Getopt class.
You can also view the list of all public, protected, and private properties.
$options- The array of acceptable options.
Public Methods
These are all the public methods in the Solar_Getopt class.
You can also view the list of all public, protected, and private methods.
__construct()- Constructor.
__destruct()- Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
apiVersion()- Reports the API version for this class.
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 values.
values()- Returns the populated option values.