Users helper service.
More...
Users helper service.
Definition at line 16 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 126 of file UsersTable.php.
Elgg\Database\UsersTable::generateInviteCode |
( |
string |
$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
- self::validateInviteCode()
Definition at line 175 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 94 of file UsersTable.php.
Elgg\Database\UsersTable::getByUsername |
( |
|
$username | ) |
|
Get user by username.
- Parameters
-
string | $username | The user's username |
- Returns
- |false Depending on success
Definition at line 55 of file UsersTable.php.
Elgg\Database\UsersTable::validateInviteCode |
( |
string |
$username, |
|
|
string |
$code |
|
) |
| |
Validate a user's invite code.
- Parameters
-
string | $username | The username |
string | $code | The invite code |
- Returns
- bool
- See also
- self::generateInviteCode()
Definition at line 191 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: