WARNING: API IN FLUX.
More...
WARNING: API IN FLUX.
DO NOT USE DIRECTLY.
Definition at line 22 of file UsersTable.php.
Elgg\Database\UsersTable::findActive |
( |
array |
$options = [] | ) |
|
Return users (or the number of them) who have been active within a recent period.
- Parameters
-
array | $options | Array of options with keys: |
seconds (int) => Length of period (default 600 = 10min) limit (int) => Limit (default 10) offset (int) => Offset (default 0) count (bool) => Return a count instead of users? (default false)
- Returns
- []|int
Definition at line 130 of file UsersTable.php.
Elgg\Database\UsersTable::generateInviteCode |
( |
|
$username | ) |
|
Generates a unique invite code for a user.
- Parameters
-
string | $username | The username of the user sending the invitation |
- Returns
- string Invite code
- See also
- validateInviteCode
Definition at line 197 of file UsersTable.php.
Elgg\Database\UsersTable::getByEmail |
( |
|
$email | ) |
|
Get an array of users from an email address.
- Parameters
-
string | $email | Email address |
- Returns
- []
Definition at line 98 of file UsersTable.php.
Elgg\Database\UsersTable::getByUsername |
( |
|
$username | ) |
|
Get user by username.
- Parameters
-
string | $username | The user's username |
- Returns
- ElggUser|false Depending on success
Definition at line 61 of file UsersTable.php.
Elgg\Database\UsersTable::register |
( |
|
$username, |
|
|
|
$password, |
|
|
|
$name, |
|
|
|
$email, |
|
|
|
$allow_multiple_emails = false , |
|
|
|
$subtype = null |
|
) |
| |
Registers a user, returning false if the username already exists.
- Parameters
-
string | $username | The username of the new user |
string | $password | The password |
string | $name | The user's display name |
string | $email | The user's email address |
bool | $allow_multiple_emails | Allow the same email address to be registered multiple times? |
string | $subtype | Subtype of the user entity |
- Returns
- int|false The new user's GUID; false on failure
- Exceptions
-
Definition at line 185 of file UsersTable.php.
Elgg\Database\UsersTable::validateInviteCode |
( |
|
$username, |
|
|
|
$code |
|
) |
| |
Validate a user's invite code.
- Parameters
-
string | $username | The username |
string | $code | The invite code |
- Returns
- bool
- See also
- generateInviteCode
Definition at line 211 of file UsersTable.php.
Elgg\Database\UsersTable::$config |
|
protected |
Elgg\Database\UsersTable::$db |
|
protected |
Elgg\Database\UsersTable::$metadata |
|
protected |
The documentation for this class was generated from the following file: