Constants
|
public
Symfony\Component\Console\Command\Command
::FAILURE
=
1
|
public
Symfony\Component\Console\Command\Command
::INVALID
=
2
|
public
Symfony\Component\Console\Command\Command
::SUCCESS
=
0
|
Methods
|
public
__construct
(
array
$completionOutputs
=
[
]
)
-
param
string
|
null
$name
The name of the command; passing null means it must be set in configure()
-
throws
LogicException
When the command name is empty
|
public
Symfony\Component\Console\Command\Command
::
addArgument
(
string
$name
,
?
int
$mode
=
NULL
,
string
$description
=
''
,
?
mixed
$default
=
NULL
) :
static
-
param
$mode
The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
-
param
$default
The default value (for InputArgument::OPTIONAL mode only)
-
throws
InvalidArgumentException
When argument mode is not valid
-
return
$this
|
public
Symfony\Component\Console\Command\Command
::
addOption
(
string
$name
,
array
|
string
|
null
$shortcut
=
NULL
,
?
int
$mode
=
NULL
,
string
$description
=
''
,
?
mixed
$default
=
NULL
) :
static
-
param
$shortcut
The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
-
param
$mode
The option mode: One of the InputOption::VALUE_* constants
-
param
$default
The default value (must be null for InputOption::VALUE_NONE)
-
throws
InvalidArgumentException
If option mode is invalid or incompatible
-
return
$this
|
public
Symfony\Component\Console\Command\Command
::
addUsage
(
string
$usage
) :
static
Add a command usage example, it'll be prefixed with the command name.
|
public
Symfony\Component\Console\Command\Command
::
complete
(
Symfony\Component\Console\Completion\CompletionInput
$input
,
Symfony\Component\Console\Completion\CompletionSuggestions
$suggestions
) :
void
Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
|
public
Symfony\Component\Console\Command\Command
::
getAliases
() :
array
Returns the aliases for the command.
|
public
Symfony\Component\Console\Command\Command
::
getApplication
() : ?
Symfony\Component\Console\Application
Gets the application instance for this command.
|
public
static
Symfony\Component\Console\Command\Command
::
getDefaultDescription
() : ?
string
|
public
static
Symfony\Component\Console\Command\Command
::
getDefaultName
() : ?
string
|
public
Symfony\Component\Console\Command\Command
::
getDefinition
() :
Symfony\Component\Console\Input\InputDefinition
Gets the InputDefinition attached to this Command.
|
public
Symfony\Component\Console\Command\Command
::
getDescription
() :
string
Returns the description for the command.
|
public
Symfony\Component\Console\Command\Command
::
getHelp
() :
string
Returns the help for the command.
|
public
Symfony\Component\Console\Command\Command
::
getHelper
(
string
$name
) : ?
mixed
Gets a helper instance by name.
-
throws
LogicException
if no HelperSet is defined
-
throws
InvalidArgumentException
if the helper is not defined
|
public
Symfony\Component\Console\Command\Command
::
getHelperSet
() : ?
Symfony\Component\Console\Helper\HelperSet
|
public
Symfony\Component\Console\Command\Command
::
getName
() : ?
string
Returns the command name.
|
public
Symfony\Component\Console\Command\Command
::
getNativeDefinition
() :
Symfony\Component\Console\Input\InputDefinition
Gets the InputDefinition to be used to create representations of this Command.
Can be overridden to provide the original command representation when it would otherwise
be changed by merging with the application InputDefinition.
This method is not part of public API and should not be used directly.
|
public
Symfony\Component\Console\Command\Command
::
getProcessedHelp
() :
string
Returns the processed help for the command replacing the %command.name% and
%command.full_name% patterns with the real values dynamically.
|
public
Symfony\Component\Console\Command\Command
::
getSynopsis
(
bool
$short
=
false
) :
string
Returns the synopsis for the command.
-
param
bool
$short
Whether to show the short version of the synopsis (with options folded) or not
|
public
Symfony\Component\Console\Command\Command
::
getUsages
() :
array
Returns alternative usages of the command.
|
public
Symfony\Component\Console\Command\Command
::
ignoreValidationErrors
()
Ignores validation errors.
This is mainly useful for the help command.
|
public
Symfony\Component\Console\Command\Command
::
isEnabled
()
Checks whether the command is enabled or not in the current environment.
Override this to check for x or y and return false if the command cannot
run properly under the current conditions.
|
public
Symfony\Component\Console\Command\Command
::
isHidden
() :
bool
-
return
bool
whether the command should be publicly shown or not
|
public
Symfony\Component\Console\Command\Command
::
mergeApplicationDefinition
(
bool
$mergeArgs
=
true
)
Merges the application definition with the command definition.
This method is not part of public API and should not be used directly.
-
param
bool
$mergeArgs
Whether to merge or not the Application definition arguments to Command definition arguments
-
internal
|
public
Symfony\Component\Console\Command\Command
::
run
(
Symfony\Component\Console\Input\InputInterface
$input
,
Symfony\Component\Console\Output\OutputInterface
$output
) :
int
The code to execute is either defined directly with the
setCode() method or by overriding the execute() method
in a sub-class.
-
return
int
The command exit code
-
throws
ExceptionInterface
When input binding fails. Bypass this by calling {@link ignoreValidationErrors()}.
-
see
\setCode()
-
see
\execute()
|
public
Symfony\Component\Console\Command\Command
::
setAliases
(
iterable
$aliases
) :
static
Sets the aliases for the command.
-
param
string
[]
$aliases
An array of aliases for the command
-
return
$this
-
throws
InvalidArgumentException
When an alias is invalid
|
public
Symfony\Component\Console\Command\Command
::
setApplication
(
?
Symfony\Component\Console\Application
$application
=
NULL
) |
public
Symfony\Component\Console\Command\Command
::
setCode
(
callable
$code
) :
static
Sets the code to execute when running this command.
If this method is used, it overrides the code defined
in the execute() method.
-
param
callable
$code
A callable(InputInterface $input, OutputInterface $output)
-
return
$this
-
throws
InvalidArgumentException
-
see
\execute()
|
public
Symfony\Component\Console\Command\Command
::
setDefinition
(
Symfony\Component\Console\Input\InputDefinition
|
array
$definition
) :
static
Sets an array of argument and option instances.
|
public
Symfony\Component\Console\Command\Command
::
setDescription
(
string
$description
) :
static
Sets the description for the command.
|
public
Symfony\Component\Console\Command\Command
::
setHelp
(
string
$help
) :
static
Sets the help for the command.
|
public
Symfony\Component\Console\Command\Command
::
setHelperSet
(
Symfony\Component\Console\Helper\HelperSet
$helperSet
) |
public
Symfony\Component\Console\Command\Command
::
setHidden
(
bool
$hidden
=
true
) :
static
-
param
bool
$hidden
Whether or not the command should be hidden from the list of commands
-
return
$this
|
public
Symfony\Component\Console\Command\Command
::
setName
(
string
$name
) :
static
Sets the name of the command.
This method can set both the namespace and the name if
you separate them by a colon (:)
$command->setName('foo:bar');
-
return
$this
-
throws
InvalidArgumentException
When the name is invalid
|
public
Symfony\Component\Console\Command\Command
::
setProcessTitle
(
string
$title
) :
static
Sets the process title of the command.
This feature should be used only when creating a long process command,
like a daemon.
|