Inheritance diagram for XoopsUser:

Public Member Functions
	__construct ($id=null)

	actkey ($format= '')

	attachsig ($format= '')

	bio ($format= '')

	email ($format= '')

	getGroups ()

	groups ()

	id ($format= 'n')

	incrementPost ()

	isActive ()

	isAdmin ($module_id=null)

	isGuest ()

	isOnline ()

	level ($format= '')

	name ($format= '')

	notify_method ($format= '')

	notify_mode ($format= '')

	pass ($format= '')

	posts ($format= '')

	rank ()

	setGroups ($groupsArr)

	theme ($format= '')

	timezone ($format= '')

	uid ($format= '')

	umode ($format= '')

	uname ($format= '')

	uorder ($format= '')

	url ($format= '')

	user_aim ($format= '')

	user_avatar ($format= '')

	user_from ($format= '')

	user_icq ($format= 'S')

	user_intrest ($format= '')

	user_msnm ($format= '')

	user_occ ($format= '')

	user_regdate ($format= '')

	user_sig ($format= '')

	user_viewemail ($format= '')

	user_yim ($format= '')

Public Member Functions inherited from Xoops\Core\Kernel\XoopsObject
	assignVar ($key, $value)

	assignVars ($var_arr)

	cleanVars ($quote=true)

	destroyVars ($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= '')

	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 ()

Static Public Member Functions
static	getUnameFromId ($userid, $usereal=0)

Private Attributes
	$_groups = array()

	$_isOnline = null

	$_rank = null

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Kernel\XoopsObject
	$cleanVars = array()

	$plugin_path

	$vars = array()

Detailed Description

Definition at line 30 of file user.php.

Constructor & Destructor Documentation

XoopsUser::__construct ( $id = null )

constructor

Parameters

int | array $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)

Definition at line 57 of file user.php.

References $id, $member_handler, $user, $xoops, Xoops\Core\Kernel\XoopsObject\assignVar(), Xoops\Core\Kernel\XoopsObject\assignVars(), Xoops\getInstance(), Xoops\Core\Kernel\XoopsObject\initVar(), Xoops\Core\Kernel\XOBJ_DTYPE_INT, Xoops\Core\Kernel\XOBJ_DTYPE_OTHER, Xoops\Core\Kernel\XOBJ_DTYPE_TXTAREA, and Xoops\Core\Kernel\XOBJ_DTYPE_TXTBOX.

Here is the call graph for this function:

Member Function Documentation

XoopsUser::actkey ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 372 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::attachsig ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 426 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::bio ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 507 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::email ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 300 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::getGroups ( )

get the groups that the user belongs to

Returns: array array of groups

Definition at line 177 of file user.php.

References $_groups, Xoops\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Referenced by SystemUserForm\__construct(), groups(), and isAdmin().

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

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

Parameters

int	$userid	ID of the user to find
int	$usereal	switch 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 $member_handler, $name, $user, $xoops, and MyTextSanitizer\getInstance().

Referenced by Comments\renderHeader().

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, and getGroups().

Here is the call graph for this function:

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

Parameters

string $format

Returns: mixed

Definition at line 273 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::incrementPost ( )

increase the number of posts for the user

Deprecated:

Returns: bool

Definition at line 155 of file user.php.

References Xoops\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::isActive ( )

is the user activated?

Returns: bool

Definition at line 238 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

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_id check 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 $module_id, $moduleperm_handler, $xoops, and getGroups().

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 251 of file user.php.

References $_isOnline, Xoops\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::level ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 435 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::name ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 282 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::notify_method ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 480 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::notify_mode ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 489 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::pass ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 408 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::posts ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 417 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

string user s XoopsUser::rank ( )

get the user's rank

Returns: array array of rank ID and title

private

Definition at line 224 of file user.php.

References $_rank, $xoops, Xoops\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Referenced by SystemUserForm\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsUser::setGroups ( $groupsArr )

set the groups for the user

Parameters

array $groupsArr Array of groups that user belongs to

Definition at line 165 of file user.php.

XoopsUser::theme ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 444 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::timezone ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 453 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::uid ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 264 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::umode ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 462 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::uname ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 291 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::uorder ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 471 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::url ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 309 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_aim ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 381 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_avatar ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 318 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_from ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 345 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

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

Parameters

string $format

Returns: mixed

Definition at line 336 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_intrest ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 516 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_msnm ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 399 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_occ ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 498 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_regdate ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 327 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_sig ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 354 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_viewemail ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 363 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsUser::user_yim ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 390 of file user.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

Member Data Documentation

XoopsUser::$_groups = array()

private

Definition at line 37 of file user.php.

Referenced by getGroups().

XoopsUser::$_isOnline = null

private

Definition at line 49 of file user.php.

Referenced by isOnline().

XoopsUser::$_rank = null

private

Definition at line 43 of file user.php.

Referenced by rank().

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

C:/usr64/htdocs/kernel/user.php

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation