Module

Base class for console command modules.

class Module

A module groups related console commands, defines metadata and shared options, and coordinates command preparation/execution using parsed input and output helpers.

Properties

app

Console application instance that owns this module.

protected Application $app

options

Global options available to all commands within this module.

protected array $options

name

Module identifier used in command routing.

private string $name

description

Human-readable module description.

private string $description

commands

Command definitions keyed by command name.

private array $commands

input

Parsed command-line input for the active execution.

private Input $input

output

Output writer used for command responses.

private Output $output

Methods

initialise

public initialise(Application $app, Input $input, Output $output): void

Parameters

Parameter	Type	Description
$app	Application
$input	Input
$output	Output

depends

public depends(string $modules): self

Parameters

Parameter	Type	Description
$modules	string

setName

Sets the module name.

public setName(string $name): self

Parameters

Parameter	Type	Description
$name	string	module identifier

getName

Gets the configured module name.

public getName(): ?string

setDescription

Sets the module description.

public setDescription(string $description): self

Parameters

Parameter	Type	Description
$description	string	human-readable module description

getDescription

Gets the configured module description.

public getDescription(): ?string

getCommands

public getCommands(): void

getCommand

Gets a command definition by name.

public getCommand(string $name): ?Command

Parameters

Parameter	Type	Description
$name	string	command identifier

run

Executes a registered command within this module.

public run(string $command): int

Parses command input, runs module preparation, and invokes the command callback when available.

Parameters

Parameter	Type	Description
$command	string	command name to execute

addOption

Adds a global option available to all commands.

public addOption(string $long, ?string $short, ?string $description, ?bool $takesValue, mixed $default, ?string $valueType): self

Parameters

Parameter	Type	Description
$long	string	long option name
$short	string	optional short option alias
$description	string	optional option description
$takesValue	bool	whether the option accepts a value
$default	mixed	default value for the option
$valueType	string	optional expected value type

prepare

Performs module-specific pre-execution checks.

protected prepare(Input $input, Output $output): int

Return a value greater than zero to abort command execution and return that exit code.

Parameters

Parameter	Type	Description
$input	Input	parsed command input
$output	Output	output writer

addCommand

Registers a command with this module.

protected addCommand(string $name, ?array $callback): Command

Parameters

Parameter	Type	Description
$name	string	command name
$callback	array

configure

Configures module metadata, options, and commands.

protected configure(): void

Implement in subclasses to register commands and definitions.

---

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