Joomla! API

Download
Launch

HelpCommand

Extends AbstractCommand

Command to render a command's help data.

since

2.0.0
package

Joomla Framework

Methods

__construct

Command constructor.

__construct(string|null name = null) : mixed
inherited
since

2.0.0

Arguments

name

string|nullThe name of the command; if the name is empty and no default is set, a name must be set in the configure() method

Response

mixed

addArgument

Adds an argument to the input definition.

addArgument(string name, int mode = null, string description = '', mixed default = null) : $this
inherited
since

2.0.0

Arguments

name

stringThe argument name

mode

intThe argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL

description

stringA description text

default

mixedThe default value (for InputArgument::OPTIONAL mode only)

Response

$this

addOption

Adds an option to the input definition.

addOption(string name, string|array shortcut = null, int mode = null, string description = '', mixed default = null) : $this
inherited
since

2.0.0

Arguments

name

stringThe option name

shortcut

string|arrayThe shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts

mode

intThe option mode: One of the VALUE_* constants

description

stringA description text

default

mixedThe default value (must be null for InputOption::VALUE_NONE)

Response

$this

configure

Configure the command.

configure() : void
inherited
since

2.0.0

doExecute

Internal function to execute the command.

doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : int
inherited abstract
since

2.0.0

Arguments

input

\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.

output

\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.

Response

intThe command exit code

execute

Executes the command.

execute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : int
inherited
since

2.0.0

Arguments

input

\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.

output

\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.

Response

intThe command exit code

getAliases

Get the command's aliases.

getAliases() : string[]
inherited
since

2.0.0

Response

string[]

getApplication

Get the application object.

getApplication() : \Joomla\Console\Application
inherited
since

2.0.0
throws

\UnexpectedValueExceptionif the application has not been set.

Response

\Joomla\Console\ApplicationThe application object.

getDefaultName

Get the default command name for this class.

getDefaultName() : string|null
inherited static

This allows a command name to defined and referenced without instantiating the full command class.

since

2.0.0

Response

string|null

getDefinition

Gets the InputDefinition attached to this command.

getDefinition() : \Symfony\Component\Console\Input\InputDefinition
inherited
since

2.0.0

Response

\Symfony\Component\Console\Input\InputDefinition

getDescription

Get the command's description.

getDescription() : string
inherited
since

2.0.0

Response

string

getHelp

Get the command's help.

getHelp() : string
inherited
since

2.0.0

Response

string

getHelperSet

Get the command's input helper set.

getHelperSet() : \Symfony\Component\Console\Helper\HelperSet|null
inherited
since

2.0.0

Response

\Symfony\Component\Console\Helper\HelperSet|null

getName

Get the command's name.

getName() : string|null
inherited
since

2.0.0

Response

string|null

getProcessedHelp

Returns the processed help for the command.

getProcessedHelp() : string
inherited

This method is used to replace placeholders in commands with the real values. By default, this supports %command.name% and %command.full_name.

since

2.0.0

Response

string

getSynopsis

Get the command's synopsis.

getSynopsis(bool short = false) : string
inherited
since

2.0.0

Arguments

short

boolFlag indicating whether the short or long version of the synopsis should be returned

Response

string

initialise

Internal hook to initialise the command after the input has been bound and before the input is validated.

initialise(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : void
inherited
since

2.0.0

Arguments

input

\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.

output

\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.

isEnabled

Check if the command is enabled in this environment.

isEnabled() : bool
inherited
since

2.0.0

Response

bool

isHidden

Check if the command is hidden from the command listing.

isHidden() : bool
inherited
since

2.0.0

Response

bool

setAliases

Set the command's aliases.

setAliases(string[] aliases) : void
inherited
since

2.0.0

Arguments

aliases

string[]The command aliases

setApplication

Set the command's application.

setApplication(\Joomla\Console\Application application = null) : void
inherited
since

2.0.0

Arguments

application

\Joomla\Console\ApplicationThe command's application

setCommand

Set the command whose help is being presented.

setCommand(\Joomla\Console\Command\AbstractCommand command) : void
since

2.0.0

Arguments

command

\Joomla\Console\Command\AbstractCommandThe command to process help for.

setDefinition

Sets the input definition for the command.

setDefinition(array|\Symfony\Component\Console\Input\InputDefinition definition) : void
inherited
since

2.0.0

Arguments

definition

array|\Symfony\Component\Console\Input\InputDefinitionEither an InputDefinition object or an array of objects to write to the definition.

setDescription

Sets the description for the command.

setDescription(string description) : void
inherited
since

2.0.0

Arguments

description

stringThe description for the command

setHelp

Sets the help for the command.

setHelp(string help) : void
inherited
since

2.0.0

Arguments

help

stringThe help for the command

setHelperSet

Set the command's input helper set.

setHelperSet(\Symfony\Component\Console\Helper\HelperSet helperSet) : void
inherited
since

2.0.0

Arguments

helperSet

\Symfony\Component\Console\Helper\HelperSetThe helper set.

setHidden

Set whether this command is hidden from the command listing.

setHidden(bool hidden) : void
inherited
since

2.0.0

Arguments

hidden

boolFlag if this command is hidden.

setName

Set the command's name.

setName(string name) : void
inherited
since

2.0.0

Arguments

name

stringThe command name

Properties

defaultName

The default command name

inherited static
since

2.0.0

Type(s)

string|null

command

The command to process help for

since

2.0.0

Type(s)

\Joomla\Console\Command\AbstractCommand|null

aliases

The command's aliases.

inherited
since

2.0.0

Type(s)

string[]

application

The application running this command.

inherited
since

2.0.0

Type(s)

\Joomla\Console\Application|null

applicationDefinitionMerged

Flag tracking whether the application definition has been merged to this command.

inherited
since

2.0.0

Type(s)

bool

applicationDefinitionMergedWithArgs

Flag tracking whether the application definition with arguments has been merged to this command.

inherited
since

2.0.0

Type(s)

bool

definition

The command's input definition.

inherited
since

2.0.0

Type(s)

\Symfony\Component\Console\Input\InputDefinition

description

The command's description.

inherited
since

2.0.0

Type(s)

string

help

The command's help.

inherited
since

2.0.0

Type(s)

string

helperSet

The command's input helper set.

inherited
since

2.0.0

Type(s)

\Symfony\Component\Console\Helper\HelperSet|null

hidden

Flag tracking whether the command is hidden from the command listing.

inherited
since

2.0.0

Type(s)

bool

name

The command's name.

inherited
since

2.0.0

Type(s)

string

synopsis

The command's synopses.

inherited
since

2.0.0

Type(s)

string[]
  • \ Joomla
  • \ Console
  • \ Command
  • \ HelpCommand