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

argv

private array $argv

args

private array $args

globalOptions

private array $globalOptions

options

private array $options

module

public string $module

command

public string $command

commandObject

public Command $commandObject

Methods

initialise

Initialises the input object with the command line arguments.

public initialise(array $argv, array $moduleNames): 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

Parameters

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

getExecutable

public getExecutable(): string

getGlobalOption

public getGlobalOption(string $name): mixed

Parameters

Parameter	Type	Description
$name	string

getModule

public getModule(): ?string

getCommandObject

public getCommandObject(): ?Command

getCommand

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

public getCommand(): ?string

getArgument

public getArgument(string $name): ?string

Parameters

Parameter	Type	Description
$name	string

getArguments

Gets all the arguments that were passed to the command.

public getArguments(): void

getOption

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

Parameters

Parameter	Type	Description
$name	string
$default	string

getOptions

Gets the options that were set on the command line.

public getOptions(): void

setOption

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

Parameters

Parameter	Type	Description
$name	string
$value	mixed

getArgv

Gets the options that were used on the command line.

public getArgv(): void

parseOption

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

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

Parameters

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

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:25 +0000