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