Command

Console command definition and metadata container.

class Command

Represents a single executable command with its callback target, argument definitions, option definitions, and descriptive metadata used by console help and command dispatch logic.

Properties

globalOptions

public array $globalOptions

application

Owning console application instance.

protected Application $application

name

Command identifier used on the CLI.

private string $name

description

Human-readable command description.

private string $description

options

private array $options

arguments

private array $arguments

callback

Command callback target.

private mixed $callback

Methods

__construct

public __construct(string $name, array $callback): void

Parameters

Parameter	Type	Description
$name	string
$callback	array

getCallable

public getCallable(): void

getName

Returns the command name.

public getName(): string

getDescription

Returns the command description.

public getDescription(): string

getOptions

public getOptions(): void

getArguments

public getArguments(): void

setName

Sets the command name.

public setName(string $name): self

Parameters

Parameter	Type	Description
$name	string	command identifier

setDescription

Sets the command description.

public setDescription(string $description): self

Parameters

Parameter	Type	Description
$description	string	human-readable description text

setHelp

Sets extended help text for the command.

public setHelp(string $help): self

This method is currently a no-op and returns the command unchanged.

Parameters

Parameter	Type	Description
$help	string	extended help text

addOption

Adds an option definition to the command.

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

Parameters

Parameter	Type	Description
$long	string	long option name without leading dashes
$short	string	optional short option alias
$description	string	optional option description
$takesValue	bool	whether the option expects a value
$default	mixed	default value used when omitted
$valueType	string	optional expected value type

addArgument

Adds a positional argument definition to the command.

public addArgument(string $name, ?string $description, bool $required): self

Parameters

Parameter	Type	Description
$name	string	argument name
$description	string	optional argument description
$required	bool	whether the argument is required

findOption

Finds an option by long or short name.

public findOption(string $name): ?Option

Parameters

Parameter	Type	Description
$name	string	long or short option identifier

---

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