Basic

class Basic implements \Hazaar\Warlock\Server\Interface\Authenticator

Implements: Hazaar\Warlock\Server\Interface\Authenticator

Properties

authDB

private BTree $authDB

Type: Hazaar\Util\BTree

Methods

__construct

Basic constructor.

public __construct(string $dbFile, bool $createDatabase): void

Parameters

Parameter	Type	Description
$dbFile	string	the path to the authentication database file (BTree format)
$createDatabase	bool

authenticate

Authenticate a client using the provided username and password.

public authenticate(string $username, string $password, ?Client $client): bool

Returns: bool

Parameters

Parameter	Type	Description
$username	string	the username provided by the client
$password	string	the password provided by the client
$client	Hazaar\Warlock\Server\Client

exists

Check whether a user exists in the authentication database.

public exists(string $username): bool

Returns: bool

Parameters

Parameter	Type	Description
$username	string	the username to look up

addUser

public addUser(string $username, string $password): bool

Returns: bool

Parameters

Parameter	Type	Description
$username	string
$password	string

removeUser

public removeUser(string $username): bool

Returns: bool

Parameters

Parameter	Type	Description
$username	string

listUsers

public listUsers(): array

Returns: array

---

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