API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsUser Class Reference
Inheritance diagram for XoopsUser:
Collaboration diagram for XoopsUser:

Public Member Functions

 __construct ($id=null)
 
 isGuest ()
 
 incrementPost ()
 
 setGroups ($groupsArr)
 
getGroups ()
 
groups ()
 
 isAdmin ($module_id=null)
 
 rank ()
 
 isActive ()
 
 isOnline ()
 
 uid ($format='')
 
 id ($format='N')
 
 name ($format='S')
 
 uname ($format='S')
 
 email ($format='S')
 
 url ($format='S')
 
 user_avatar ($format='S')
 
 user_regdate ($format='')
 
 user_icq ($format='S')
 
 user_from ($format='S')
 
 user_sig ($format='S')
 
 user_viewemail ($format='')
 
 actkey ($format='')
 
 user_aim ($format='S')
 
 user_yim ($format='S')
 
 user_msnm ($format='S')
 
 pass ($format='')
 
 posts ($format='')
 
 attachsig ($format='')
 
 level ($format='')
 
 theme ($format='')
 
 timezone ($format='')
 
 umode ($format='')
 
 uorder ($format='')
 
 notify_method ($format='')
 
 notify_mode ($format='')
 
 user_occ ($format='S')
 
 bio ($format='S')
 
 user_intrest ($format='S')
 
 getProfile ()
 
- Public Member Functions inherited from XoopsObject
 __construct ()
 
 XoopsObject ()
 
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 destroyVars ($var)
 
 destoryVars ($var)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
 getValues ($keys=null, $format='s', $maxDepth=1)
 
 getVar ($key, $format=null)
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
 loadFilters ($method)
 
 xoopsClone ()
 
 __clone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
 toArray ()
 

Static Public Member Functions

static getUnameFromId ($userid, $usereal=0)
 

Data Fields

 $_groups = array()
 
 $_isAdmin
 
 $_rank
 
 $_isOnline
 
- Data Fields inherited from XoopsObject
 $vars = array()
 
 $cleanVars = array()
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = array()
 
 $_filters = array()
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $id = null)

constructor

Parameters
array | null$idID of the user to be loaded from the database.
Here is the call graph for this function:

Member Function Documentation

◆ actkey()

actkey (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ attachsig()

attachsig (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ bio()

bio (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ email()

email (   $format = 'S')

get the user's email

Parameters
string$formatformat for the output, see XoopsObject::getVar($format = '')
Returns
string
Here is the call graph for this function:

◆ getGroups()

& getGroups ( )

get the groups that the user belongs to

Returns
array array of groups
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getProfile()

getProfile ( )

#- #+

Deprecated:

◆ getUnameFromId()

static getUnameFromId (   $userid,
  $usereal = 0 
)
static

Updated by Catzwolf 11 Jan 2004 find the username for a given ID

Parameters
int$useridID of the user to find
int$userealswitch for usename or realname
Returns
string name of the user. name for 'anonymous' if not found.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ groups()

& groups ( )

alias for getGroups()

See also
getGroups()
Returns
array array of groups
Deprecated:
Here is the call graph for this function:

◆ id()

id (   $format = 'N')

get the users UID

Parameters
string$format
Returns
int
Here is the call graph for this function:

◆ incrementPost()

incrementPost ( )

increase the number of posts for the user

Deprecated:
Here is the call graph for this function:

◆ isActive()

isActive ( )

is the user activated?

Returns
bool
Here is the call graph for this function:

◆ isAdmin()

isAdmin (   $module_id = null)

Is the user admin ?

This method will return true if this user has admin rights for the specified module.

  • If you don't specify any module ID, the current module will be checked.
  • If you set the module_id to -1, it will return true if the user has admin rights for at least one module
Parameters
int$module_idcheck if user is admin of this module
Returns
bool is the user admin of that module?
Here is the call graph for this function:

◆ isGuest()

isGuest ( )

check if the user is a guest user

Returns
bool returns false

Reimplemented in XoopsGuestUser.

◆ isOnline()

isOnline ( )

is the user currently logged in?

Returns
bool
Here is the call graph for this function:

◆ level()

level (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ name()

name (   $format = 'S')

get the users name

Parameters
string$formatformat for the output, see XoopsObject::getVar($format = '')
Returns
string
Here is the call graph for this function:

◆ notify_method()

notify_method (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ notify_mode()

notify_mode (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ pass()

pass (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ posts()

posts (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ rank()

string user s rank ( )

get the user's rank

Returns
array array of rank ID and title

@access private

Here is the call graph for this function:

◆ setGroups()

setGroups (   $groupsArr)

set the groups for the user

Parameters
array$groupsArrArray of groups that user belongs to

◆ theme()

theme (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ timezone()

timezone (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ uid()

uid (   $format = '')

get the users UID

Parameters
string$format
Returns
int
Here is the call graph for this function:

◆ umode()

umode (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ uname()

uname (   $format = 'S')

get the user's uname

Parameters
string$formatformat for the output, see XoopsObject::getVar($format = '')
Returns
string
Here is the call graph for this function:

◆ uorder()

uorder (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ url()

url (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_aim()

user_aim (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_avatar()

user_avatar (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_from()

user_from (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_icq()

user_icq (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_intrest()

user_intrest (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_msnm()

user_msnm (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_occ()

user_occ (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_regdate()

user_regdate (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_sig()

user_sig (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_viewemail()

user_viewemail (   $format = '')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ user_yim()

user_yim (   $format = 'S')
Parameters
string$format
Returns
mixed
Here is the call graph for this function:

Field Documentation

◆ $_groups

$_groups = array()

◆ $_isAdmin

$_isAdmin

◆ $_isOnline

$_isOnline

◆ $_rank

$_rank

The documentation for this class was generated from the following file: