1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Core
  7. \
  8. Console
  9. \
  10. Input

Input

class Input

Class Input

Properties

protected string $binary
protected string $vendor
protected string $module
protected string $command
protected array $arguments
protected array $options

Methods

__construct(array $args)

Input constructor.

void
applyCommand(string $command)

No description

void
applyCommandDefinition(CommandDefinition $commandDefinition)

No description

array|bool|mixed|string
askQuestion($question, bool $answers = false, bool $case_sensitive = false, bool $answer_default = false)

TODO rewrite user input code

string|null
getArgument(string $name, string|null $default = null)

No description

int
getArgumentCount()

No description

array
getArguments()

No description

string
getBinaryName()

No description

string|null
getCommand()

No description

array
getCommandArray()

No description

string|null
getModuleName()

No description

string|null
getOption(string $name, string|null $default = null)

No description

array
getOptions()

No description

string|null
getVendorName()

No description

int
getVerbosity()

No description

bool
hasArgument(string $name)

No description

bool
hasCommand()

No description

bool
hasModuleName()

No description

bool
hasOption(string $name)

No description

bool
hasVendorName()

No description

bool
isAskingForHelp()

No description

bool
isInteractive()

No description

bool
isVerbose()

No description

void
parseArguments(array $args)

No description

void
parseOption(string $option, string|null $value = null)

No description

Input
withCommand(string $command, array $arguments = [], array $options = [])

Returns a new instance of Input with the given command.

Details

at line 40
__construct(array $args)

Input constructor.

Parameters

array $args

at line 64
protected void applyCommand(string $command)

No description

Parameters

string $command

Return Value

void

at line 151
void applyCommandDefinition(CommandDefinition $commandDefinition)

No description

Parameters

CommandDefinition $commandDefinition

Return Value

void

at line 393
array|bool|mixed|string askQuestion($question, bool $answers = false, bool $case_sensitive = false, bool $answer_default = false)

TODO rewrite user input code

Parameters

$question
bool $answers
bool $case_sensitive
bool $answer_default

Return Value

array|bool|mixed|string

at line 294
string|null getArgument(string $name, string|null $default = null)

No description

Parameters

string $name
string|null $default

Return Value

string|null

at line 308
int getArgumentCount()

No description

Return Value

int

at line 301
array getArguments()

No description

Return Value

array

at line 226
string getBinaryName()

No description

Return Value

string

at line 240
string|null getCommand()

No description

Return Value

string|null

at line 247
array getCommandArray()

No description

Return Value

array

at line 275
string|null getModuleName()

No description

Return Value

string|null

at line 327
string|null getOption(string $name, string|null $default = null)

No description

Parameters

string $name
string|null $default

Return Value

string|null

at line 334
array getOptions()

No description

Return Value

array

at line 261
string|null getVendorName()

No description

Return Value

string|null

at line 355
int getVerbosity()

No description

Return Value

int

at line 284
bool hasArgument(string $name)

No description

Parameters

string $name

Return Value

bool

at line 233
bool hasCommand()

No description

Return Value

bool

at line 268
bool hasModuleName()

No description

Return Value

bool

at line 317
bool hasOption(string $name)

No description

Parameters

string $name

Return Value

bool

at line 254
bool hasVendorName()

No description

Return Value

bool

at line 348
bool isAskingForHelp()

No description

Return Value

bool

at line 341
bool isInteractive()

No description

Return Value

bool

at line 379
bool isVerbose()

No description

Return Value

bool

at line 79
protected void parseArguments(array $args)

No description

Parameters

array $args

Return Value

void

at line 111
protected void parseOption(string $option, string|null $value = null)

No description

Parameters

string $option
string|null $value

Return Value

void

at line 203
Input withCommand(string $command, array $arguments = [], array $options = [])

Returns a new instance of Input with the given command.

Parameters

string $command
array $arguments
array $options

Return Value

Input