Data & function about connected users. More...

Collaboration diagram for User:

Public Member Functions
	__construct ($p_cn, $p_id=-1)

	__toString ()

	Admin ()
	synomym for isAdmin, More...

	audit ($action='AUDIT', $p_module="")

	can_add_action ($p_profile)
	Check if the current user can add an action in the profile given in parameter. More...

	can_connect ()
	check the password and user More...

	can_delete_action ($dtoc)
	Check if the profile of the user can write AND delete for this profile. More...

	can_print ($p_action, $p_js=0)

	can_read_action ($dtoc)
	Check if the profile of the user can write for this profile. More...

	can_read_repo ($p_repo)
	Check if the profile of the user can read for this repository. More...

	can_request ($p_action, $p_js=0)

	can_write_action ($dtoc)
	Check if the profile of the user can write for this profile. More...

	can_write_repo ($p_repo)
	Check if the profile of the user can write for this repository. More...

	Check ($silent=false, $from='')
	Check if user is active and exists in therepository Automatically redirect, it doesn't check if a user can access a folder. More...

	check_action ($p_action_id)
	Check if an user is allowed to do an action. More...

	check_dossier ($p_dossier_id, $silent=false)
	check if an user can access a folder, if he cannot display a dialog box and exit More...

	check_jrn ($p_jrn)
	check the access of an user on a ledger More...

	check_module ($p_module)
	Check if an user can access a module, return 1 if yes, otherwise 0 record in audit log This function works only if user is connected to a Folder. More...

	check_print ($p_action)
	Check if the user can print (in menu_ref p_type_display=p) otherwise warn and exit. More...

	get_access_mode ()
	access_mode tells what mode must be used : pc or mobile More...

	get_available_folder ($p_filter="")
	Get all the available folders for the users, checked with the security. More...

	get_available_repository ($p_access='R')
	return array of available repository More...

	get_exercice ()

	get_first_week_day ()

	get_folder_access ($p_dossier=0)
	return the access to a folder, More...

	get_ledger ($p_type='ALL', $p_access=3, $disable=TRUE)
	get all the available ledgers for the current user More...

	get_ledger_access ($p_ledger)
	check that a user is valid and the access to the folder More...

	get_ledger_sql ($p_type='ALL', $p_access=3)
	return an sql condition for filtering the permitted ledger More...

	get_limit_current_exercice ()
	return the first date and the last date of the current exercice for the current user More...

	get_mini_report ()
	return the mini rapport to display on the welcome page More...

	get_periode ()
	Get the default periode from the user's preferences. More...

	get_preference ()
	Get the default user's preferences. More...

	get_profile ()
	return the profile (p_id) More...

	get_readable_profile ()
	return array of readable action_profile More...

	get_status_security_action ()
	Check the security on ledger for the user , it returns 1 if the security on ledgers is enabled, otherwise 0. More...

	get_status_security_ledger ()
	Check the security on ledger for the user , it returns 1 if the security on ledgers is enabled, otherwise 0. More...

	get_writable_profile ()
	return array of writable action_profile More...

	getActive ()

	getAdmin ()

	getDb ()

	getEmail ()

	getFirstName ()

	getId ()

	getLogin ()

	getName ()

	getPassword ()

	getValid ()

	insert ()

	insert_default_global_pref ($p_type="", $p_value="")
	insert default pref if no parameter are given insert all the existing parameter otherwise only the requested More...

	is_local_admin ($p_dossier=-1)
	Check if an user is an local administrator. More...

	isAdmin ()
	Check if an user is an admin. More...

	load ()

	load_global_pref ()
	Get the global preferences from user_global_pref in the account_repository db. More...

	password_to_session ()
	store the password in session More...

	save ()

	save_email ($p_email)
	Save the password from PREFERENCE MODULE. More...

	save_global_preference ($key, $value)
	Save the preference , the scope is global, the settings are saved into account_repository. More...

	save_password ($p_pass1, $p_pass2)
	Save the password of the current user. More...

	save_profile ($p_id)

	set_access_mode ($access_mode)
	access_mode tells what mode must be used : pc or mobile More...

	set_folder_access ($db_id, $priv)
	save the access of a folder More...

	set_mini_report ($p_id)
	set the mini rapport to display on the welcome page More...

	set_periode ($p_periode)
	Set the selected periode in the user's preferences. More...

	set_status_security_action ($p_value)
	Set the flag in the table user_active_security. More...

	set_status_security_ledger ($p_value)
	Set the flag in the table user_active_security. More...

	setActive ($active)

	setAdmin ($admin)

	setDb ($db)

	setEmail ($email)

	setFirstName ($first_name)

	setId (int $id)

	setLogin (string $login)

	setName ($name)

	setPassword ($password)

	setValid (int $valid)

	show_dossier ($p_filtre="")
	Show all the available folder for the users at the login page. More...

	sql_readable_profile ()
	Compute the SQL string for the readable profile, the subselect for p_id , example p_id in $g_user->sql_readable_profile. More...

	sql_writable_profile ()
	Compute the SQL string for the writable profile, the subselect for p_id , example p_id in $g_user->sql_writable_profile. More...

	update_global_pref ($p_type, $p_value="")
	update default pref if value is not given then use the default value More...

Static Public Member Functions
static	audit_admin ($p_module)
	Audit action from the administration menu. More...

static	clean_session ()
	clean the sessions More...

static	get_list ($p_dossier)
	return an array with all the active users who can access $p_dossier including the global admin. More...

static	grant_admin_access ($p_login, $p_dossier)
	Grant access to folder, grant administrator profile , all the ledgers and all the action. More...

static	remove_inexistant_user ($p_dossier)

static	revoke_access ($p_login, $p_dossier)
	Remove a user and all his privileges So it cannot connect anymore and all his privileges are removed from the dossier. More...

Data Fields
	$access_mode
	MOBILE or PC depending if when connecting $login contains @mobile. More...

	$active
	1 active , 0 disables More...

	$admin
	is or is not admin More...

	$db
	database connx More...

	$email
	user's email More...

	$first_name

	$id
	in account_repository , ac_users.use_id More...

	$login
	login lower case More...

	$name

	$password
	md5 of the password More...

	$valid
	is or is not valid More...

Private Member Functions
	connect_user ()
	connect the user and set the $_SESSION variables if not set thanks the $_REQUEST More...

	set_default_periode ()

Detailed Description

Data & function about connected users.

Definition at line 33 of file user.class.php.

Constructor & Destructor Documentation

◆ __construct()

User::__construct	(	$p_cn,
		$p_id = `-1`
	)

Definition at line 49 of file user.class.php.

     {
         $this->db=$p_cn;
         // if p_id is not set then check the connected user
         if ($p_id==-1)
         {
             $this->connect_user();
         }
         else // if p_id is set get data of another user
         {
             $this->id=$p_id;
             $this->load();
         }
     }

References $p_id, connect_user(), db, and load().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

User::__toString ( )

Definition at line 63 of file user.class.php.

                                 : string
     {
         return "User ".print_r($this,true);
     }

◆ Admin()

User::Admin ( )

synomym for isAdmin,

Deprecated:

Definition at line 644 of file user.class.php.

     {
         return $this->isAdmin();
     }

◆ audit()

User::audit	(	$action = `'AUDIT'`,
		$p_module = `""`
	)

Definition at line 1380 of file user.class.php.

     {
         global $audit;
         if ($audit)
         {
             if ($p_module==""&&isset($_REQUEST['ac']))
             {
                 $p_module=$_REQUEST['ac'];
             }
             $cn=new Database();
             if (isset($_REQUEST['gDossier']))
                 $p_module.=" dossier : ".$_REQUEST['gDossier'];
             $sql="insert into audit_connect (ac_user,ac_ip,ac_module,ac_url,ac_state) values ($1,$2,$3,$4,$5)";
  
             $cn->exec_sql($sql,
                     array(
                         $_SESSION[SESSION_KEY.'g_user'],
                         $_SERVER["REMOTE_ADDR"],
                         $p_module,
                         $_SERVER['REQUEST_URI'],
                         $action));
         }
     }

◆ audit_admin()

static User::audit_admin ( $p_module )

static

Audit action from the administration menu.

Parameters

$p_module description of the action

Definition at line 1366 of file user.class.php.

     {
         $cn=new Database();
         $sql="insert into audit_connect (ac_user,ac_ip,ac_module,ac_url,ac_state) values ($1,$2,$3,$4,$5)";
  
         $cn->exec_sql($sql,
                 array(
                     $_SESSION[SESSION_KEY.'g_user'],
                     $_SERVER["REMOTE_ADDR"],
                     $p_module,
                     $_SERVER['REQUEST_URI'],
                     'ADMIN'));
     }

