Class icms_member_user_Handler

User handler class. This class is responsible for providing data access mechanisms to the data source of user class objects.

icms_core_ObjectHandler

icms_member_user_Handler

Package: Member\User
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at member/user/Handler.php

Methods summary
`protected`	# `beforeInsert( & $obj )` Make sure the registration date of a user is set. Make sure the registration date of a user is set. Parameters `$obj` user object
`public &`	# `create( $isNew = TRUE )` creates a new object creates a new object
`public mixed &`	# `get( integer $id )` retrieve a user from ID retrieve a user from ID Parameters `$id` UID of the user Returns mixed reference to the `icms_member_user_Object` object, FALSE if failed
`public boolean`	# `insert( object & $user, boolean $force = FALSE )` insert a new user in the database insert a new user in the database Parameters `$user` reference to the `icms_member_user_Object` object `$force` Returns boolean FALSE if failed, TRUE if already present and unchanged or successful
`public boolean`	# `delete( object & $user, boolean $force = FALSE )` delete a user from the database delete a user from the database Parameters `$user` reference to the user to delete `$force` Returns boolean FALSE if failed.
`public array`	# `getObjects( object $criteria = NULL, boolean $id_as_key = FALSE )` retrieve users from the database retrieve users from the database Parameters `$criteria` `icms_db_criteria_Element` conditions to be met `$id_as_key` use the UID as key for the array? Returns array array of `icms_member_user_Object` objects
`public integer`	# `getCount( object $criteria = NULL )` count users matching a condition count users matching a condition Parameters `$criteria` `icms_db_criteria_Element` to match Returns integer count of users
`public boolean`	# `deleteAll( object $criteria = NULL )` delete users matching a set of conditions delete users matching a set of conditions Parameters `$criteria` `icms_db_criteria_Element` Returns boolean FALSE if deletion failed
`public boolean`	# `updateAll( string $fieldname, string $fieldvalue, object $criteria = NULL )` Change a value for users with a certain criteria Change a value for users with a certain criteria Parameters `$fieldname` Name of the field `$fieldvalue` Value to write `$criteria` `icms_db_criteria_Element` Returns boolean
`public string`	# `userCheck( string $login_name, string $uname, string $email, string $pass, string $vpass, integer $uid = 0 )` Validates username, email address and password entries during registration Username is validated for uniqueness and length password is validated for length and strictness email is validated as a proper email address pattern Validates username, email address and password entries during registration Username is validated for uniqueness and length password is validated for length and strictness email is validated as a proper email address pattern Parameters `$login_name` $uname User display name entered by the user `$uname` $login_name Username entered by the user `$email` Email address entered by the user `$pass` Password entered by the user `$vpass` Password verification entered by the user `$uid` user id (only applicable if the user already exists) Returns string of errors encountered while validating the user information, will be blank if successful
`public static`	# `getUserLink( integer $uid, boolean $name = FALSE, array $users = array(), boolean $withContact = FALSE, boolean $isAuthor = FALSE )` Return a linked username or full name for a specific $userid Return a linked username or full name for a specific $userid replaces include/functions.php :: xoops_getLinkedUnameFromId Parameters `$uid` uid of the related user `$name` TRUE to return the fullname, FALSE to use the username; if TRUE and the user does not have fullname, username will be used instead `$users` array already containing icms_member_user_Object objects in which case we will save a query `$withContact` TRUE if we want contact details to be added in the value returned (PM and email links) `$isAuthor` Set this to TRUE if you want the rel='author' attribute added to the link
`public static`	# `getUnameFromEmail( string $email = '' )` Parameters `$email` Email address for a user

Methods inherited from icms_core_ObjectHandler
`__construct()`

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_member_user_Handler

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters