ApplicationDescription
Describes an application.
| since |
2.0.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Console\Application application, string namespace = '', bool showHidden = false) : mixed
| since |
2.0.0 |
|---|
Arguments
- application
\Joomla\Console\ApplicationThe application being described.- namespace
stringThe command namespace to process.- showHidden
boolFlag indicating hidden commands should be displayed.
Response
mixed
extractNamespace
Returns the namespace part of the command name.
extractNamespace(string name, int limit = null) : string
| since |
2.0.0 |
|---|
Arguments
- name
stringThe command name to process- limit
intThe maximum number of parts of the namespace
Response
string
getCommand
Get a command by name.
getCommand(string name) : \Joomla\Console\Command\AbstractCommand
| since |
2.0.0 |
|---|---|
| throws |
|
Arguments
- name
stringThe name of the command to retrieve.
Response
\Joomla\Console\Command\AbstractCommand
getCommands
Get the application's commands.
getCommands() : \Joomla\Console\Command\AbstractCommand[]
| since |
2.0.0 |
|---|
Response
\Joomla\Console\Command\AbstractCommand[]
getNamespaces
Get the application's command namespaces.
getNamespaces() : array[]
| since |
2.0.0 |
|---|
Response
array[]
inspectApplication
Inspects the application.
inspectApplication() : void
| since |
2.0.0 |
|---|
sortCommands
Sort a set of commands.
sortCommands(\Joomla\Console\Command\AbstractCommand[] commands) : \Joomla\Console\Command\AbstractCommand[][]
| since |
2.0.0 |
|---|
Arguments
- commands
\Joomla\Console\Command\AbstractCommand[]The commands to sort.
Response
\Joomla\Console\Command\AbstractCommand[][]
Constants
GLOBAL_NAMESPACE
Placeholder for commands in the global namespace.
| Value | '_global' |
|---|---|
| since |
2.0.0 |
Type(s)
string
Properties
aliases
The application's aliased commands.
| since |
2.0.0 |
|---|
Type(s)
\Joomla\Console\Command\AbstractCommand[]
application
The application being described.
| since |
2.0.0 |
|---|
Type(s)
\Joomla\Console\Application
commands
The application's commands.
| since |
2.0.0 |
|---|
Type(s)
\Joomla\Console\Command\AbstractCommand[]
namespace
The command namespace to process.
| since |
2.0.0 |
|---|
Type(s)
string
namespaces
The application's command namespaces.
| since |
2.0.0 |
|---|
Type(s)
array[]
showHidden
Flag indicating hidden commands should be displayed.
| since |
2.0.0 |
|---|
Type(s)
bool