Methods

Public

__construct(): Constructor.
__destruct(): Destructor; closes STDOUT and STDERR file handles.
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.
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.
writeClassConstants(): Writes the Constants file.
writeClassContents(): Writes the table-of-contents XML file.
writeClassMethod(): Writes an individual method file.
writeClassMethods(): Writes the Methods file.
writeClassOverview(): Writes the Overview file.
writeClassProperties(): Writes the Properties file.
writeClasses(): Writes the "class" directory.
writeClassesList(): Writes the contents file for the list of classes.
writePackageClassList(): Writes one package description file.
writePackages(): Writes the entire "packages" directory.

_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(): -?-
_getFile(): -?-
_getOptionSettings(): 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.
_postExec(): Post-execution logic.
_preExec(): Pre-exec logic.
_setup(): -?-
_title1(): Returns level-1 title markup.
_title2(): Returns level-2 title markup.
_title3(): Returns level-3 title markup.
_title4(): Returns level-4 title markup.
_touch(): -?-
_vt100(): Frontend to locale() that replaces style-format codes for VT100 shell output.
_write(): Writes a file to the target directory.

None.