extends |
XoopsObject |
|---|
Class for users
| Methods | ||||||||
|---|---|---|---|---|---|---|---|---|
public
|
__construct(array|null $id = null)
constructor
constructor Parameters
OverridesOverriden by |
# | ||||||
public
|
isGuest(): bool
check if the user is a guest user
|
# | ||||||
public
static
|
getUnameFromId(int $userid, int $usereal = 0, bool $linked = false): string
Updated by Catzwolf 11 Jan 2004
find the username for a given ID
Updated by Catzwolf 11 Jan 2004 find the username for a given ID Parameters
Returnsname of the user. name for 'anonymous' if not found. |
# | ||||||
public
|
incrementPost()
increase the number of posts for the user
increase the number of posts for the user |
# | ||||||
public
|
setGroups(array $groupsArr)
set the groups for the user
set the groups for the user Parameters
|
# | ||||||
public
&
|
getGroups(): array
get the groups that the user belongs to
get the groups that the user belongs to Returnsarray of groups |
# | ||||||
public
&
|
groups(): array
alias for {@link getGroups()}
alias for {@link getGroups()} Returnsarray of groups |
# | ||||||
public
|
isAdmin(int $module_id = null): bool
Is the user admin ?
Is the user admin ? This method will return true if this user has admin rights for the specified module.
Parameters
Returnsis the user admin of that module? |
# | ||||||
public
|
rank(): array
get the user's rank
get the user's rank Returnsarray of rank ID and title |
# | ||||||
public
|
isActive(): bool
is the user activated?
is the user activated? |
# | ||||||
public
|
isOnline(): bool
is the user currently logged in?
is the user currently logged in? |
# | ||||||
public
|
uid(string $format = ''): int
get the users UID
get the users UID |
# | ||||||
public
|
id(string $format = 'N'): int
get the users UID
get the users UID |
# | ||||||
public
|
name(string $format = 'S'): string
get the users name
get the users name Parameters
|
# | ||||||
public
|
uname(string $format = 'S'): string
get the user's uname
get the user's uname Parameters
|
# | ||||||
public
|
email(string $format = 'S'): string
get the user's email
get the user's email Parameters
|
# | ||||||
public
|
url(string $format = 'S'): mixed
|
# | ||||||
public
|
user_avatar(string $format = 'S'): mixed
|
# | ||||||
public
|
user_regdate(string $format = ''): mixed
|
# | ||||||
public
|
user_icq(string $format = 'S'): mixed
|
# | ||||||
public
|
user_from(string $format = 'S'): mixed
|
# | ||||||
public
|
user_sig(string $format = 'S'): mixed
|
# | ||||||
public
|
user_viewemail(string $format = ''): mixed
|
# | ||||||
public
|
actkey(string $format = ''): mixed
|
# | ||||||
public
|
user_aim(string $format = 'S'): mixed
|
# | ||||||
public
|
user_yim(string $format = 'S'): mixed
|
# | ||||||
public
|
user_msnm(string $format = 'S'): mixed
|
# | ||||||
public
|
pass(string $format = ''): mixed
|
# | ||||||
public
|
posts(string $format = ''): mixed
|
# | ||||||
public
|
attachsig(string $format = ''): mixed
|
# | ||||||
public
|
level(string $format = ''): mixed
|
# | ||||||
public
|
theme(string $format = ''): mixed
|
# | ||||||
public
|
timezone(string $format = ''): mixed
|
# | ||||||
public
|
umode(string $format = ''): mixed
|
# | ||||||
public
|
uorder(string $format = ''): mixed
|
# | ||||||
public
|
notify_method(string $format = ''): mixed
|
# | ||||||
public
|
notify_mode(string $format = ''): mixed
|
# | ||||||
public
|
user_occ(string $format = 'S'): mixed
|
# | ||||||
public
|
bio(string $format = 'S'): mixed
|
# | ||||||
public
|
user_intrest(string $format = 'S'): mixed
|
# | ||||||
public
|
getProfile()
|
# | ||||||
| Properties | |||
|---|---|---|---|
public
|
array
|
$_groups = []
|
# |
public
|
bool
|
$_isAdmin
is the user admin?
is the user admin? |
# |
public
|
string
|
$_rank
user's rank
user's rank |
# |
public
|
bool
|
$_isOnline
is the user online?
is the user online? |
# |
public
|
|
$uid
|
# |
public
|
|
$name
|
# |
public
|
|
$uname
|
# |
public
|
|
$email
|
# |
public
|
|
$url
|
# |
public
|
|
$user_avatar
|
# |
public
|
|
$user_regdate
|
# |
public
|
|
$user_icq
|
# |
public
|
|
$user_from
|
# |
public
|
|
$user_sig
|
# |
public
|
|
$user_viewemail
|
# |
public
|
|
$actkey
|
# |
public
|
|
$user_aim
|
# |
public
|
|
$user_yim
|
# |
public
|
|
$user_msnm
|
# |
public
|
|
$pass
|
# |
public
|
|
$posts
|
# |
public
|
|
$attachsig
|
# |
public
|
|
$rank
|
# |
public
|
|
$level
|
# |
public
|
|
$theme
|
# |
public
|
|
$timezone_offset
|
# |
public
|
|
$last_login
|
# |
public
|
|
$umode
|
# |
public
|
|
$uorder
|
# |
public
|
|
$notify_method
|
# |
public
|
|
$notify_mode
|
# |
public
|
|
$user_occ
|
# |
public
|
|
$bio
|
# |
public
|
|
$user_intrest
|
# |
public
|
|
$user_mailok
|
# |
| Properties inherited from XoopsObject |
|---|
$vars, $cleanVars, $_isNew, $_isDirty, $_errors, $_filters |