Class XoopsUser

Class for users

Xoops\Core\Kernel\XoopsObject implements ArrayAccess

Xoops\Core\Kernel\Handlers\XoopsUser

Direct known subclasses

Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Handlers\XoopsUser
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsUser.php

Methods summary
`public`	# `__construct( integer\|array $id = null )` constructor constructor Parameters `$id` ID of the user to be loaded from the database or Array of key-value-pairs to be assigned to the user. (for backward compatibility only)
`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 boolean`	# `incrementPost( )` increase the number of posts for the user increase the number of posts for the user Deprecated Returns boolean
`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 getGroups() alias for getGroups() Deprecated Returns array array of groups See `Xoops\Core\Kernel\Handlers\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 mixed`	# `uid( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `id( string $format = Xoops\Core\Kernel\Handlers\Dtype::FORMAT_NONE )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `name( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `uname( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `email( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `url( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_avatar( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_regdate( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_icq( string $format = 'S' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_from( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_sig( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_viewemail( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `actkey( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_aim( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_yim( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_msnm( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `pass( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `posts( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `attachsig( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `level( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `theme( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `timezone( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `umode( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `uorder( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `notify_method( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `notify_mode( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_occ( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `bio( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `user_intrest( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed

Methods inherited from Xoops\Core\Kernel\XoopsObject
`__clone(), assignVar(), assignVars(), cleanVars(), destroyVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), loadFilters(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setVar(), setVars(), toArray(), unsetDirty(), unsetNew(), xoopsClone()`

Properties inherited from Xoops\Core\Kernel\XoopsObject
`$cleanVars, $plugin_path, $vars`

Namespaces

Classes

Class XoopsUser

Direct known subclasses

Parameters

Returns

Parameters

Returns

Deprecated

Returns

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

Returns