Class XoopsUser

Class for users

XoopsObject

XoopsUser

Direct known subclasses

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/user.php

Methods summary
`public`	# `__construct( array\|null $id = null )` constructor constructor Parameters `$id` ID of the user to be loaded from the database. Overrides `XoopsObject::__construct()`
`public boolean`	# `isGuest( )` check if the user is a guest user check if the user is a guest user Returns boolean returns false
`public static string`	# `getUnameFromId( integer $userid, integer $usereal = 0 )` 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 `$userid` ID of the user to find `$usereal` switch for usename or realname Returns string name 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 Deprecated
`public`	# `setGroups( array $groupsArr )` set the groups for the user set the groups for the user Parameters `$groupsArr` Array of groups that user belongs to
`public array &`	# `getGroups( )` get the groups that the user belongs to get the groups that the user belongs to Returns array array of groups
`public array &`	# `groups( )` alias for `XoopsUser::getGroups()` alias for `XoopsUser::getGroups()` Deprecated Returns array array of groups See `XoopsUser::getGroups()`
`public boolean`	# `isAdmin( integer $module_id = null )` Is the user admin ? 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 `$module_id` check if user is admin of this module Returns boolean is the user admin of that module?
`public array`	# `rank( )` get the user's rank get the user's rank Returns array array of rank ID and title
`public boolean`	# `isActive( )` is the user activated? is the user activated? Returns boolean
`public boolean`	# `isOnline( )` is the user currently logged in? is the user currently logged in? Returns boolean
`public integer`	# `uid( string $format = '' )` get the users UID get the users UID Parameters `$format` Returns integer
`public integer`	# `id( string $format = 'N' )` get the users UID get the users UID Parameters `$format` Returns integer
`public string`	# `name( string $format = 'S' )` get the users name get the users name Parameters `$format` format for the output, see = '') Returns string
`public string`	# `uname( string $format = 'S' )` get the user's uname get the user's uname Parameters `$format` format for the output, see = '') Returns string
`public string`	# `email( string $format = 'S' )` get the user's email get the user's email Parameters `$format` format for the output, see = '') Returns string
`public mixed`	# `url( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_avatar( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_regdate( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `user_icq( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_from( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_sig( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_viewemail( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `actkey( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `user_aim( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_yim( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_msnm( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `pass( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `posts( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `attachsig( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `level( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `theme( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `timezone( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `umode( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `uorder( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `notify_method( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `notify_mode( string $format = '' )` Parameters `$format` Returns mixed
`public mixed`	# `user_occ( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `bio( string $format = 'S' )` Parameters `$format` Returns mixed
`public mixed`	# `user_intrest( string $format = 'S' )` Parameters `$format` Returns mixed
`public`	# `getProfile( )` Deprecated

Methods inherited from XoopsObject
`XoopsObject(), __clone(), _loadFilters(), assignVar(), assignVars(), cleanVars(), destoryVars(), destroyVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), loadFilters(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setVar(), setVars(), toArray(), unsetDirty(), unsetNew(), xoopsClone()`

Properties summary
`public array`	`$_groups` Array of groups that user belongs to Array of groups that user belongs to	# `array()`
`public boolean`	`$_isAdmin` is the user admin? is the user admin?	#
`public string`	`$_rank` user's rank user's rank	#
`public boolean`	`$_isOnline` is the user online? is the user online?	#

Properties inherited from XoopsObject
`$_errors, $_filters, $_isDirty, $_isNew, $cleanVars, $vars`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsUser

Direct known subclasses

Parameters

Overrides

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Deprecated

Returns

See

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters