Methods
All methods in the Solar_Cli_Help class.
Public
-
__construct() -
Constructor.
-
__destruct() -
Destructor; closes STDOUT and STDERR file handles.
-
dump() -
Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
-
exec() -
Public interface to execute the command.
-
getInfoHelp() -
Returns the help text for this command.
-
getInfoOptions() -
Returns an array of option flags and descriptions for this command.
-
locale() -
Looks up class-specific locale strings based on a key.
-
setConsoleController() -
Injects the console-controller object (if any) that invoked this command.
Protected
-
_buildConfig() -
Builds and returns the default config for a class, including all configs inherited from its parents.
-
_displayCommandHelp() -
Displays a list of help options for a command, or the list of commands if no command was requested.
-
_displayCommandList() -
Displays a list of available commands.
-
_err() -
Prints text to STDERR without a trailing newline.
-
_errln() -
Prints text to STDERR and appends a newline.
-
_exception() -
Convenience method for returning exceptions with localized text.
-
_exec() -
Displays a list of help options for a command, or the list of commands if no command was requested.
-
_fetchGetoptOptions() -
Gets the option settings from the class hierarchy.
-
_out() -
Prints text to STDOUT without a trailing newline.
-
_outln() -
Prints text to STDOUT and appends a newline.
-
_postConfig() -
A hook that activates after _buildConfig() in the constructor.
-
_postConstruct() -
Post-construction tasks to complete object construction.
-
_postExec() -
Runs just after the main _exec() method.
-
_preConfig() -
A hook that activates before _buildConfig() in the constructor.
-
_preExec() -
Runs just before the main _exec() method.
-
_setup() -
Post-construction setup logic.
Private
None.