UserCollectionInterface
extends
Countable
in
Table of Contents
Methods
- delete() : bool
- Delete user account.
- find() : UserInterface
- Find a user by username, email, etc
- load() : UserInterface
- Load user account.
Methods
delete()
Delete user account.
public
delete(string $username) : bool
Parameters
- $username : string
Return values
bool —True if user account was found and was deleted.
find()
Find a user by username, email, etc
public
find(string $query[, array<string|int, mixed> $fields = ['username', 'email'] ]) : UserInterface
Parameters
- $query : string
-
the query to search for
- $fields : array<string|int, mixed> = ['username', 'email']
-
the fields to search
Return values
UserInterfaceload()
Load user account.
public
load(string $username) : UserInterface
Always creates user object. To check if user exists, use $this->exists().
Parameters
- $username : string