Input

Console input parser and execution context holder.

class Input

Parses CLI argv tokens into module/command selection, global options, command-specific options, and positional arguments used during command execution.

Properties

executable

Executable basename used in usage/help messages.

private string $executable

Type: string

argv

private array $argv

Type: array

args

private array $args

Type: array

globalOptions

private array $globalOptions

Type: array

options

private array $options

Type: array

module

public string $module

Type: string

command

public string $command

Type: string

commandObject

public Command $commandObject

Type: Hazaar\Console\Command

Methods

initialise

Initialises the input object with the command line arguments.

public initialise(array $argv, array $moduleNames): bool

Returns: bool

Parameters

Parameter	Type	Description
$argv	array
$moduleNames	array

run

Binds a command definition and parses argv into option/argument values.

public run(Command $command, array $moduleOptions): void

Returns: void

Parameters

Parameter	Type	Description
$command	Hazaar\Console\Command	command definition to parse against
$moduleOptions	array	options defined at the module level

getExecutable

public getExecutable(): string

Returns: string

getGlobalOption

public getGlobalOption(string $name): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$name	string

getModule

public getModule(): ?string

Returns: string

getCommandObject

public getCommandObject(): ?Command

Returns: Hazaar\Console\Command

getCommand

Gets the command that was used on the command line if it exists.

public getCommand(): ?string

Returns: string

getArgument

public getArgument(string $name): ?string

Returns: string

Parameters

Parameter	Type	Description
$name	string

getArguments

Gets all the arguments that were passed to the command.

public getArguments(): array

Returns: array

getOption

public getOption(string $name, ?string $default): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$name	string
$default	string

getOptions

Gets the options that were set on the command line.

public getOptions(): array

Returns: array

setOption

public setOption(string $name, mixed $value): void

Returns: void

Parameters

Parameter	Type	Description
$name	string
$value	mixed

getArgv

Gets the options that were used on the command line.

public getArgv(): array

Returns: array

readline

Displays a prompt and reads a line of input from STDIN.

public readline(string $prompt): string

Returns: string

Parameters

Parameter	Type	Description
$prompt	string	the prompt to display to the user

parseOption

Parses a command line option and adds it to the options array.

private parseOption(array $argv, array $optionsDefinition, array $options): bool

Returns: bool

Parameters

Parameter	Type	Description
$argv	array
$optionsDefinition	array
$options	array

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:18 +0000