Command
in package
Console command class
Tags
Table of Contents
- $help : string
- Command help
- $name : string
- Command name
- $params : string
- Command params
- __construct() : Command
- Instantiate the command object
- __toString() : string
- Return the command name as string
- getHelp() : string
- Get the command help
- getName() : string
- Get the command name
- getParams() : string
- Get the command params
- hasHelp() : bool
- Determine if the command has help
- hasParams() : bool
- Determine if the command has params
- setHelp() : Command
- Set the command help
- setName() : Command
- Set the command name
- setParams() : Command
- Set the command params
Properties
$help
Command help
protected
string
$help
= null
$name
Command name
protected
string
$name
= null
$params
Command params
protected
string
$params
= null
Methods
__construct()
Instantiate the command object
public
__construct(string $name[, string $params = null ][, string $help = null ]) : Command
Parameters
- $name : string
- $params : string = null
- $help : string = null
Return values
Command —__toString()
Return the command name as string
public
__toString() : string
Return values
string —getHelp()
Get the command help
public
getHelp() : string
Return values
string —getName()
Get the command name
public
getName() : string
Return values
string —getParams()
Get the command params
public
getParams() : string
Return values
string —hasHelp()
Determine if the command has help
public
hasHelp() : bool
Return values
bool —hasParams()
Determine if the command has params
public
hasParams() : bool
Return values
bool —setHelp()
Set the command help
public
setHelp(string $help) : Command
Parameters
- $help : string
Return values
Command —setName()
Set the command name
public
setName(string $name) : Command
Parameters
- $name : string
Return values
Command —setParams()
Set the command params
public
setParams(string $params) : Command
Parameters
- $params : string