DBITable

Users stored in a database table.

class DBITable implements \Hazaar\Auth\Interface\UserProvider , \Hazaar\Auth\Interface\PasswordStore , \Hazaar\Auth\Interface\UserManager

Implements: Hazaar\Auth\Interface\UserProvider, Hazaar\Auth\Interface\PasswordStore, Hazaar\Auth\Interface\UserManager

The table needs an identity column and a password column (named by fields). The database connection is only opened when a user is first looked up.

Properties

options

private Options $options

Type: Hazaar\Auth\Provider\DBITable\Options

table

public Table $table

Type: Hazaar\DBI\Table

dbi

the database to use, instead of the one in $options->dbi

private DBIAdapter $dbi

Type: Hazaar\DBI\Adapter

Methods

__construct

public __construct(array|Options $options, DBIAdapter $dbi): void

Parameters

Parameter	Type	Description
$options	array	Hazaar\Auth\Provider\DBITable\Options
$dbi	Hazaar\DBI\Adapter	the database to use, instead of the one in $options->dbi

findByIdentity

public findByIdentity(string $identity): ?Identity

Returns: Hazaar\Auth\Identity

Parameters

Parameter	Type	Description
$identity	string

getPasswordHash

public getPasswordHash(string $identity): ?string

Returns: string

Parameters

Parameter	Type	Description
$identity	string

setPasswordHash

public setPasswordHash(string $identity, string $hash): bool

Returns: bool

Parameters

Parameter	Type	Description
$identity	string
$hash	string

createUser

public createUser(string $identity, ?string $passwordHash, array $data): bool

Returns: bool

Parameters

Parameter	Type	Description
$identity	string
$passwordHash	string
$data	array

deleteUser

public deleteUser(string $identity): bool

Returns: bool

Parameters

Parameter	Type	Description
$identity	string

find

private find(string $identity): ?array

Returns: array

Parameters

Parameter	Type	Description
$identity	string

table

private table(): Table

Returns: Hazaar\DBI\Table

---

Generated by Hazaar API Doc Generator on Wed, 28 Oct 2026 08:43:30 +0000