UserModule

About 1 min

Console commands for managing the Warlock server process.

class UserModule extends \Hazaar\Console\Module

Extends: Hazaar\Console\Module

Properties

private Basic $authenticator

Type: Hazaar\Warlock\Server\Auth\Basic

Registers server CLI commands and options.

public configure(): void

Returns: void

Adds a user to the authentication database.

public addUser(Input $input, Output $output): int

Returns: int

Prompts for missing username or password input when not provided via CLI.

Parameter	Type	Description
`$input`	Hazaar\Console\Input	Console input containing username argument and password option
`$output`	Hazaar\Console\Output	Console output used to display status messages

Removes a user from the authentication database.

public removeUser(Input $input, Output $output): int

Returns: int

Prompts for confirmation unless the --yes/-y option is provided.

Parameter	Type	Description
`$input`	Hazaar\Console\Input	Console input containing username argument and options
`$output`	Hazaar\Console\Output	Console output used to display status messages

Lists all users currently stored in the authentication database.

public listUsers(Input $input, Output $output): int

Returns: int

Parameter	Type	Description
`$input`	Hazaar\Console\Input	Console input (unused)
`$output`	Hazaar\Console\Output	Console output used to display users

Tests whether the provided credentials can authenticate.

public testCanAuthenticate(Input $input, Output $output): int

Returns: int

Parameter	Type	Description
`$input`	Hazaar\Console\Input	Console input containing username and password arguments
`$output`	Hazaar\Console\Output	Console output used to display the authentication result

Prepares the module by initializing the authenticator with the specified database file.

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

Returns: int

Parameter	Type	Description
`$input`	Hazaar\Console\Input
`$output`	Hazaar\Console\Output

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:18 +0000