Property | Type | Description | |
---|---|---|---|
$config | |||
$db | |||
$entities | |||
$entity_cache | |||
$events | |||
$table | string |
Method | Description | |
---|---|---|
__construct ( |
Constructor | |
ban ( integer $user_guid, string $reason = "" ) : boolean | Ban a user (calls events, stores the reason) | |
disableEntities ( integer $owner_guid ) : boolean | Disables all of a user's entities | |
findActive ( array $options = [] ) : ElggUser[] | integer | Return users (or the number of them) who have been active within a recent period. | |
generateInviteCode ( string $username ) : string | Generates a unique invite code for a user | |
getByEmail ( string $email ) : array | Get an array of users from an email address | |
getByUsername ( string $username ) : ElggUse\ElggUser | false | Get user by username | |
getRow ( integer $guid ) : mixed | Return the user specific details of a user by a row. | |
getValidationStatus ( integer $user_guid ) : boolean | null | Gets the validation status of a user. | |
makeAdmin ( integer $user_guid ) : boolean | Makes user $guid an admin. | |
markBanned ( integer $guid, boolean $banned ) : integer | Mark a user entity banned or unbanned. | |
register ( string $username, string $password, string $name, string $email, boolean $allow_multiple_emails = false ) : integer | false | Registers a user, returning false if the username already exists | |
removeAdmin ( integer $user_guid ) : boolean | Removes user $guid's admin flag. | |
setLastAction ( ElggUse\ElggUser $user ) : void | Sets the last action time of the given user to right now. | |
setLastLogin ( ElggUse\ElggUser $user ) : void | Sets the last logon time of the given user to right now. | |
setValidationStatus ( integer $user_guid, boolean $status, string $method = '' ) : boolean | Set the validation status for a user. | |
unban ( integer $user_guid ) : boolean | Unban a user (calls events, removes the reason) | |
validateInviteCode ( string $username, string $code ) : boolean | Validate a user's invite code |
public __construct ( |
||
$config | Config | |
$db | Database | |
$entities | Entity table | |
$cache | Entity cache | |
$events | Event service |
public disableEntities ( integer $owner_guid ) : boolean | ||
$owner_guid | integer | The owner GUID |
return | boolean | Depending on success |
public findActive ( array $options = [] ) : ElggUser[] | integer | ||
$options | array | 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) |
return | ElggUser[] | integer |
public generateInviteCode ( string $username ) : string | ||
$username | string | The username of the user sending the invitation |
return | string | Invite code |
public getByEmail ( string $email ) : array | ||
string | Email address | |
return | array |
public getByUsername ( string $username ) : ElggUse\ElggUser | false | ||
$username | string | The user's username |
return | ElggUse\ElggUser | false | Depending on success |
public register ( string $username, string $password, string $name, string $email, boolean $allow_multiple_emails = false ) : integer | false | ||
$username | string | The username of the new user |
$password | string | The password |
$name | string | The user's display name |
string | The user's email address | |
$allow_multiple_emails | boolean | Allow the same email address to be registered multiple times? |
return | integer | false | The new user's GUID; false on failure |
public removeAdmin ( integer $user_guid ) : boolean | ||
$user_guid | integer | User GUID |
return | boolean |
public setLastAction ( ElggUse\ElggUser $user ) : void | ||
$user | ElggUse\ElggUser | User entity |
return | void |
public setLastLogin ( ElggUse\ElggUser $user ) : void | ||
$user | ElggUse\ElggUser | User entity |
return | void |
protected EntityCache,Elgg\Cache $entity_cache | ||
return |