Documentation

Command

Table of Contents

$description  : string
Description of the command.
$flags  : array<string|int, mixed>
Accpet flag parameter in command.
$hidden  : bool
Should the command hidden form list.
$sign  : string
Sign of the command.
__construct()  : void
Create a new command instance.
ask()  : void
Prompt user for input.
getDescription()  : string
Get description.
getFlags()  : array<string|int, mixed>
Get flags.
getHidden()  : string
Get hidden.
getSign()  : string
Get sign.
handle()  : void
Function to handle the class.
terminate()  : void
Terminate the console.
write()  : void
Function to handle the class.

Properties

$description

Description of the command.

protected string $description
Tags
since
1.0.0

$flags

Accpet flag parameter in command.

protected array<string|int, mixed> $flags = []
Tags
since
1.0.0

$hidden

Should the command hidden form list.

protected bool $hidden = false
Tags
since
1.0.0

$sign

Sign of the command.

protected string $sign
Tags
since
1.0.0

Methods

__construct()

Create a new command instance.

public __construct() : void
Return values
void

ask()

Prompt user for input.

public ask(string $str) : void
Parameters
$str : string
Return values
void

getDescription()

Get description.

public getDescription() : string
Return values
string

getFlags()

Get flags.

public getFlags() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHidden()

Get hidden.

public getHidden() : string
Return values
string

getSign()

Get sign.

public getSign() : string
Return values
string

handle()

Function to handle the class.

public abstract handle(Output $output, Input $input[, mixed $prams = [] ]) : void
Parameters
$output : Output
$input : Input
$prams : mixed = []
Return values
void

terminate()

Terminate the console.

public terminate() : void
Return values
void

write()

Function to handle the class.

public write(string $str[, bool $newLine = true ]) : void
Parameters
$str : string
$newLine : bool = true
Return values
void

Search results