Method |
Description |
|
__construct ( stdClass $row = null ) |
Construct a new user entity |
|
__set ( $name, $value ) |
|
|
addFriend ( integer $friend_guid, boolean $create_river_item = false ) : boolean |
Adds a user as a friend |
|
ban ( string $reason = "" ) : boolean |
Ban this user. |
|
canComment ( integer $user_guid, boolean $default = null ) : boolean |
Can a user comment on this user? |
|
getDisplayName ( ) |
|
|
getExternalAttributes ( ) : array |
Get default values for attributes stored in a separate table |
|
getFriends ( array $options = [] ) |
|
|
getFriendsObjects ( array $options = [] ) |
|
|
getFriendsOf ( array $options = [] ) |
|
|
getGroups ( array $options = [] ) : array | false |
Gets the user's groups |
|
getNotificationSettings ( ) : array |
Returns users's notification settings
[
'email' => true, // enabled
'ajax' => false, // disabled
]
|
|
getObjects ( array $options = [] ) |
|
|
getOwnerGUID ( ) : integer |
Get a user's owner GUID |
|
isAdmin ( ) : boolean |
Is this user admin? |
|
isBanned ( ) : boolean |
Is this user banned or not? |
|
isFriend ( ) : boolean |
Determines whether or not this user is a friend of the currently logged in user |
|
isFriendOf ( integer $user_guid ) : boolean |
Determines whether or not this user is another user's friend |
|
isFriendsWith ( integer $user_guid ) : boolean |
Determines whether this user is friends with another user |
|
makeAdmin ( ) : boolean |
Make the user an admin |
|
removeAdmin ( ) : boolean |
Remove the admin flag for user |
|
removeFriend ( integer $friend_guid ) : boolean |
Removes a user as a friend |
|
setDisplayName ( $displayName ) |
|
|
setNotificationSetting ( string $method, boolean $enabled = true ) : boolean |
Enable or disable a notification delivery method |
|
setPassword ( string $password ) : void |
Set the necessary attribute to store a hash of the user's password. |
|
unban ( ) : boolean |
Unban this user. |
|