Input

Less than 1 minute

Properties

private string $executable

private array $argv

private array $args

private array $globalOptions

private array $options

public string $module

public string $command

public Command $commandObject

Initialises the input object with the command line arguments.

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

Parameter	Type	Description
`$argv`	`array`
`$moduleNames`	`array`

public run(Command $command): void

Parameter	Type	Description
`$command`	`Command`

public getExecutable(): string

public getGlobalOption(string $name): mixed

Parameter	Type	Description
`$name`	`string`

public getModule(): ?string

public getCommandObject(): ?Command

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

public getCommand(): ?string

public getArgument(string $name): ?string

Parameter	Type	Description
`$name`	`string`

Gets all the arguments that were passed to the command.

public getArguments(): void

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

Parameter	Type	Description
`$name`	`string`
`$default`	`string`

Gets the options that were set on the command line.

public getOptions(): void

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

Parameter	Type	Description
`$name`	`string`
`$value`	`mixed`

Gets the options that were used on the command line.

public getArgv(): void

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

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

Generated by Hazaar API Doc Generator on Wed, 07 Jan 2026 11:30:00 +0000