Platform  3.1
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
User Class Reference
+ Inheritance diagram for User:
+ Collaboration diagram for User:

Public Member Functions

 SetLoginName ($loginDomain)
 
 setLogin ($login, $domain)
 
 setFid ($fid)
 
 PreInsert ()
 
 PostInsert ()
 
 PostUpdate ()
 
 PreUpdate ()
 
 PostDelete ()
 
 CheckLogin ($login, $domain, $whatid)
 
 SetUsers ($fid, $lname, $fname, $expires, $passdelay, $login, $status, $pwd1, $pwd2, $iddomain, $extmail)
 
 SetGroups ($fid, $gname, $login, $iddomain)
 
 GetExpires ()
 
 FreedomWhatUser ()
 
 computepass ($pass, &$passk)
 
 checkpassword ($pass)
 
 checkpass ($pass, $passk)
 
 getMail ()
 
 PostInit ()
 
 GetUserList ($qtype="LIST", $start=0, $slice=0, $filteruser=false)
 
 GetGroupList ($qtype="LIST")
 
 GetUserAndGroupList ($qtype="LIST")
 
 GetGroupsId ()
 
 GetRUsersList ($id, $r=array())
 
 GetUsersGroupList ($gid, $onlygroup=false)
 
 getUserMembers ()
 
 isMember ($uid)
 
 getGroupUserList ($qtype="LIST", $withgroup=false)
 
 getUserToken ($expire=false, $oneshot=false, $context=array())
 
 setAdminHtpasswd ($admin_passwd)
 
- Public Member Functions inherited from DbObj
 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 Select ($id)
 
 getValues ()
 
 AffectColumn ($fields)
 
 Affect ($array)
 
 isAffected ()
 
 Complete ()
 
 PreInsert ()
 
 PostInsert ()
 
 PreUpdate ()
 
 PostUpdate ()
 
 PreDelete ()
 
 PostDelete ()
 
 PreSelect ($id)
 
 PostSelect ($id)
 
 Add ($nopost=false, $nopre=false)
 
 Modify ($nopost=false, $sfields="", $nopre=false)
 
 Delete ($nopost=false)
 
 Adds (&$tcopy, $nopost=false)
 
 lw ($prop)
 
 CloseConnect ()
 
 Create ($nopost=false)
 
 PostInit ()
 
 init_dbid ()
 
 exec_query ($sql, $lvl=0, $prepare=false)
 
 numrows ()
 
 fetch_array ($c, $type=PGSQL_ASSOC)
 
 Update ()
 
 savePoint ($point)
 
 rollbackPoint ($point)
 
 commitPoint ($point)
 

Static Public Member Functions

static getDisplayName ($uid)
 

Data Fields

 $fields
 
 $id_fields
 
 $dbtable = "users"
 
 $order_by = "lastname, isgroup desc"
 
 $fulltextfields
 
 $sqlcreate
 
- Data Fields inherited from DbObj
 $dbid = - 1
 
 $dbaccess = ''
 
 $fields
 
 $dbtable = ''
 
 $criterias = array()
 
 $sup_fields = array()
 
 $sup_where = array()
 
 $sup_tables = array()
 
 $fulltextfields = array()
 
 $order_by = ""
 
 $isset = false
 
 $msg_err = ''
 
 $err_code = ''
 
 $res = null
 
 $debug = false
 

Additional Inherited Members

- Static Public Attributes inherited from DbObj
static $savepoint = array()
 

Detailed Description

Definition at line 32 of file Appmng/Class.User.php.

Member Function Documentation

CheckLogin (   $login,
  $domain,
  $whatid 
)

Definition at line 263 of file Appmng/Class.User.php.

checkpass (   $pass,
  $passk 
)

Definition at line 480 of file Appmng/Class.User.php.

checkpassword (   $pass)

Definition at line 474 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

computepass (   $pass,
$passk 
)

Definition at line 465 of file Appmng/Class.User.php.

FreedomWhatUser ( )

Definition at line 424 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

static getDisplayName (   $uid)
static

return display name of a user

Parameters
int$uiduser identificator
Returns
string firstname and lastname

Definition at line 284 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

GetExpires ( )

Definition at line 413 of file Appmng/Class.User.php.

GetGroupList (   $qtype = "LIST")

Definition at line 552 of file Appmng/Class.User.php.

GetGroupsId ( )

get All ascendant group ids of the user object

Definition at line 569 of file Appmng/Class.User.php.

getGroupUserList (   $qtype = "LIST",
  $withgroup = false 
)

