Command
class Command (View source)
Represents a command
Properties
| protected string | $controllerClassName | ||
| protected string | $controllerCommandName | ||
| protected string | $commandIdentifier | ||
| protected MethodReflection | $commandMethodReflection | ||
| protected ReflectionService | $reflectionService | ||
| protected ObjectManagerInterface | $objectManager |
Methods
Constructor
No description
No description
Returns the command identifier for this command
Returns a short description of this command
Returns a longer description of this command This is the complete method description except for the first line which can be retrieved via getShortDescription() If The command description only consists of one line, an empty string is returned
Returns true if this command expects required and/or optional arguments, otherwise false
Returns an array of CommandArgumentDefinition that contains information about required/optional arguments of this command.
Tells if this command is internal and thus should not be exposed through help texts, user documentation etc.
Tells if this command is deprecated and thus should be marked as such in help texts, user documentation etc.
Tells if this command flushes all caches and thus needs special attention in the interactive shell.
Returns an array of command identifiers which were specified in the "@see" annotation of a command method.
No description
Details
__construct(string $controllerClassName, string $controllerCommandName)
Constructor
injectReflectionService(ReflectionService $reflectionService)
No description
injectObjectManager(ObjectManagerInterface $objectManager)
No description
string
getControllerClassName()
No description
string
getControllerCommandName()
No description
string
getCommandIdentifier()
Returns the command identifier for this command
string
getShortDescription()
Returns a short description of this command
string
getDescription()
Returns a longer description of this command This is the complete method description except for the first line which can be retrieved via getShortDescription() If The command description only consists of one line, an empty string is returned
bool
hasArguments()
Returns true if this command expects required and/or optional arguments, otherwise false
array
getArgumentDefinitions()
Returns an array of CommandArgumentDefinition that contains information about required/optional arguments of this command.
If the command does not expect any arguments, an empty array is returned
bool
isInternal()
Tells if this command is internal and thus should not be exposed through help texts, user documentation etc.
Internal commands are still accessible through the regular command line interface, but should not be used by users.
bool
isDeprecated()
Tells if this command is deprecated and thus should be marked as such in help texts, user documentation etc.
Deprecated commands are still accessible through the regular command line interface, but should not be used by users anymore.
bool
isFlushingCaches()
Tells if this command flushes all caches and thus needs special attention in the interactive shell.
Note that neither this method nor the @Flow\FlushesCaches annotation is currently part of the official API.
array
getRelatedCommandIdentifiers()
Returns an array of command identifiers which were specified in the "@see" annotation of a command method.
protected MethodReflection
getCommandMethodReflection()
No description