HasHelp
A trait for application classes to use which provides a default implementation of the 'help', 'usage', and 'help_usage' commands.
Table of Contents
- handle_help() : mixed
- A default handler for the 'help' command.
- handle_help_usage() : mixed
- A default handler for the 'help_usage' command.
- handle_usage() : mixed
- A default handler for the 'usage' command.
Methods
handle_help()
A default handler for the 'help' command.
protected
handle_help(mixed $opts, mixed $params) : mixed
Returns the output from the $params->getHelp() method.
Parameters
- $opts : mixed
- $params : mixed
Return values
mixed —handle_help_usage()
A default handler for the 'help_usage' command.
protected
handle_help_usage(mixed $opts, mixed $params) : mixed
Depending on the value of the $params->help_usage_combo parameter, this will either return $params->getUsage() or $params->getHelp().
Parameters
- $opts : mixed
- $params : mixed
Return values
mixed —handle_usage()
A default handler for the 'usage' command.
protected
handle_usage(mixed $opts, mixed $params) : mixed
Returns the output from the $params->getUsage() method.
Parameters
- $opts : mixed
- $params : mixed