[ Index ]
 

Code source de LifeType 1.2.4

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/class/dao/userdata/ -> baseuserdataprovider.class.php (sommaire)

(pas de description)

Poids: 294 lignes (11 kb)
Inclus ou requis:0 fois
Référencé: 1 fois
Nécessite: 0 fichiers

Définit 1 class

BaseUserDataProvider:: (16 méthodes):
  BaseUserDataProvider()
  getProviderConfiguration()
  authenticateUser()
  getUserInfo()
  getUserInfoFromUsername()
  getUserInfoFromId()
  getUsersBlogs()
  mapRow()
  getAllUsers()
  updateUser()
  addUser()
  getBlogUsers()
  deleteUser()
  getNumUsers()
  emailExists()
  grantLoginPermission()


Classe: BaseUserDataProvider  - X-Ref

This is the base class that defines the methods that all user-data providers must implement.
It also provides some common methods that will be shared by all user-data providers and that therefore
should exist in the parent class rather than being copied many times in the child classes.

\ingroup User_Data_Providers
BaseUserDataProvider( $providerConfig )   X-Ref
Constructor of the class

param: providerConfig a Properties object with information about the

getProviderConfiguration()   X-Ref
Returns the config specific data

return: a Properties object with the provider configuration, as it was defined

authenticateUser( $user, $pass )   X-Ref
Returns true if the user is in the database and the username
and password match

param: user Username of the user who we'd like to authenticate
param: pass Password of the user
return: true if user and password correct or false otherwise.

getUserInfo( $user, $pass )   X-Ref
Returns all the information associated to the user given

param: user Username of the user from who we'd like to get the information
param: pass Password of the user we'd like to get the information
return: Returns a UserInfo object with the requested information, or false otherwise.

getUserInfoFromUsername( $username )   X-Ref
Retrieves the user information but given only a username

param: username The username of the user
return: Returns a UserInfo object with the requested information, or false otherwise.

getUserInfoFromId( $userid, $extendedInfo = false )   X-Ref
Retrieves the user infromation but given only a userid

param: userId User ID of the user from whom we'd like to get the information
return: Returns a UserInfo object with the requested information, or false otherwise.

getUsersBlogs( $userid, $status = BLOG_STATUS_ALL )   X-Ref
Returns an array of BlogInfo objects with the information of all the blogs to which
a user belongs

param: userId Identifier of the user
return: An array of BlogInfo objects to whom the user belongs.

mapRow( $query_result )   X-Ref


getAllUsers( $status = USER_STATUS_ALL, $searchTerms = "", $orderBy = "", $page = -1, $itemsPerPage = DEFAULT_ITEMS_PER_PAGE )   X-Ref
Returns an array with all the users available in the database

param: status
param: searchTerms
param: orderBy
param: page
param: itemsPerPage
return: An array containing all the users.

updateUser( $userInfo )   X-Ref
Updates the information related to a user. This method should be called by child classes
so the user permissions (which are plog-specific) can be updated at the same time!

param: userInfo An UserInfo object containing the <b>already udpated</b> information of the
return: Returns true if ok or false otherwise.

addUser( &$user )   X-Ref
Adds a user to the database.

param: user An UserInfo object with the necessary information
return: Returns the identifier assigned to the user, or false if there was any error. It will also modify the

getBlogUsers( $blogId, $includeOwner = true, $status = USER_STATUS_ALL, $searchTerms = "" )   X-Ref
Returns an array with all the users that belong to the given
blog.

param: blogId The blog identifier.
param: includeOwner Wether to include the owner of the blog or not.
param: status
param: searchTerms
return: An array with the information about the users who belong in

deleteUser( $userId )   X-Ref
Removes users from the database

param: userId The identifier of the user we are trying to remove

getNumUsers( $status = USER_STATUS_ALL, $searchTerms = "" )   X-Ref
returns the total number of users

param: status
param: searchTerms
return: total number of users

emailExists($email)   X-Ref
check if the email account has been registered

return: true if the email account has been registered

grantLoginPermission( $userInfo )   X-Ref

param: userInfo A UserInfo object
return: True if successful or false otherwise



Généré le : Mon Nov 26 21:04:15 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics