CommandInterface
in
Console command interface
Tags
Table of Contents
Methods
- __toString() : string
- Render the command as its name and params
- getHelp() : string|null
- Get the command help
- getName() : string|null
- Get the command name
- getParams() : string|null
- Get the command params
- getScriptName() : string|null
- Get the script name the command was registered under
- hasHelp() : bool
- Determine if the command has help
- hasName() : bool
- Determine if the command has name
- hasParams() : bool
- Determine if the command has params
- hasScriptName() : bool
- Determine if the command has a script name
- setHelp() : static
- Set the command help
- setName() : static
- Set the command name
- setParams() : static
- Set the command params
- setScriptName() : static
- Set the script name the command was registered under
Methods
__toString()
Render the command as its name and params
public
__toString() : string
Return values
stringgetHelp()
Get the command help
public
getHelp() : string|null
Return values
string|nullgetName()
Get the command name
public
getName() : string|null
Return values
string|nullgetParams()
Get the command params
public
getParams() : string|null
Return values
string|nullgetScriptName()
Get the script name the command was registered under
public
getScriptName() : string|null
Return values
string|nullhasHelp()
Determine if the command has help
public
hasHelp() : bool
Return values
boolhasName()
Determine if the command has name
public
hasName() : bool
Return values
boolhasParams()
Determine if the command has params
public
hasParams() : bool
Return values
boolhasScriptName()
Determine if the command has a script name
public
hasScriptName() : bool
Return values
boolsetHelp()
Set the command help
public
setHelp(string $help) : static
Parameters
- $help : string
Return values
staticsetName()
Set the command name
public
setName(string $name) : static
Parameters
- $name : string
Return values
staticsetParams()
Set the command params
public
setParams(string $params) : static
Parameters
- $params : string
Return values
staticsetScriptName()
Set the script name the command was registered under
public
setScriptName(string $scriptName) : static
Parameters
- $scriptName : string