XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
XoopsUser Class Reference
Inheritance diagram for XoopsUser:
Inheritance graph

Public Member Functions

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

Public Attributes

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

Detailed Description

Definition at line 28 of file user.php.

Member Function Documentation

XoopsUser::actkey (   $format = '')

Definition at line 339 of file user.php.

XoopsUser::attachsig (   $format = '')

Definition at line 369 of file user.php.

XoopsUser::bio (   $format = 'S')

Definition at line 415 of file user.php.

XoopsUser::email (   $format = 'S')

get the user's email

Parameters
string$formatformat for the output, see XoopsObject::getVar($format = '')
Returns
string

Definition at line 299 of file user.php.

& XoopsUser::getGroups ( )

get the groups that the user belongs to

Returns
array array of groups

Definition at line 176 of file user.php.

References $member_handler, and xoops_gethandler().

Here is the call graph for this function:

XoopsUser::getProfile ( )

#@- #@+

Deprecated:

Definition at line 429 of file user.php.

XoopsUser::getUnameFromId (   $userid,
  $usereal = 0 
)

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.

Definition at line 124 of file user.php.

References $GLOBALS, $member_handler, $user, MyTextSanitizer\getInstance(), and xoops_gethandler().

Referenced by XoopsComments\showTreeItem(), and XoopsStory\uname().

Here is the call graph for this function:

Here is the caller graph for this function:

& XoopsUser::groups ( )

alias for getGroups()

See Also
getGroups()
Returns
array array of groups
Deprecated:

Definition at line 191 of file user.php.

References $groups.

XoopsUser::id (   $format = 'N')

get the users UID

Returns
int

Definition at line 268 of file user.php.

XoopsUser::incrementPost ( )

increase the number of posts for the user

Deprecated:

Definition at line 153 of file user.php.

References $member_handler, and xoops_gethandler().

Here is the call graph for this function:

XoopsUser::isActive ( )

is the user activated?

Returns
bool

Definition at line 234 of file user.php.

XoopsUser::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?

Definition at line 207 of file user.php.

References $GLOBALS, $module_id, $moduleperm_handler, and xoops_gethandler().

Here is the call graph for this function:

XoopsUser::isGuest ( )

check if the user is a guest user

Returns
bool returns false

Definition at line 111 of file user.php.

XoopsUser::isOnline ( )

is the user currently logged in?

Returns
bool

Definition at line 246 of file user.php.

References xoops_gethandler().

Here is the call graph for this function:

XoopsUser::level (   $format = '')

Definition at line 374 of file user.php.

XoopsUser::name (   $format = 'S')

get the users name

Parameters
string$formatformat for the output, see XoopsObject::getVar($format = '')
Returns
string

Definition at line 278 of file user.php.

XoopsUser::notify_method (   $format = '')

Definition at line 400 of file user.php.

XoopsUser::notify_mode (   $format = '')

Definition at line 405 of file user.php.

XoopsUser::pass (   $format = '')

Definition at line 359 of file user.php.

XoopsUser::posts (   $format = '')

Definition at line 364 of file user.php.

string user s XoopsUser::rank ( )

get the user's rank

Returns
array array of rank ID and title

private

Definition at line 222 of file user.php.

References xoops_getrank().

Here is the call graph for this function:

XoopsUser::setGroups (   $groupsArr)

set the groups for the user

Parameters
array$groupsArrArray of groups that user belongs to

Definition at line 164 of file user.php.

XoopsUser::theme (   $format = '')

Definition at line 379 of file user.php.

XoopsUser::timezone (   $format = '')

Definition at line 384 of file user.php.

XoopsUser::uid (   $format = '')

get the users UID

Returns
int

Definition at line 259 of file user.php.

XoopsUser::umode (   $format = '')

Definition at line 389 of file user.php.

XoopsUser::uname (   $format = 'S')

get the user's uname

Parameters
string$formatformat for the output, see XoopsObject::getVar($format = '')
Returns
string

Definition at line 288 of file user.php.

XoopsUser::uorder (   $format = '')

Definition at line 394 of file user.php.

XoopsUser::url (   $format = 'S')

Definition at line 304 of file user.php.

XoopsUser::user_aim (   $format = 'S')

Definition at line 344 of file user.php.

XoopsUser::user_avatar (   $format = 'S')

Definition at line 309 of file user.php.

XoopsUser::user_from (   $format = 'S')

Definition at line 324 of file user.php.

XoopsUser::user_icq (   $format = 'S')

Definition at line 319 of file user.php.

XoopsUser::user_intrest (   $format = 'S')

Definition at line 420 of file user.php.

XoopsUser::user_msnm (   $format = 'S')

Definition at line 354 of file user.php.

XoopsUser::user_occ (   $format = 'S')

Definition at line 410 of file user.php.

XoopsUser::user_regdate (   $format = '')

Definition at line 314 of file user.php.

XoopsUser::user_sig (   $format = 'S')

Definition at line 329 of file user.php.

XoopsUser::user_viewemail (   $format = '')

Definition at line 334 of file user.php.

XoopsUser::user_yim (   $format = 'S')

Definition at line 349 of file user.php.

XoopsUser::XoopsUser (   $id = null)

constructor

Parameters
array$idArray of key-value-pairs to be assigned to the user. (for backward compatibility only)
int$idID of the user to be loaded from the database.

Definition at line 57 of file user.php.

References $member_handler, $user, XOBJ_DTYPE_INT, XOBJ_DTYPE_OTHER, XOBJ_DTYPE_TXTAREA, XOBJ_DTYPE_TXTBOX, and xoops_gethandler().

Referenced by XoUser\XoUser().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

XoopsUser::$_groups = array()

Definition at line 35 of file user.php.

XoopsUser::$_isAdmin = null

Definition at line 40 of file user.php.

XoopsUser::$_isOnline = null

Definition at line 50 of file user.php.

XoopsUser::$_rank = null

Definition at line 45 of file user.php.


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