Docs For Class TBoUsers

TBoUsers

Description

Manage the backoffice users

author: SimpliciWeb
version: $Id: t_bo_users.class.php 781 2007-12-27 13:07:16Z stephanet $

Located in /core/internal_components/admin_sites/t_bo_users/t_bo_users.class.php (line 57)

Variable Summary

mixed $m_authent

mixed $m_email

mixed $m_first_name

mixed $m_group

mixed $m_id

mixed $m_last_name

mixed $m_nick

DbConnexion $m_object_dbconnexion

Format $m_object_format

TSessionScope $m_object_sessionscope

mixed $m_pass

siteInformation $m_site_information

string $m_uid_prefix

string $req_count

string $req_delete

string $req_insert

string $req_select

string $req_select_by_primary_key

string $req_update

string $req_update_without_password

Method Summary

TBoUsers TBoUsers ([unknown_type $p_nick = ""], [unknown_type $p_pass = ""])

void addGroup (integer $value)

bool deleteTBoUsers (string $p_pk_bus_id, &$r_nb_row_affected, integer $r_nb_row_affected)

void Destroy ()

void DisplayForm ()

bool existTBoUsers ( &$r_is_existing, string $p_pk_bus_id, bool $r_is_existing)

string generateUniqueId ()

bool GetAuthent ()

bool getCountTBoUsers ( &$r_result_count, integer $r_result_count)

string GetEmail ()

string GetFirstName ()

array GetGroupArrayKeyId ()

string GetGroupSQLInFormat ()

string GetId ()

string GetLastName ()

bool getListTBoUsers ( &$r_result, array $r_result)

bool getListTBoUsersByGroupAndOrderBy (integer $p_group_to_show, [string $p_order_by = 'bus_nom'], &$r_result, array $r_result)

string GetNick ()

bool getOneTBoUsers ( &$r_result, string $p_pk_bus_id, array $r_result)

string GetPass ()

bool insertTBoUsers (string $p_bus_nick, string $p_bus_password, string $p_bus_prenom, string $p_bus_nom, string $p_bus_email, &$r_result_id, string $r_result_id)

void ResetGroup ()

void SetEmail (string $p_email)

void SetFirstName (string $p_first_name)

void SetId (string $p_id)

void SetLastName (string $p_last_name)

void SetNick (string $p_nick)

void SetNoValid ()

void SetPass (string $p_pass)

void SetValid ()

bool updateTBoUsers (string $p_bus_nick, [string $p_bus_password = ""], string $p_bus_prenom, string $p_bus_nom, string $p_bus_email, string $p_pk_bus_id, &$r_nb_row_affected, integer $r_nb_row_affected)

bool xIsNotValidBusEmail (string $p_value)

bool xIsNotValidBusId (string $p_value)

bool xIsNotValidBusNick (string $p_value)

bool xIsNotValidBusNom (string $p_value)

bool xIsNotValidBusPassword (string $p_value)

bool xIsNotValidBusPrenom (string $p_value)

void xIsValid ()

void xRowToArray (array $p_row, &$r_result, array $r_result)

Variables

mixed $m_authent = FALSE (line 158)

mixed $m_email = NULL (line 157)

mixed $m_first_name = NULL (line 156)

mixed $m_group = array() (line 159)

mixed $m_id = NULL (line 152)

mixed $m_last_name = NULL (line 155)

mixed $m_nick = NULL (line 153)

DbConnexion $m_object_dbconnexion = NULL (line 85)

Database Connexion object

Format $m_object_format = NULL (line 79)

Format Object

TSessionScope $m_object_sessionscope = NULL (line 142)

TSessionScope Object

mixed $m_pass = NULL (line 154)

siteInformation $m_site_information = NULL (line 136)

SiteInformation Object

string $m_uid_prefix = "bus_" (line 149)

Prefix for user id

string $req_count = "" (line 105)

SQL Request : Count

string $req_delete = "" (line 117)

SQL Request : Delete

string $req_insert = "" (line 111)

SQL Request : Insert

string $req_select = "" (line 99)

SQL Request : Select

string $req_select_by_primary_key = "" (line 93)

SQL Request : Select by primary key

string $req_update = "" (line 123)

SQL Request : Update

string $req_update_without_password = "" (line 129)

SQL Request : Update password

Methods

Constructor TBoUsers (line 170)

Constructor, init the requests and objects.

Also, make the authentification of the user for backoffice.

TBoUsers TBoUsers ([unknown_type $p_nick = ""], [unknown_type $p_pass = ""])

unknown_type $p_nick
unknown_type $p_pass

addGroup (line 1057)

Add group

void addGroup (integer $value)

integer $value

deleteTBoUsers (line 729)

Delete a user

return: TRUE on error