◆ can_add_action()

User::can_add_action ( $p_profile )

Check if the current user can add an action in the profile given in parameter.

Parameters

type $p_profile profile.p_id = action_gestion.ag_dest

Returns: boolean

Definition at line 1499 of file user.class.php.

     {
         $r=$this->db->get_value(' select count(*) 
                 from user_sec_action_profile
                 where p_granted=$2
                 and p_id=$1', array($this->get_profile(), $p_profile));
         if ($r==0)
         {
             return false;
         }
         return true;
     }

◆ can_connect()

User::can_connect ( )

check the password and user

Definition at line 70 of file user.class.php.

     {
        $cn=new \Database();
        $can_connect=$cn->get_value("select count(*) from ac_users 
                                    where use_active=1 and
                                    use_login=$1 and use_pass=$2",
                [$this->login,$this->password]);
        return $can_connect;
     }

References $cn.

Referenced by Check(), and connect_user().

◆ can_delete_action()

User::can_delete_action ( $dtoc )

Check if the profile of the user can write AND delete for this profile.

Parameters

$dtoc action_gestion.ag_id

Returns: true if he can write otherwise false

Definition at line 1536 of file user.class.php.

     {
         if ($this->Admin()==1)
             return TRUE;
         if ($this->get_status_security_action()==0)
             return TRUE;
         $profile=$this->get_profile();
         $r=$this->db->get_value(" select count(*) from action_gestion where ag_id=$1 and ag_dest in
                                 (select p_granted from user_sec_action_profile where ua_right='W' and p_id=$2) ", array($dtoc, $profile));
         if ($r==0)
             return FALSE;
         return true;
     }

◆ can_print()

User::can_print	(	$p_action,
		$p_js = `0`
	)

Definition at line 1079 of file user.class.php.

     {
         if ($this->check_print($p_action)==0)
         {
             $this->audit('FAIL');
             if ($p_js==1)
             {
                 echo create_script("alert_box(content[59])");
             }
             else
             {
                 echo '<div class="redcontent">';
                 echo '<h2 class="error">',
                 htmlspecialchars(_("Cette action ne vous est pas autorisée Contactez votre responsable")),
                 '</h2>';
                 echo '</div>';
             }
             exit(-1);
         }
     }

◆ can_read_action()

User::can_read_action ( $dtoc )

Check if the profile of the user can write for this profile.

Parameters

$dtoc action_gestion.ag_id

Returns: true if he can write otherwise false

Definition at line 1555 of file user.class.php.

     {
         if ($this->Admin()==1)
             return true;
         $profile=$this->get_profile();
         $r=$this->db->get_value(" select count(*) from action_gestion where ag_id=$1 and (ag_dest in
                                 (select p_granted from user_sec_action_profile where p_id=$2) or ag_owner=$3)",
                 array($dtoc, $profile, $this->login));
         if ($r==0)
             return false;
         return true;
     }

◆ can_read_repo()

User::can_read_repo ( $p_repo )

Check if the profile of the user can read for this repository.

Parameters

$p_repo stock_repository.r_id

Returns: true if he read write otherwise false

Definition at line 1594 of file user.class.php.

     {
         if ($this->Admin()==1)
             return true;
         $profile=$this->get_profile();
         $r=$this->db->get_value("select count(*)
                 from profile_sec_repository
                 where
                 r_id=$1
                 and p_id =$2
                ", array($p_repo, $profile));
         if ($r==0)
             return false;
         return true;
     }

◆ can_request()

User::can_request	(	$p_action,
		$p_js = `0`
	)

Definition at line 1030 of file user.class.php.

     {
         if ($this->check_action($p_action)==0)
         {
             $this->audit('FAIL');
             if ($p_js==1)
             {
                 echo create_script("alert_box(content[59])");
             }
             elseif ($p_js==2)
             {
                 record_log(_("Access invalid").$p_action);
             }
             else
             {
                 echo '<h2 class="error">',
                 htmlspecialchars(_("Cette action ne vous est pas autorisée Contactez votre responsable")),
                 '</h2>';
                 echo '</div>';
             }
             exit(-1);
         }
     }

◆ can_write_action()

User::can_write_action ( $dtoc )

Check if the profile of the user can write for this profile.

Parameters

$dtoc action_gestion.ag_id

Returns: true if he can write otherwise false

Definition at line 1517 of file user.class.php.

     {
         if ($this->Admin()==1)
             return TRUE;
         if ($this->get_status_security_action()==0)
             return TRUE;
         $profile=$this->get_profile();
         $r=$this->db->get_value(" select count(*) from action_gestion where ag_id=$1 and ag_dest in
                                 (select p_granted from user_sec_action_profile where ua_right in ('W','O') and p_id=$2) ", array($dtoc, $profile));
         if ($r==0)
             return FALSE;
         return true;
     }

◆ can_write_repo()

User::can_write_repo ( $p_repo )

Check if the profile of the user can write for this repository.

Parameters

$p_repo stock_repository.r_id

Returns: true if he can write otherwise false

Definition at line 1573 of file user.class.php.

     {
         if ($this->Admin()==1)
             return true;
         $profile=$this->get_profile();
         $r=$this->db->get_value("select count(*)
                 from profile_sec_repository
                 where
                 r_id=$1
                 and p_id =$2
                 and ur_right='W'", array($p_repo, $profile));
         if ($r==0)
             return false;
         return true;
     }

◆ Check()

User::Check	(	$silent = `false`,
		$from = `''`
	)

Check if user is active and exists in therepository Automatically redirect, it doesn't check if a user can access a folder.

Parameters

$silent false, echo an error message and exit, true : exit without warning default is false

++

Definition at line 405 of file user.class.php.

     {
  
         $res=0;
         $pass5=$this->password;
  
         $cn=new Database();
         $sql="select ac_users.use_login,ac_users.use_active, ac_users.use_pass,
              use_admin,use_first_name,use_name
              from ac_users
              where ac_users.use_id=$1 
              and ac_users.use_active=1
              and ac_users.use_pass=$2";
         $ret=$cn->exec_sql($sql, array($this->id, $pass5));
         $res=Database::num_row($ret);
         if ($res>0)
         {
             $r=Database::fetch_array($ret, 0);
             $_SESSION[SESSION_KEY.'use_admin']=$r['use_admin'];
             $_SESSION[SESSION_KEY.'use_name']=$r['use_name'];
             $_SESSION[SESSION_KEY.'use_first_name']=$r['use_first_name'];
             $_SESSION[SESSION_KEY.'isValid']=1;
  
             $this->admin=$_SESSION[SESSION_KEY.'use_admin'];
             $this->name=$_SESSION[SESSION_KEY.'use_name'];
             $this->first_name=$_SESSION[SESSION_KEY.'use_first_name'];
             $this->load_global_pref();
         }
         $sql="insert into audit_connect (ac_user,ac_ip,ac_module,ac_url,ac_state) values ($1,$2,$3,$4,$5)";
  
         if ($res==0 || $this->can_connect() == 0)
         {
             $cn->exec_sql($sql,
                     array($_SESSION[SESSION_KEY.'g_user'], $_SERVER["REMOTE_ADDR"],
                         $from, $_SERVER['REQUEST_URI'], 'FAIL'));
             if (!$silent)
             {
                 echo '<script> alert(\''._('Utilisateur ou mot de passe incorrect').'\')</script>';
                 redirect('index.html');
             }
             $this->valid=0;
             session_unset();
             exit-1;
         }
         else
         {
             if ($from=='LOGIN' || $from=='PORTAL') 
             {
                 $cn->exec_sql($sql,
                         array($_SESSION[SESSION_KEY.'g_user'], $_SERVER["REMOTE_ADDR"], $from,
                             $_SERVER['REQUEST_URI'], 'SUCCESS'));
             }
             $this->valid=1;
         }
  
         return $ret;
     }

References $cn, $from, $password, $r, $res, $ret, $sql, can_connect(), DatabaseCore\fetch_array(), index, load_global_pref(), name, and DatabaseCore\num_row().

Here is the call graph for this function:

◆ check_action()

User::check_action ( $p_action_id )

Check if an user is allowed to do an action.

Parameters

p_action_id

Returns

0 no priv

1 priv granted
See also
constant.security.php

Definition at line 852 of file user.class.php.

     {
         /*  save it into the log */
         global $audit;
         if ($this->Admin()==1)
             return 1;
         if ($this->is_local_admin(dossier::id())==1)
             return 1;
         if ($this->get_status_security_action()==0)
             return 1;
         $Res=$this->db->exec_sql(
                 "select * from user_sec_act where ua_login=$1 and ua_act_id=$2", array($this->login, $p_action_id));
         $Count=Database::num_row($Res);
         if ($Count==0)
         {
             if (isset($audit)&&$audit==true)
             {
                 $cn=new Database();
                 $sql="insert into audit_connect (ac_user,ac_ip,ac_module,ac_url,ac_state) values ($1,$2,$3,$4,$5)";
                 $cn->exec_sql($sql,
                         array($_SESSION[SESSION_KEY.'g_user'], $_SERVER["REMOTE_ADDR"], $p_action_id, $_SERVER['REQUEST_URI'],
                             'FAIL'));
             }
             return 0;
         }
         if ($Count==1)
             return 1;
         echo_error(_("Action invalide"));
         record_log("User:check_action".sprintf("login %s ua_act_id %s", $this->login, $p_action_id));
         exit();
     }

◆ check_dossier()

User::check_dossier	(	$p_dossier_id,
		$silent = `false`
	)

check if an user can access a folder, if he cannot display a dialog box and exit

Parameters

the	folder if
$silent	false, echo an error message and exit, true : exit without warning default is false

Returns

L for administrator (local and global)
X no access
R regular user

Definition at line 1209 of file user.class.php.

     {
         $this->Admin();
         if ($this->admin==1||$this->is_local_admin($p_dossier_id)==1)
             return 'L';
         $cn=new Database();
  
         $dossier=$cn->get_value("select 'R' from jnt_use_dos where dos_id=$1 and use_id=$2",
                 array($p_dossier_id, $this->id));
         $dossier=($dossier=='')?'X':$dossier;
         if ($dossier=='X')
         {
             $this->audit('FAIL', "Access folder ");
             if (!$silent)
             {
                 alert(_('Dossier non accessible'));
                 exit();
             }
         }
         return $dossier;
     }

◆ check_jrn()

User::check_jrn ( $p_jrn )

check the access of an user on a ledger

Parameters

$p_jrn the ledger id

Returns

O only predefined operation
W write
R read only
X no access

Definition at line 1193 of file user.class.php.

     {
         return $this->get_ledger_access($p_jrn);
     }

◆ check_module()

User::check_module ( $p_module )

Check if an user can access a module, return 1 if yes, otherwise 0 record in audit log This function works only if user is connected to a Folder.

Parameters

string $p_module menu_ref.me_code

Returns: 0 for FORBIDDEN, 1 for GRANTED

Definition at line 823 of file user.class.php.

     {
         if ( $this->access_mode == "PC") {
  
             $acc=$this->db->get_value("select count(*) from v_all_menu where p_id = $1
                     and me_code=$2", array($this->get_profile(), $p_module));
         } elseif ($this->access_mode=="MOBILE") {
             $acc=$this->db->get_value("select count(*) from profile_mobile where p_id=$1 and me_code=$2",
                     array($this->get_profile(), $p_module));
         } else {
             throw new Exception("USER:823:ACCESS_MODE INCONNU");
         }
         if ($acc==0)
         {
             $this->audit("FAIL", $p_module);
             return 0;
         }
         $this->audit("SUCCESS", $p_module);
         return 1;
     }

◆ check_print()

User::check_print ( $p_action )

Check if the user can print (in menu_ref p_type_display=p) otherwise warn and exit.

Parameters

$p_action requested action

Returns: nothing the program exits automatically

Definition at line 1060 of file user.class.php.

     {
         global $audit, $cn;
         $this->audit('AUDIT', $p_action);
         if ($this->Admin()==1)
             return 1;
  
         $res=$cn->get_value("select count(*) from profile_menu
                         join profile_user using (p_id)
                         where user_name=$1 and me_code=$2 ", array($this->login, $p_action));
         return $res;
     }

◆ clean_session()

static User::clean_session ( )

static

clean the sessions

Definition at line 1839 of file user.class.php.

     {
  
         $aSession=$_SESSION;
         foreach($aSession as $key => $value) {
             if(DEBUGNOALYSS>1) { echo "[$key]=>[$value]";}
             
             if ( strpos($key,SESSION_KEY) === 0) {
                 unset($_SESSION[$key]);
                if(DEBUGNOALYSS>1) { echo "=> [$key] cleaned";}
             }
         }
     }

References $value.

Referenced by connect_user().

◆ connect_user()

User::connect_user ( )

private

connect the user and set the $_SESSION variables if not set thanks the $_REQUEST

Definition at line 82 of file user.class.php.

     {
         if (!isset($_SESSION[SESSION_KEY.'g_user']))
         {
             $http=new \HttpInput();
             $user_login=$http->request("p_user", "string", "");
             $user_password=$http->request("p_pass", "string", "");
             
             if ($user_login!=""&&$user_password!="")
             {
                 $_SESSION[SESSION_KEY."g_user"]=$user_login;
                 $_SESSION[SESSION_KEY."g_pass"]=md5($user_password);
             }
             else
             {
                 echo '<h2 class="error">'._('Session expirée<br>Utilisateur déconnecté').'</h2>';
                 redirect('index.php', 1);
                 exit();
             }
  
  
             if (strpos($user_login, '@mobile')!=false)
             {
                 $this->access_mode='MOBILE';
                 $this->login=str_ireplace("@mobile", "", $user_login);
             }
             else
             {
                 $this->access_mode='PC';
                 $this->login=strtolower($user_login);
             }
             
             $_SESSION[SESSION_KEY."access_mode"]=$this->access_mode;
             $_SESSION[SESSION_KEY.'g_user']=$this->login;
         }
         $this->login=$_SESSION[SESSION_KEY."g_user"];
         $this->password=$_SESSION[SESSION_KEY.'g_pass'];
         
         $this->id=-1;
         $this->lang=(isset($_SESSION[SESSION_KEY.'g_lang']))?$_SESSION[SESSION_KEY.'g_lang']:'fr_FR.utf8';
         $this->access_mode=$_SESSION[SESSION_KEY."access_mode"];
         $cn=new Database();           
         
         if ($this->can_connect() == 0 || $this->load()==-1  )
         {
            echo '<h2 class="error">'._('Utilisateur ou mot de passe incorrect').'</h2>';
            $sql="insert into audit_connect (ac_user,ac_ip,ac_module,ac_url,ac_state) values ($1,$2,$3,$4,$5)";
            $cn->exec_sql($sql,
                         array($_SESSION[SESSION_KEY.'g_user'], $_SERVER["REMOTE_ADDR"], "DISCON",
                             $_SERVER['REQUEST_URI'], 'FAIL'));
            $this->clean_session();
            redirect('logout.php', 1);
            exit();
         }
  
         $this->load_global_pref();
  
         $_SESSION[SESSION_KEY.'g_lang']=$this->lang;
         $this->valid=(isset($_SESSION[SESSION_KEY.'isValid']))?1:0;
         if (isset($_SESSION[SESSION_KEY.'g_theme']))
         {
             $this->theme=$_SESSION[SESSION_KEY.'g_theme'];
         }
         $_SESSION[SESSION_KEY.'use_admin']=$this->admin;
         $_SESSION[SESSION_KEY.'use_name']=$this->name;
         $_SESSION[SESSION_KEY.'use_first_name']=$this->first_name;
     }

References $access_mode, $admin, $cn, $first_name, $http, $login, $name, $sql, $user_password, can_connect(), clean_session(), exit, load(), load_global_pref(), and redirect().

Referenced by __construct().

Here is the call graph for this function:

◆ get_access_mode()

User::get_access_mode ( )

access_mode tells what mode must be used : pc or mobile

Definition at line 153 of file user.class.php.

     {
         return $this->access_mode;
     }

References $access_mode.

◆ get_available_folder()

User::get_available_folder ( $p_filter = "" )

Get all the available folders for the users, checked with the security.

Parameters

$p_filter

Returns

array containing

ac_dossier.dos_id
ac_dossier.dos_name
ac_dossier.dos_description

Definition at line 1323 of file user.class.php.

     {
         $cn=new Database();
         $filter="";
         if ($this->admin==0)
         {
             // show only available folders
             // if user is not an admin
             $Res=$cn->exec_sql("select 
                                                 distinct dos_id,dos_name,dos_description 
                             from ac_users
                                                                 natural join jnt_use_dos
                                                                 natural join  ac_dossier
                             where
                                                                 use_login= $1
                                                                 and use_active = 1
                                                                 and ( dos_name ilike '%' || $2 || '%' or dos_description ilike '%' || $2 || '%' )
                             order by dos_name", array($this->login, $p_filter));
         }
         else
         {
             $Res=$cn->exec_sql("select 
                         distinct dos_id,dos_name,dos_description from ac_dossier
              where   
                    dos_name  ilike '%' || $1|| '%' or dos_description ilike '%' || $1 || '%' 
                           order by dos_name", array($p_filter));
         }
  
         $max=Database::num_row($Res);
         if ($max==0)
             return 0;
  
         for ($i=0; $i<$max; $i++)
         {
             $array[]=Database::fetch_array($Res, $i);
         }
         return $array;
     }

◆ get_available_repository()

User::get_available_repository ( $p_access = 'R' )

return array of available repository

Parameters

$p_access R for read W for write

Returns: an array

Definition at line 1123 of file user.class.php.

     {
         $profile=$this->get_profile();
         $r=array();
         if ($p_access=='R')
         {
             $r=$this->db->get_array("select distinct u.r_id,r_name
                 from
                                         profile_sec_repository as u
                                         join stock_repository as s on(u.r_id=s.r_id)
                 where
                 p_id =$1
                 and ur_right='W'
                                 order by 2
                                 ", array($profile));
         }
         if ($p_access=='W')
         {
             $r=$this->db->get_array("select distinct u.r_id,r_name
                 from
                                         profile_sec_repository as u
                                         join stock_repository as s on(u.r_id=s.r_id)
                 where
                 p_id =$1 order by 2
                ", array($profile));
         }
         return $r;
     }

◆ get_exercice()

User::get_exercice ( )

Definition at line 1010 of file user.class.php.

     {
         $sql="select p_exercice from parm_periode where p_id=$1";
         $Ret=$this->db->exec_sql($sql,[$this->get_periode()]);
         if (Database::num_row($Ret)==1)
         {
             $r=Database::fetch_array($Ret, 0);
             return $r['p_exercice'];
         }
         else
             return 0;
     }

◆ get_first_week_day()

User::get_first_week_day ( )

Definition at line 1824 of file user.class.php.

     {
         $repocn=new Database();
         $result=$repocn->get_value("select parameter_value from user_global_pref where parameter_type=$1 and user_id=$2 ",
                 array("first_week_day", $this->login));
         if ($repocn->count()==0)
         {
             $this->save_global_preference("first_week_day", 1);
             return 1;
         }
         return $result;
     }

References $result, and save_global_preference().

Here is the call graph for this function:

◆ get_folder_access()

User::get_folder_access ( $p_dossier = 0 )

return the access to a folder,

Parameters

$p_dossier id if it is == 0 then we take the value from $_SESSION

Returns

the priv_priv

X no access
R has access (normal user)

Definition at line 472 of file user.class.php.

     {
  
         if ($p_dossier==0)
             $p_dossier=dossier::id();
         if ($this->admin==1)
             return 'R';
         $cn=new Database();
  
         $sql="select 'R' from jnt_use_dos where use_id=$1 and dos_id=$2";
  
         $res=$cn->get_value($sql, array($this->id, $p_dossier));
  
         if ($cn->get_affected()==0)
             return 'X';
         return $res;
     }

◆ get_ledger()

User::get_ledger	(	$p_type = `'ALL'`,
		$p_access = `3`,
		$disable = `TRUE`
	)

get all the available ledgers for the current user

Parameters

$p_type	= ALL or the type of the ledger (ACH,VEN,FIN,ODS)
$p_access	=3 for Read or WRITE, 2 write, 1 for readonly
(boolean)	$all if true show also inactive

Returns

a double array of available ledgers

[0] => [jrn_def_id]
[jrn_def_type]
[jrn_def_name]
[jrn_def_class_deb]
[jrn_def_class_cred]
[jrn_type_id]
[jrn_desc]
[uj_priv]

Definition at line 560 of file user.class.php.

     {
         $p_type=strtoupper($p_type);
         if (!in_array($p_type, ["FIN", "ALL", "ODS", "VEN", 'ACH']))
         {
             record_log(sprintf("UGL1, p_type %s", $p_type));
             throw new Exception("UGL1"._("Type incorrecte"));
         }
         if ($disable==TRUE)
         {
             $sql_enable="";
         }
         else
         {
             $sql_enable="and jrn_enable=1";
         }
         if ($this->admin!=1&&$this->is_local_admin()!=1&&$this->get_status_security_ledger()==1)
         {
             $sql_type=($p_type=='ALL')?'':"and jrn_def_type=upper('".sql_string($p_type)."')";
             switch ($p_access)
             {
                 case 3:
                     $sql_access=" and uj_priv!= 'X' ";
                     break;
                 case 2:
                     $sql_access=" and uj_priv = 'W' and jrn_enable=1 ";
                     break;
  
                 case 1:
                     $sql_access=" and ( uj_priv = 'R' or uj_priv='W') ";
                     break;
             }
  
             $sql="select jrn_def_id,jrn_def_type,
                  jrn_def_name,jrn_def_class_deb,jrn_def_class_cred,jrn_type_id,jrn_desc,uj_priv,
                  jrn_deb_max_line,jrn_cred_max_line,jrn_def_description,jrn_enable
                  from jrn_def join jrn_type on jrn_def_type=jrn_type_id
                  join user_sec_jrn on uj_jrn_id=jrn_def_id
                  where
                  uj_login='".$this->login."'".
                     $sql_type.$sql_access.$sql_enable.
                     " order by jrn_Def_name";
         }
         else
         {
             $sql_type=($p_type=='ALL')?'  '.$sql_enable:"where jrn_def_type=upper('".sql_string($p_type)."')  ".$sql_enable;
             $sql="select jrn_def_id,jrn_def_type,jrn_def_name,jrn_def_class_deb,jrn_def_class_cred,jrn_deb_max_line,jrn_cred_max_line,
                  jrn_type_id,jrn_desc,'W' as uj_priv,jrn_def_description,jrn_enable
                  from jrn_def join jrn_type on jrn_def_type=jrn_type_id
                  $sql_type
                  order by jrn_Def_name";
         }
         $res=$this->db->exec_sql($sql);
         if (Database::num_row($res)==0)
             return null;
         $array=Database::fetch_all($res);
         return $array;
     }

◆ get_ledger_access()

User::get_ledger_access ( $p_ledger )

check that a user is valid and the access to the folder

Parameters

$p_ledger the ledger to check

Returns

the priv_priv

O only predefined operation
W write
R read only
X no access

Definition at line 529 of file user.class.php.

     {
         if ($this->admin==1||
                 $this->is_local_admin(dossier::id())==1||$this->get_status_security_ledger()==0)
             return 'W';
  
         $sql="select uj_priv from user_sec_jrn where uj_login=$1 and uj_jrn_id=$2";
         $res=$this->db->get_value($sql, array($this->login, $p_ledger));
  
         if ($res=='')
             $res='X';
         return $res;
     }

◆ get_ledger_sql()

User::get_ledger_sql	(	$p_type = `'ALL'`,
		$p_access = `3`
	)

return an sql condition for filtering the permitted ledger

Parameters

$p_type	= ALL or the type of the ledger (ACH,VEN,FIN,ODS)
$p_access	=3 for READ or WRITE, 2 READ and write, 1 for readonly

Returns: sql condition like = jrn_def_id in (...)

Definition at line 626 of file user.class.php.

     {
         $aLedger=$this->get_ledger($p_type, $p_access);
         if (empty($aLedger))
             return ' jrn_def_id < 0 ';
         $sql=" jrn_def_id in (";
         foreach ($aLedger as $row)
         {
             $sql.=$row['jrn_def_id'].',';
         }
         $sql.='-1)';
         return $sql;
     }

◆ get_limit_current_exercice()

User::get_limit_current_exercice ( )

return the first date and the last date of the current exercice for the current user

Returns: and array ([0] => start_date,[1] => end_date)

Definition at line 1235 of file user.class.php.

     {
         $current_exercice=$this->get_exercice();
         $periode=new Periode($this->db);
         list($per_start, $per_end)=$periode->get_limit($current_exercice);
         $start=$per_start->first_day();
         $end=$per_end->last_day();
         return array($start, $end);
     }

◆ get_list()

static User::get_list ( $p_dossier )

static

return an array with all the active users who can access $p_dossier including the global admin.

The user must be activated

Parameters

$p_dossier dossier

Returns

an array of user's object array indices

use_id (id )
use_login (login of the user)
use_name
use_first_name

Exceptions

throw an exception if nobody can access

Definition at line 1167 of file user.class.php.

     {
         $sql="select distinct use_id,use_login,use_first_name,use_name from ac_users
              left outer join  jnt_use_dos using (use_id)
              where
               (dos_id=$1 and use_active=1) or (use_active=1 and use_admin=1)
               order by use_login,use_name";
  
         $repo=new Database();
         $array=$repo->get_array($sql, array($p_dossier));
         if ($repo->size()==0)
             throw new Exception('Error inaccessible folder');
         return $array;
     }

◆ get_mini_report()

User::get_mini_report ( )

return the mini rapport to display on the welcome page

Returns: 0 if nothing if found or the report to display (form_definition.fr_id)

Definition at line 734 of file user.class.php.

     {
         $array=$this->get_preference();
         $fr_id=(isset($array['MINIREPORT']))?$array['MINIREPORT']:0;
         return $fr_id;
     }

◆ get_periode()

User::get_periode ( )

Get the default periode from the user's preferences.

Returns: the default periode

Definition at line 717 of file user.class.php.

     {
  
         $array=$this->get_preference();
         if (!isset($array['PERIODE']))
         {
             $this->set_default_periode();
             $array=$this->get_preference();
         }
         return $array['PERIODE'];
     }

◆ get_preference()

User::get_preference ( )

Get the default user's preferences.

Returns: array of (parameter_type => parameter_value)

Definition at line 791 of file user.class.php.

     {
         $sql="select parameter_type,parameter_value from user_local_pref where user_id=$1";
         $Res=$this->db->exec_sql($sql, array($this->id));
         $l_array=array();
         for ($i=0; $i<Database::num_row($Res); $i++)
         {
             $row=Database::fetch_array($Res, $i);
             $type=$row['parameter_type'];
             $l_array[$type]=$row['parameter_value'];
         }
         $repo=new Database();
         $a_global_pref=$repo->get_array("select parameter_type,parameter_value from user_global_pref 
                                                                         where 
                                                                         upper(user_id) = upper($1)", [$this->login]);
         $nb_global=count($a_global_pref);
         for ($i=0; $i<$nb_global; $i++)
         {
             $idx=$a_global_pref[$i]['parameter_type'];
             $value=$a_global_pref[$i]['parameter_value'];
             $l_array[$idx]=$value;
         }
  
         return $l_array;
     }

◆ get_profile()

User::get_profile ( )

return the profile (p_id)

Returns: profile.p_id

Definition at line 1422 of file user.class.php.

     {
         $profile=$this->db->get_value("select p_id from profile_user where
                                 lower(user_name)=lower($1) ", array($this->login));
         return $profile;
     }

◆ get_readable_profile()

User::get_readable_profile ( )

return array of readable action_profile

Definition at line 1465 of file user.class.php.

     {
        $value=$this->db->get_array("select p_granted from ".$this->sql_readable_profile()." as m") ;
        $aGranted=array_column($value,"p_granted");
        return $aGranted;
     }

◆ get_status_security_action()

User::get_status_security_action ( )

Check the security on ledger for the user , it returns 1 if the security on ledgers is enabled, otherwise 0.

Definition at line 1789 of file user.class.php.

     {
         $security=$this->db->get_value("select us_action from user_active_security 
                 where 
                 us_login=$1", [$this->login]);
         $n_security=($security=="Y")?1:0;
         return $n_security;
     }

References db.

◆ get_status_security_ledger()

User::get_status_security_ledger ( )

Check the security on ledger for the user , it returns 1 if the security on ledgers is enabled, otherwise 0.

Definition at line 1753 of file user.class.php.

     {
         $security=$this->db->get_value("select us_ledger from user_active_security 
                 where 
                 us_login=$1", [$this->login]);
         $n_security=($security=="Y")?1:0;
         return $n_security;
     }

References db.

◆ get_writable_profile()

User::get_writable_profile ( )

return array of writable action_profile

Definition at line 1455 of file user.class.php.

     {
        $value=$this->db->get_array("select p_granted from ".$this->sql_writable_profile()." as m") ;
        $aGranted=array_column($value,"p_granted");
        return $aGranted;
     }

◆ getActive()

User::getActive ( )

Returns: mixed

Definition at line 266 of file user.class.php.

     {
         return $this->active;
     }

References $active.

◆ getAdmin()

User::getAdmin ( )

Returns: default|int|mixed|string|string[]|null

Definition at line 202 of file user.class.php.

     {
         return $this->admin;
     }

References $admin.

◆ getDb()

User::getDb ( )

Returns: mixed

Definition at line 186 of file user.class.php.

     {
         return $this->db;
     }

References $db.

◆ getEmail()

User::getEmail ( )

Returns: mixed

Definition at line 314 of file user.class.php.

     {
         return $this->email;
     }

References $email.

◆ getFirstName()

User::getFirstName ( )

Returns: default|mixed|string|string[]|null

Definition at line 234 of file user.class.php.

     {
         return $this->first_name;
     }

References $first_name.

◆ getId()

User::getId ( )

Returns: int|mixed

Definition at line 170 of file user.class.php.

                            : int
     {
         return $this->id;
     }

References $id.

◆ getLogin()

User::getLogin ( )

Returns: string

Definition at line 282 of file user.class.php.

                               : string
     {
         return $this->login;
     }

References $login.

◆ getName()

User::getName ( )

Returns: default|mixed|string|string[]|null

Definition at line 250 of file user.class.php.

     {
         return $this->name;
     }

References $name.

◆ getPassword()

User::getPassword ( )

Returns: mixed

Definition at line 298 of file user.class.php.

     {
         return $this->password;
     }

References $password.

◆ getValid()

User::getValid ( )

Returns: int

Definition at line 218 of file user.class.php.

                               : int
     {
         return $this->valid;
     }

References $valid.

◆ grant_admin_access()

static User::grant_admin_access	(	$p_login,
		$p_dossier
	)

static

Grant access to folder, grant administrator profile , all the ledgers and all the action.

Definition at line 1681 of file user.class.php.

     {
         $repo_cnx=new Database();
         $user=$repo_cnx->get_array("select use_id,use_login
                                 from ac_users
                                 where use_login=$1", array($p_login));
  
         if (!$user)
             return false;
         $cn_dossier=new Database($p_dossier);
         // if not access to DB
         if (
                 $repo_cnx->get_value("select count(*) from jnt_use_dos where use_id=$1 and dos_id=$2",
                         array($user[0]['use_id'], $p_dossier))==0
         )
         {
             $repo_cnx->exec_sql("insert into jnt_use_dos(use_id,dos_id) values ($1,$2)",
                     array($user[0]['use_id'], $p_dossier));
         }
         //------  Give him the admin menu
         if ($cn_dossier->get_value("select count(*) from profile_user where user_name=$1", array($user[0]['use_login']))==0)
         {
             $cn_dossier->exec_sql('insert into profile_user(user_name,p_id) values($1,1)', array($user[0]['use_login']));
         }
         // Grant all action + ledger to him
         $cn_dossier->exec_sql("delete from user_sec_act where ua_login=$1", array($p_login));
  
         $cn_dossier->exec_sql("insert into user_sec_act (ua_login,ua_act_id)"
                 ." select $1 ,ac_id from action ", array($p_login));
  
         $cn_dossier->exec_sql("delete from user_sec_jrn where uj_login=$1", array($p_login));
         $cn_dossier->exec_sql("insert into user_sec_jrn(uj_login,uj_jrn_id,uj_priv)"
                 ." select $1,jrn_def_id,'W' from jrn_def", array($p_login));
     }

Referenced by Dossier\synchro_admin().

◆ insert()

User::insert ( )

Definition at line 384 of file user.class.php.

     {
  
         $Sql="INSERT INTO ac_users(
                         use_first_name, use_name, use_login, use_active,  
                         use_admin, use_pass, use_email)
                             VALUES ($1, $2, $3, $4, $5, $6, $7) returning use_id";
  
         $cn=new Database();
         $this->id=$cn->get_value($Sql,
                 array($this->first_name, $this->last_name, $this->login, 1, $this->admin, 
                     $this->password, $this->email));
     }

References $cn.

◆ insert_default_global_pref()

User::insert_default_global_pref	(	$p_type = `""`,
		$p_value = `""`
	)

insert default pref if no parameter are given insert all the existing parameter otherwise only the requested

Parameters

$p_type	parameter's type or nothing
$p_value	parameter value

Definition at line 942 of file user.class.php.

     {
  
         $default_parameter=array("THEME"=>"classic",
             "PAGESIZE"=>"50",
             'TOPMENU'=>'TEXT',
             'LANG'=>'fr_FR.utf8',
             'csv_fieldsep'=>'0',
             'csv_decimal'=>'0',
             'csv_encoding'=>'utf8',
             'first_week_day'=>1
         );
         $cn=new Database();
         $sql="insert into user_global_pref(user_id,parameter_type,parameter_value)
              values ($1,$2,$3)";
         if ($p_type=="")
         {
             foreach ($default_parameter as $name=> $value)
             {
                 $cn->exec_sql($sql, array($this->login, $name, $value));
             }
         }
         else
         {
             $value=($p_value=="")?$default_parameter[$p_type]:$p_value;
             if ( $cn->get_value("select count(*) from user_global_pref where user_id=$1 and parameter_type=$2",
                 array($this->login,$p_type)) == 1)
             {
                 $cn->exec_sql("update user_global_pref set parameter_value=$1 where user_id=$2 and parameter_type=$3",
                         array($value,$this->login,$p_type));
             } else {
                 $cn->exec_sql($sql, array($this->login, $p_type, $value));
             }
         }
     }

◆ is_local_admin()

User::is_local_admin ( $p_dossier = -1 )

Check if an user is an local administrator.

Deprecated:: since version 6.7

Parameters

$p_dossier : dossier_id

Returns

0 if no

1 if yes

Definition at line 1112 of file user.class.php.

     {
         return 0;
     }

◆ isAdmin()

User::isAdmin ( )

Check if an user is an admin.

Returns: 1 for yes 0 for no

Definition at line 654 of file user.class.php.

     {
         $this->admin=0;
         $pass5=$this->password;
         $sql="select count(*) from ac_users where use_login=$1
              and use_active=1 and use_admin=1 ";
  
         $cn=new Database();
         $this->admin=$cn->get_value($sql, array($this->login));
         return $this->admin;
     }

◆ load()

User::load ( )

Definition at line 333 of file user.class.php.

     {
         /* if this->id == -1, it is unknown so we have to retrieve it from
           the database thanks it login */
         if ($this->id<0)
         {
             $sql_cond="   where lower(use_login)=lower($1)";
             $sql_array=array($this->login);
         }
         else
         {
             $sql_cond="   where use_id=$1";
             $sql_array=array($this->id);
         }
         $sql="select use_id,
                             use_first_name,
                             use_name,
                             use_login,
                             use_active,
                             use_admin,
                             use_pass,
                             use_email
                         from ac_users ";
         $cn=new Database();
         $Res=$cn->exec_sql($sql.$sql_cond, $sql_array);
         if (($Max=Database::num_row($Res))==0)
             return -1;
         $row=Database::fetch_array($Res, 0);
         $this->id=$row['use_id'];
         $this->first_name=$row['use_first_name'];
         $this->last_name=$row['use_name'];
         $this->name=$row['use_name'];
         $this->active=$row['use_active'];
         $this->login=strtolower($row['use_login']);
         $this->admin=$row['use_admin'];
         $this->password=$row['use_pass'];
         $this->email=$row['use_email'];
         return $this->id;
     }

References $cn, $id, $Max, $Res, $row, $sql, $sql_array, DatabaseCore\fetch_array(), name, and DatabaseCore\num_row().

Referenced by __construct(), and connect_user().

Here is the call graph for this function:

◆ load_global_pref()

User::load_global_pref ( )

Get the global preferences from user_global_pref in the account_repository db.

Note: set $SESSION[g_variable]

Definition at line 890 of file user.class.php.

     {
         $cn=new Database();
         // Load everything in an array
         $Res=$cn->exec_sql("select parameter_type,parameter_value from
                             user_global_pref
                             where user_id=$1", [$this->login]);
         $Max=Database::num_row($Res);
         if ($Max==0)
         {
             $this->insert_default_global_pref();
             $this->load_global_pref();
             return;
         }
         // Load value into array
         $line=array();
         for ($i=0; $i<$Max; $i++)
         {
             $row=Database::fetch_array($Res, $i);
             $type=$row['parameter_type'];
             $line[$type]=$row['parameter_value'];
         }
         // save array into g_ variable
         $array_pref=array('g_theme'=>'THEME',
             'g_pagesize'=>'PAGESIZE',
             'g_topmenu'=>'TOPMENU',
             'g_lang'=>'LANG',
             'csv_fieldsep'=>'csv_fieldsep',
             'csv_decimal'=>'csv_decimal',
             'csv_encoding'=>'csv_encoding',
             'first_week_day'=>'first_week_day');
  
         foreach ($array_pref as $name=> $parameter)
         {
             if (!isset($line[$parameter]))
             {
                 $this->insert_default_global_pref($parameter);
                 $this->load_global_pref();
                 return;
             }
             $_SESSION[SESSION_KEY.$name]=$line[$parameter];
         }
     }

Referenced by Check(), and connect_user().

◆ password_to_session()

User::password_to_session ( )

store the password in session

Definition at line 1612 of file user.class.php.

     {
           $_SESSION[SESSION_KEY.'g_pass']=$this->getPassword();
     }

◆ remove_inexistant_user()

static User::remove_inexistant_user ( $p_dossier )

static

Definition at line 1716 of file user.class.php.

     {
         $cnx_repo=new Database();
         $name=$cnx_repo->format_name($p_dossier, 'dos');
         if ($cnx_repo->exist_database($name)==0)
             return;
         $cnx_dossier=new Database($p_dossier);
         if ($cnx_dossier->exist_table('profile_user'))
             $a_user=$cnx_dossier->get_array('select user_name from profile_user');
         else
             return;
  
         if (!$a_user)
             return;
         $nb=count($a_user);
         for ($i=0; $i<$nb; $i++)
         {
             if ($cnx_repo->get_value('select count(*) from ac_users where use_login=$1', array($a_user[$i]['user_name']))==0)
             {
                 if ($cnx_dossier->exist_table('user_sec_jrn'))
                     $cnx_dossier->exec_sql("delete from user_sec_jrn where uj_login=$1", array($a_user[$i]['user_name']));
                 $cnx_dossier->exec_sql("delete from profile_user where user_name=$1", array($a_user[$i]['user_name']));
                 if ($cnx_dossier->exist_table('user_sec_act'))
                     $cnx_dossier->exec_sql("delete from user_sec_act where ua_login=$1", array($a_user[$i]['user_name']));
                 if ($cnx_dossier->exist_table('user_sec_jrn'))
                     $cnx_dossier->exec_sql("delete from user_sec_jrn where uj_login=$1", array($a_user[$i]['user_name']));
                 if ($cnx_dossier->exist_table('user_active_security'))
                     $cnx_dossier->exec_sql("delete from user_active_security where us_login=$1",
                             array($a_user[$i]['user_name']));
             }
         }
     }

References $i, $name, and $nb.

Referenced by Dossier\upgrade().

◆ revoke_access()

static User::revoke_access	(	$p_login,
		$p_dossier
	)

static

Remove a user and all his privileges So it cannot connect anymore and all his privileges are removed from the dossier.

Definition at line 1657 of file user.class.php.

     {
         // connect to the repository
         $repo_cnx=new Database();
  
         // Retrieve the user
         $user=$repo_cnx->get_array('select use_id,use_login from ac_users where use_login=$1', array($p_login));
         if (!$user)
             return false;
  
         // remove him from jnt_use_dos
         $repo_cnx->exec_sql("delete from jnt_use_dos WHERE use_id=$1 and dos_id=$2",
                 array($user[0]['use_id'], $p_dossier));
  
         // Remove user from user's dossier
         $cn_dossier=new Database($p_dossier);
         $cn_dossier->exec_sql("delete from profile_user where user_name=$1", array($p_login));
         $cn_dossier->exec_sql("delete from user_sec_act where ua_login=$1", array($p_login));
     }

◆ save()

User::save ( )

Definition at line 373 of file user.class.php.

     {
  
         $Sql="update ac_users set use_first_name=$1, use_name=$2
              ,use_active=$3,use_admin=$4,use_pass=$5 ,use_email = $7 where use_id=$6";
         $cn=new Database();
         $Res=$cn->exec_sql($Sql,
                 array($this->first_name, $this->last_name, $this->active, $this->admin, $this->password, 
                     $this->id, $this->email));
     }

References $cn, and $Res.

◆ save_email()

User::save_email ( $p_email )

Save the password from PREFERENCE MODULE.

Parameters

type $p_email

Definition at line 1644 of file user.class.php.

     {
         $repo=new Database();
         $repo->exec_sql("update ac_users set use_email=$1 where use_login=$2",
                 array($p_email, $_SESSION[SESSION_KEY.'g_user']));
     }

◆ save_global_preference()

User::save_global_preference	(	$key,
		$value
	)

Save the preference , the scope is global, the settings are saved into account_repository.

Parameters

$key	THEME, LANG , PAGESIZE
$value	value of the key

Definition at line 767 of file user.class.php.

     {
         $repo=new Database();
         $count=$repo->get_value("select count(*)
             from
             user_global_pref
             where
             parameter_type=$1 and user_id=$2", array($key, $this->login));
         if ($count==1)
         {
             $repo->exec_sql("update user_global_pref set parameter_value=$1
                 where parameter_type=$2 and user_id=$3", array($value, $key, $this->login));
         }
         elseif ($count==0)
         {
             $repo->exec_sql("insert into user_global_pref(user_id,parameter_type,parameter_value)
                 values($1,$2,$3)", array($this->login, $key, $value));
         }
     }

Referenced by get_first_week_day().

◆ save_password()

User::save_password	(	$p_pass1,
		$p_pass2
	)

Save the password of the current user.

Parameters

string	$p_pass1	password (clear)
string	$p_pass2	for confirming password (clear)

Returns: true : password successfully changed otherwise false

Definition at line 1622 of file user.class.php.

     {
         if ($p_pass1==$p_pass2)
         {
             $repo=new Database();
             $l_pass=md5($p_pass1);
             $this->setPassword($l_pass);
             $repo->exec_sql("update ac_users set use_pass=$1 where use_login=$2",
                     array($l_pass, $this->login));
             return true;
         }
         else
         {
             
             return false;
         }
     }

◆ save_profile()

User::save_profile ( $p_id )

Definition at line 1404 of file user.class.php.

     {
         $count=$this->db->get_value("select count(*) from profile_user where user_name=$1", array($this->login));
         if ($count==0)
         {
             $this->db->exec_sql("insert into profile_user(p_id,user_name)
                                                                 values ($1,$2)", array($p_id, $this->login));
         }
         else
         {
             $this->db->exec_sql("update profile_user set p_id=$1 where user_name=$2", array($p_id, $this->login));
         }
     }

◆ set_access_mode()

User::set_access_mode ( $access_mode )

access_mode tells what mode must be used : pc or mobile

Definition at line 161 of file user.class.php.

                                                  : object
     {
         $this->access_mode=$access_mode;
         return $this;
     }

References $access_mode.

◆ set_default_periode()

User::set_default_periode ( )

private

Definition at line 679 of file user.class.php.

     {
  
         /* get the first periode */
         $sql='select min(p_id) as pid '
                 .' from parm_periode '
                 .' where p_closed = false and p_start = (select min(p_start) from parm_periode)';
         $Res=$this->db->exec_sql($sql);
  
         $pid=Database::fetch_result($Res, 0, 0);
         /* if all the periode are closed, then we use the last closed period */
         if ($pid==null)
         {
             $sql='select min(p_id) as pid '
                     .'from parm_periode '
                     .'where p_start = (select max(p_start) from parm_periode)';
             $Res2=$this->db->exec_sql($sql);
             $pid=Database::fetch_result($Res2, 0, 0);
             if ($pid==null)
             {
                 throw new Exception(_("Aucune période trouvéee !!!"));
             }
  
             $pid=Database::fetch_result($Res2, 0, 0);
         }
  
         $sql=sprintf("insert into user_local_pref (user_id,parameter_value,parameter_type)
                      values ('%s','%d','PERIODE')", $this->id, $pid);
         $Res=$this->db->exec_sql($sql);
     }

◆ set_folder_access()

User::set_folder_access	(	$db_id,
		$priv
	)

save the access of a folder

Parameters

$db_id	the dossier id
$priv	boolean, true then it is granted, false it is removed

Definition at line 495 of file user.class.php.

     {
  
         $cn=new Database();
         if ($priv)
         {
             // the access is granted
             $jnt=$cn->get_value("select jnt_id from jnt_use_dos where dos_id=$1 and use_id=$2", array($db_id, $this->id));
  
             if ($cn->size()==0)
             {
  
                 $Res=$cn->exec_sql("insert into jnt_use_dos(dos_id,use_id) values($1,$2)", array($db_id, $this->id));
             }
         }
         else
         {
             // Access is revoked
             $cn->exec_sql('delete from jnt_use_dos where use_id  = $1 and dos_id = $2 ', array($this->id, $db_id));
         }
     }

◆ set_mini_report()

User::set_mini_report ( $p_id )

set the mini rapport to display on the welcome page

Definition at line 744 of file user.class.php.

     {
         $count=$this->db->get_value("select count(*) from user_local_pref where user_id=$1 and parameter_type=$2",
                 array($this->id, 'MINIREPORT'));
         if ($count==1)
         {
             $sql="update user_local_pref set parameter_value=$1 where user_id=$2 and parameter_type='MINIREPORT'";
             $Res=$this->db->exec_sql($sql, array($p_id, $this->id));
         }
         else
         {
             $sql="insert into user_local_pref (user_id,parameter_type,parameter_value)".
                     "values($1,'MINIREPORT',$2)";
             $Res=$this->db->exec_sql($sql, array($this->id, $p_id));
         }
     }

◆ set_periode()

User::set_periode ( $p_periode )

Set the selected periode in the user's preferences.

Parameters

	$p_periode	periode
-	$p_user

Definition at line 673 of file user.class.php.

     {
         $sql="update user_local_pref set parameter_value=$1 where user_id=$2 and parameter_type='PERIODE'";
         $Res=$this->db->exec_sql($sql, [$p_periode, $this->id]);
     }

◆ set_status_security_action()

User::set_status_security_action ( $p_value )

Set the flag in the table user_active_security.

Parameters

int $p_value 1==enable , 0 = disable @exceptions invalid value

Definition at line 1803 of file user.class.php.

     {
         if ($p_value!=0&&$p_value!=1)
             throw new Exception(_("Valeur invalide"));
         $exist=$this->db->get_value("select count(*) from user_active_security where us_login=$1", [$this->login]);
         $flag=($p_value==1)?"Y":"N";
         if ($exist==0)
         {
             $this->db->exec_sql("insert into user_active_security (us_login,us_action,us_ledger) values ($1,$2,$3)",
                     [$this->login, $flag, 'Y']);
         }
         else
         {
             $this->db->exec_sql("update user_active_security set us_action=$1 where us_login = $2",
                     [$flag, $this->login]);
         }
     }

References db.

◆ set_status_security_ledger()

User::set_status_security_ledger ( $p_value )

Set the flag in the table user_active_security.

Parameters

int $p_value 1==enable , 0 = disable @exceptions invalid value

Definition at line 1767 of file user.class.php.

     {
         if ($p_value!=0&&$p_value!=1)
             throw new Exception(_("Valeur invalide"));
         $exist=$this->db->get_value("select count(*) from user_active_security where us_login=$1", [$this->login]);
         $flag=($p_value==1)?"Y":"N";
         if ($exist==0)
         {
             $this->db->exec_sql("insert into user_active_security (us_login,us_ledger,us_action) values ($1,$2,$3)",
                     [$this->login, $flag, 'Y']);
         }
         else
         {
             $this->db->exec_sql("update user_active_security set us_ledger=$1 where us_login = $2",
                     [$flag, $this->login]);
         }
     }

References db.

◆ setActive()

User::setActive ( $active )

Parameters

mixed $active

Definition at line 274 of file user.class.php.

                                       : void
     {
         $this->active=$active;
     }

References $active.

◆ setAdmin()

User::setAdmin ( $admin )

Parameters

Definition at line 210 of file user.class.php.

                                     : void
     {
         $this->admin=$admin;
     }

References $admin.

◆ setDb()

User::setDb ( $db )

Parameters

mixed $db

Definition at line 194 of file user.class.php.

                               : void
     {
         $this->db=$db;
     }

References $db, and db.

◆ setEmail()

User::setEmail ( $email )

Parameters

mixed $email

Definition at line 322 of file user.class.php.

                                     : void
     {
         $this->email=$email;
     }

References $email.

◆ setFirstName()

User::setFirstName ( $first_name )

Parameters

default | mixed | string | string[] | null $first_name

Definition at line 242 of file user.class.php.

                                              : void
     {
         $this->first_name=$first_name;
     }

References $first_name.

◆ setId()

User::setId ( int $id )

Parameters

int | mixed $id

Definition at line 178 of file user.class.php.

                                   : void
     {
         $this->id=$id;
     }

References $id.

◆ setLogin()

User::setLogin ( string $login )

Parameters

string $login

Definition at line 290 of file user.class.php.

                                            : void
     {
         $this->login=$login;
     }

References $login.

◆ setName()

User::setName ( $name )

Parameters

default | mixed | string | string[] | null $name

Definition at line 258 of file user.class.php.

                                   : void
     {
         $this->name=$name;
     }

References $name, and name.

◆ setPassword()

User::setPassword ( $password )

Parameters

mixed $password

Definition at line 306 of file user.class.php.

                                           : void
     {
         $this->password=$password;
     }

References $password.

◆ setValid()

User::setValid ( int $valid )

Parameters

int $valid

Definition at line 226 of file user.class.php.

                                         : void
     {
         $this->valid=$valid;
     }

References $valid.

◆ show_dossier()

User::show_dossier ( $p_filtre = "" )

Show all the available folder for the users at the login page.

For the special case 'E' go directly to extension and bypasse the dashboard

Parameters

$p_filtre user

Returns: table in HTML

Definition at line 1254 of file user.class.php.

     {
         $p_array=$this->get_available_folder($p_filtre);
  
         $result="";
  
         $result.="<TABLE id=\"folder\" class=\"result\">";
         $result.="<tr>";
         $result.="<th>";
         $result.=_("Id");
         $result.="</th>";
         $result.="<th>";
         $result.=_("Nom");
         $result.="</th>";
         $result.="<th>";
         $result.=_("Description");
         $result.="</th>";
         $result.="</tr>";
         if ($p_array==0)
         {
             $result.="<tr>";
             $result.='<td style="width:auto" colspan=3>';
             $result.=_("Aucun dossier disponible");
             $result.='</td>';
             $result.="</tr>";
             return $result;
         }
  
         for ($i=0; $i<sizeof($p_array); $i++)
         {
  
             $id=$p_array[$i]['dos_id'];
             $name=$p_array[$i]['dos_name'];
             $desc=$p_array[$i]['dos_description'];
             if ($i%2==0)
                 $tr="odd";
             else
                 $tr="even";
             $target="do.php?gDossier=$id";
  
             $result.="<TR class=\"$tr\">";
  
             $result.=td($id, ' class="num" ');
             $result.="<TD class=\"$tr\">";
             $result.="<A class=\"dossier\" HREF=\"$target\">";
             $result.="  <B>".h($name)."</B>";
             $result.="</A>";
             $result.="</TD>";
             $desc=($desc=="")?"<i>Aucune description</i>":h($desc);
             $desc="<A class=\"dossier\" HREF=\"$target\">$desc</A>";
             $result.="<TD class=\"$tr\" >".$desc;
             $result.="</TD>";
             $result.="</TR>";
         }
         $result.="</TABLE>";
         return $result;
     }

◆ sql_readable_profile()

User::sql_readable_profile ( )

Compute the SQL string for the readable profile, the subselect for p_id , example p_id in $g_user->sql_readable_profile.

The administrator can read all the profiles

Returns: SQL string with the subselect for p_id

Definition at line 1478 of file user.class.php.

     {
         if ($this->admin!=1)
         {
             $sql=" (select p_granted "
                     ."     from user_sec_action_profile "
                     ."     where ua_right in ('W','R','O') and p_id=".$this->get_profile().") ";
         }
         else
         {
             $sql="(select p_id p_granted from profile)";
         }
         return $sql;
     }

◆ sql_writable_profile()

User::sql_writable_profile ( )

Compute the SQL string for the writable profile, the subselect for p_id , example p_id in $g_user->sql_writable_profile.

The administrator can access all the profiles R = Read Only W = Write and delete O = write and not delete

Returns: SQL string with the subselect for p_id

Definition at line 1437 of file user.class.php.

     {
         if ($this->admin!=1)
         {
             $sql=" (select p_granted "
                     ."     from user_sec_action_profile "
                     ."     where ua_right in ('W','O') and p_id=".$this->get_profile().") ";
         }
         else
         {
             $sql="(select p_id p_granted from profile)";
         }
         return $sql;
     }

◆ update_global_pref()

User::update_global_pref	(	$p_type,
		$p_value = `""`
	)

update default pref if value is not given then use the default value

Parameters

$p_type	parameter's type
$p_value	parameter's value value of the type

Definition at line 985 of file user.class.php.

     {
         $default_parameter=array("THEME"=>"classic",
             "PAGESIZE"=>"50",
             "LANG"=>'fr_FR.utf8',
             'TOPMENU'=>'SELECT',
             'csv_fieldsep'=>'0',
             'csv_decimal'=>'0',
             'csv_encoding'=>'utf8',
             'first_week_day'=>1
         );
         $cn=new Database();
         $Sql="update user_global_pref set parameter_value=$1
              where parameter_type=$2 and
              user_id=$3";
         $value=($p_value=="")?$default_parameter[$p_type]:$p_value;
         $cn->exec_sql($Sql, array($value, $p_type, $this->login));
     }

Field Documentation

◆ $access_mode

User::$access_mode

MOBILE or PC depending if when connecting $login contains @mobile.

Definition at line 47 of file user.class.php.

Referenced by connect_user(), get_access_mode(), and set_access_mode().

◆ $active

User::$active

1 active , 0 disables

Definition at line 43 of file user.class.php.

Referenced by getActive(), and setActive().

◆ $admin

User::$admin

is or is not admin

Definition at line 39 of file user.class.php.

Referenced by connect_user(), getAdmin(), and setAdmin().

◆ $db

User::$db

database connx

Definition at line 38 of file user.class.php.

Referenced by getDb(), and setDb().

◆ $email

User::$email

user's email

Definition at line 46 of file user.class.php.

Referenced by getEmail(), and setEmail().

◆ $first_name

User::$first_name

Definition at line 41 of file user.class.php.

Referenced by connect_user(), getFirstName(), and setFirstName().

◆ $id

User::$id

in account_repository , ac_users.use_id

Definition at line 36 of file user.class.php.

Referenced by getId(), load(), and setId().

◆ $login

User::$login

login lower case

Definition at line 44 of file user.class.php.

Referenced by connect_user(), getLogin(), and setLogin().

◆ $name

User::$name

Definition at line 42 of file user.class.php.

Referenced by connect_user(), getName(), remove_inexistant_user(), and setName().

◆ $password

User::$password

md5 of the password

Definition at line 45 of file user.class.php.

Referenced by Check(), getPassword(), and setPassword().

◆ $valid

User::$valid

is or is not valid

Definition at line 40 of file user.class.php.

Referenced by getValid(), and setValid().

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

include/class/user.class.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ Admin()

◆ audit()

◆ audit_admin()

◆ can_add_action()

◆ can_connect()

◆ can_delete_action()

◆ can_print()

◆ can_read_action()

◆ can_read_repo()

◆ can_request()

◆ can_write_action()

◆ can_write_repo()

◆ Check()

◆ check_action()

◆ check_dossier()

◆ check_jrn()

◆ check_module()

◆ check_print()

◆ clean_session()

◆ connect_user()

◆ get_access_mode()

◆ get_available_folder()

◆ get_available_repository()

◆ get_exercice()

◆ get_first_week_day()

◆ get_folder_access()

◆ get_ledger()

◆ get_ledger_access()

◆ get_ledger_sql()

◆ get_limit_current_exercice()

◆ get_list()

◆ get_mini_report()

◆ get_periode()

◆ get_preference()

◆ get_profile()

◆ get_readable_profile()

◆ get_status_security_action()

◆ get_status_security_ledger()

◆ get_writable_profile()

◆ getActive()

◆ getAdmin()

◆ getDb()

◆ getEmail()

◆ getFirstName()

◆ getId()

◆ getLogin()

◆ getName()

◆ getPassword()

◆ getValid()

◆ grant_admin_access()

◆ insert()

◆ insert_default_global_pref()

◆ is_local_admin()

◆ isAdmin()

◆ load()

◆ load_global_pref()

◆ password_to_session()

◆ remove_inexistant_user()

◆ revoke_access()

◆ save()

◆ save_email()

◆ save_global_preference()

◆ save_password()

◆ save_profile()

◆ set_access_mode()

◆ set_default_periode()

◆ set_folder_access()

◆ set_mini_report()

◆ set_periode()

◆ set_status_security_action()

◆ set_status_security_ledger()