UserModule

Less than 1 minute

Console commands for managing the Warlock server process.

class UserModule extends \Hazaar\Warlock\Console\Module

Properties

private Basic $authenticator

Registers server CLI commands and options.

public configure(): void

Adds a user to the authentication database.

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

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

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

Removes a user from the authentication database.

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

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

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

Lists all users currently stored in the authentication database.

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

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

Tests whether the provided credentials can authenticate.

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

Parameter	Type	Description
`$input`	`Input`	Console input containing username and password arguments
`$output`	`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

Parameter	Type	Description
`$input`	`Input`
`$output`	`Output`

Generated by Hazaar API Doc Generator on Fri, 05 Jun 2026 06:08:15 +0000