Option

Less than 1 minute

Properties

The long name of the option. Must start with a letter and contain only alphanumeric characters, dashes, or underscores.

public string $long

The short, single-character name of the option, or null if not used. Must be a single letter.

public string $short

A description of what the option does

public string $description

Whether this option accepts a value

public bool $takesValue

The default value if the option is not provided and takesValue is true

public mixed $default

Whether this option is mandatory

public bool $required

The expected type of the value (e.g., 'int', 'string'), if applicable.

public string $valueType

Constructor for the Option class.

public __construct(string $long, string $short, string $description, bool $takesValue, mixed $default, bool $required, string $valueType): void

Parameter	Type	Description
`$long`	`string`	The long name of the option. Must start with a letter and contain only alphanumeric characters, dashes, or underscores.
`$short`	`string`	The short, single-character name of the option, or null if not used. Must be a single letter.
`$description`	`string`	A description of what the option does
`$takesValue`	`bool`	Whether this option accepts a value
`$default`	`mixed`	The default value if the option is not provided and takesValue is true
`$required`	`bool`	Whether this option is mandatory
`$valueType`	`string`	The expected type of the value (e.g., 'int', 'string'), if applicable.

Generated by Hazaar API Doc Generator on Sun, 01 Mar 2026 09:22:27 +0000