Definition at line 678 of file Appmng/Class.User.php.

getMail ( )

return mail adress

Parameters
bool$reinitrecompute adress from mail account
Returns
string mail address empty if no mail

Definition at line 491 of file Appmng/Class.User.php.

GetRUsersList (   $id,
  $r = array() 
)

for group :: get All user & groups ids in all descendant(recursive);

Parameters
int$idgroup identificator
Returns
array of user array

Definition at line 590 of file Appmng/Class.User.php.

GetUserAndGroupList (   $qtype = "LIST")

Definition at line 560 of file Appmng/Class.User.php.

GetUserList (   $qtype = "LIST",
  $start = 0,
  $slice = 0,
  $filteruser = false 
)

Definition at line 543 of file Appmng/Class.User.php.

getUserMembers ( )

return all user members (recursive)

Returns
array of user values ["login"=>, "id"=>, "fid"=>,...)

Definition at line 637 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

GetUsersGroupList (   $gid,
  $onlygroup = false 
)

for group :: get All direct user & groups ids

Parameters
int$idgroup identificator
bool$onlygroupset to true if you want only child groups

Definition at line 616 of file Appmng/Class.User.php.

getUserToken (   $expire = false,
  $oneshot = false,
  $context = array() 
)

Get user token for open access

Parameters
int$expireset expiration delay in seconds (false if nether expire)
bool$oneshotset to true to use one token is consumed/deleted when used

Definition at line 691 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

isMember (   $uid)

verify if user is member of group (recursive)

Returns
boolean

Definition at line 660 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

PostDelete ( )

Definition at line 243 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

PostInit ( )

Definition at line 495 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

PostInsert ( )

Definition at line 196 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

PostUpdate ( )

Definition at line 221 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

PreInsert ( )

Definition at line 167 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

PreUpdate ( )

Definition at line 226 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

setAdminHtpasswd (   $admin_passwd)

Set password for the admin account in the `admin' subdir

Parameters
string$admin_passwdthe password

Definition at line 734 of file Appmng/Class.User.php.

setFid (   $fid)

affect user from its document id

Parameters
int$fid
Returns
boolean true if ok

Definition at line 154 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

SetGroups (   $fid,
  $gname,
  $login,
  $iddomain 
)

update user from FREEDOM IUSER document

Parameters
int$fiddocument id
string$loginlogin
int$iddomainmail domain identificator

Definition at line 390 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

setLogin (   $login,
  $domain 
)

affect user from its login

Parameters
string$loginlogin
Deprecated:
Returns
boolean true if ok

Definition at line 127 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

SetLoginName (   $loginDomain)

affect user from login name

Parameters
string$loginDomainlogin
Returns
boolean true if ok

Definition at line 90 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

SetUsers (   $fid,
  $lname,
  $fname,
  $expires,
  $passdelay,
  $login,
  $status,
  $pwd1,
  $pwd2,
  $iddomain,
  $extmail 
)

update user from IUSER document

Parameters
int$fiddocument id
string$loginlogin
int$iddomainmail domain identificator

Definition at line 308 of file Appmng/Class.User.php.

+ Here is the call graph for this function:

Field Documentation

$dbtable = "users"

Definition at line 55 of file Appmng/Class.User.php.

$fields
Initial value:
= array(
"id",
"iddomain",
"lastname",
"firstname",
"login",
"password",
"isgroup",
"expires",
"passdelay",
"status",
"mail",
"ntpasswordhash",
"lmpasswordhash",
"fid"
)

Definition at line 34 of file Appmng/Class.User.php.

$fulltextfields
Initial value:
= array(
"login",
"lastname",
"firstname"
)

Definition at line 59 of file Appmng/Class.User.php.

$id_fields
Initial value:
= array(
"id"
)

Definition at line 51 of file Appmng/Class.User.php.

$order_by = "lastname, isgroup desc"

Definition at line 57 of file Appmng/Class.User.php.

$sqlcreate
Initial value:
= "
create table users ( id int not null,
iddomain int not null,
primary key (id),
lastname text,
firstname text,
login text not null,
password varchar(30) not null,
isgroup char,
expires int,
passdelay int,
status char,
mail text,
ntpasswordhash text,
lmpasswordhash text,
fid int);
create index users_idx2 on users(lastname);
create index users_idx3 on users(login);
CREATE UNIQUE INDEX uni_users on users (login,iddomain);
create sequence seq_id_users start 10"

Definition at line 65 of file Appmng/Class.User.php.


The documentation for this class was generated from the following file:
← centre documentaire © anakeen - published under CC License - Dynacase