[ Index ]
 

Code source de eGroupWare 1.2.106-2

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/setup/inc/ -> class.setup.inc.php (sommaire)

(pas de description)

Poids: 1052 lignes (32 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 2 classes

egw_dummy:: (1 méthode):
  invalidate_session_cache()

setup:: (26 méthodes):
  setup()
  loaddb()
  set_cookiedomain()
  set_cookie()
  auth()
  check_auth()
  checkip()
  get_major()
  clear_session_cache()
  register_app()
  app_registered()
  update_app()
  update_app_version()
  deregister_app()
  register_hooks()
  update_hooks()
  deregister_hooks()
  hook()
  alessthanb()
  amorethanb()
  setup_account_object()
  add_account()
  accounts_exist()
  add_acl()
  table_exist()
  set_table_names()


Classe: egw_dummy  - X-Ref

invalidate_session_cache()   X-Ref
Pas de description

Classe: setup  - X-Ref

setup($html=False, $translation=False)   X-Ref
Pas de description

loaddb($connect_and_setcharset=true)   X-Ref
include api db class for the ConfigDomain and connect to the db


set_cookiedomain()   X-Ref
Set the domain used for cookies

return: string domain

set_cookie($cookiename,$cookievalue='',$cookietime=0)   X-Ref
Set a cookie

param: string $cookiename name of cookie to be set
param: string $cookievalue value to be used, if unset cookie is cleared (optional)
param: int $cookietime when cookie should expire, 0 for session only (optional)

auth($auth_type='Config')   X-Ref
authenticate the setup user

param: $auth_type    ???

check_auth($user,$pw,$conf_user,$conf_pw)   X-Ref
check if username and password is valid

this function compares the supplied and stored username and password
as any of the passwords can be clear text or md5 we convert them to md5
internal and compare always the md5 hashs

returns: bool
param: string $user the user supplied username
param: string $pw the user supplied password
param: string $conf_user the configured username
param: string $conf_pw the configured password

checkip($remoteip='')   X-Ref
Pas de description

get_major($versionstring)   X-Ref
Return X.X.X major version from X.X.X.X versionstring

param: $

clear_session_cache()   X-Ref
Clear system/user level cache so as to have it rebuilt with the next access


register_app($appname,$enable=99)   X-Ref
Add an application to the phpgw_applications table

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice
param: $enable         * optional, set to True/False to override setup.inc.php setting

app_registered($appname)   X-Ref
Check if an application has info in the db

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice
param: $enabled    optional, set to False to not enable this app

update_app($appname)   X-Ref
Update application info in the db

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice
param: $enabled    optional, set to False to not enable this app

update_app_version($setup_info, $appname, $tableschanged = True)   X-Ref
Update application version in applications table, post upgrade

param: $setup_info         * Array of application information (multiple apps or single)
param: $appname         * Application 'name' with a matching $setup_info[$appname] array slice
param: $tableschanged    ???

deregister_app($appname)   X-Ref
de-Register an application

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice

register_hooks($appname)   X-Ref
Register an application's hooks

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice

update_hooks($appname)   X-Ref
Update an application's hooks

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice

deregister_hooks($appname)   X-Ref
de-Register an application's hooks

param: $appname    Application 'name' with a matching $setup_info[$appname] array slice

hook($location, $appname='')   X-Ref
call the hooks for a single application

param: $location hook location - required
param: $appname application name - optional

alessthanb($a,$b,$DEBUG=False)   X-Ref
egw version checking, is param 1 < param 2 in phpgw versionspeak?

param: $a    phpgw version number to check if less than $b
param: $b    phpgw version number to check $a against
return: True if $a < $b

amorethanb($a,$b,$DEBUG=False)   X-Ref
egw version checking, is param 1 > param 2 in phpgw versionspeak?

param: $a    phpgw version number to check if more than $b
param: $b    phpgw version number to check $a against
return: True if $a < $b

setup_account_object()   X-Ref
Pas de description

add_account($username,$first,$last,$passwd,$group='default',$changepw=False)   X-Ref
add an user account or a user group

if the $username already exists, only the id is returned, no new user / group gets created

param: username string alphanumerical username or groupname (account_lid)
param: first, last string first / last name
param: $passwd string cleartext pw
param: $group string/boolean Groupname for users primary group or False for a group, default 'Default'
param: $changepw boolean user has right to change pw, default False
return: the numerical user-id

accounts_exist()   X-Ref
Check if accounts other then the automatically installed anonymous account exist

We check via the account object, to deal with different account-storages

return: boolean

add_acl($apps,$location,$account,$rights=1)   X-Ref
Add ACL rights

param: $app string/array with app-names
param: $locations string eg. run
param: $account int/string accountid or account_lid
param: $rights int rights to set, default 1

table_exist($tables,$force_refresh=False)   X-Ref
checks if one of the given tables exist, returns the first match

param: array $tables array with possible table-names
return: string/boolean tablename or false

set_table_names($force_refresh=False)   X-Ref
Checks and set the names of the tables, which get accessed before an update: eg. config- and applications-table

Other tables can always use the most up to date name



Généré le : Sun Feb 25 17:20:01 2007 par Balluche grâce à PHPXref 0.7