bool deleteTBoUsers (string $p_pk_bus_id, &$r_nb_row_affected, integer $r_nb_row_affected)

string $p_pk_bus_id
integer $r_nb_row_affected
&$r_nb_row_affected

Destroy (line 788)

Close the user session

void Destroy ()

DisplayForm (line 1066)

Display the authentification form

void DisplayForm ()

existTBoUsers (line 594)

Test if the user exist

return: TRUE on error

bool existTBoUsers ( &$r_is_existing, string $p_pk_bus_id, bool $r_is_existing)

bool $r_is_existing
string $p_pk_bus_id
&$r_is_existing

generateUniqueId (line 395)

Generate a unique id for a user

return: unique id

string generateUniqueId ()

GetAuthent (line 949)

Accessor

bool GetAuthent ()

getCountTBoUsers (line 567)

Count the number of users

return: TRUE on error

bool getCountTBoUsers ( &$r_result_count, integer $r_result_count)

integer $r_result_count
&$r_result_count

GetEmail (line 940)

accessor

string GetEmail ()

GetFirstName (line 931)

accessor

string GetFirstName ()

GetGroupArrayKeyId (line 967)

accessor

array GetGroupArrayKeyId ()

GetGroupSQLInFormat (line 958)

accessor

string GetGroupSQLInFormat ()

GetId (line 895)

accessor

string GetId ()

GetLastName (line 922)

accessor

string GetLastName ()

getListTBoUsers (line 528)

Get list of users

return: TRUE on error

bool getListTBoUsers ( &$r_result, array $r_result)

array $r_result
&$r_result

getListTBoUsersByGroupAndOrderBy (line 451)

Get list of users by group

return: TRUE on error

bool getListTBoUsersByGroupAndOrderBy (integer $p_group_to_show, [string $p_order_by = 'bus_nom'], &$r_result, array $r_result)

integer $p_group_to_show
string $p_order_by
array $r_result
&$r_result

GetNick (line 904)

accessor

string GetNick ()

getOneTBoUsers (line 409)

Get one

return: TRUE on error

bool getOneTBoUsers ( &$r_result, string $p_pk_bus_id, array $r_result)

array $r_result
string $p_pk_bus_id
&$r_result

GetPass (line 913)

accessor

string GetPass ()

insertTBoUsers (line 616)

Insert a user

return: TRUE on error

bool insertTBoUsers (string $p_bus_nick, string $p_bus_password, string $p_bus_prenom, string $p_bus_nom, string $p_bus_email, &$r_result_id, string $r_result_id)

string $p_bus_nick
string $p_bus_password
string $p_bus_prenom
string $p_bus_nom
string $p_bus_email
string $r_result_id
&$r_result_id

ResetGroup (line 1048)

Reset the group

void ResetGroup ()

SetEmail (line 1022)

Set email

void SetEmail (string $p_email)

string $p_email

SetFirstName (line 1013)

Set first name

void SetFirstName (string $p_first_name)

string $p_first_name

SetId (line 977)

Set id

void SetId (string $p_id)

string $p_id

SetLastName (line 1004)

Set Last name

void SetLastName (string $p_last_name)

string $p_last_name

SetNick (line 986)

Set Nick

void SetNick (string $p_nick)

string $p_nick

SetNoValid (line 1031)

Set not valid authent

void SetNoValid ()

SetPass (line 995)

Set password

void SetPass (string $p_pass)

string $p_pass

SetValid (line 1039)

Set to valid athentification

void SetValid ()

updateTBoUsers (line 670)

Update the user informations

return: TRUE on error

string $p_bus_nick
string $p_bus_password
string $p_bus_prenom
string $p_bus_nom
string $p_bus_email
string $p_pk_bus_id
integer $r_nb_row_affected
&$r_nb_row_affected

xIsNotValidBusEmail (line 375)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidBusEmail (string $p_value)

string $p_value

xIsNotValidBusId (line 304)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidBusId (string $p_value)

string $p_value

xIsNotValidBusNick (line 317)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidBusNick (string $p_value)

string $p_value

xIsNotValidBusNom (line 362)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidBusNom (string $p_value)

string $p_value

xIsNotValidBusPassword (line 336)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidBusPassword (string $p_value)

string $p_value

xIsNotValidBusPrenom (line 349)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidBusPrenom (string $p_value)

string $p_value

xIsValid (line 810)

Verify if the authentification of the user is ok

void xIsValid ()

xRowToArray (line 770)

Convert a number indexed array to an fieldname indexed array

void xRowToArray (array $p_row, &$r_result, array $r_result)

array $p_row
array $r_result
&$r_result

Documentation generated on Tue, 25 Mar 2008 15:36:10 +0100 by phpDocumentor 1.3.2