[ Index ]
 

Code source de eGroupWare 1.2.106-2

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

title

Body

[fermer]

/phpgwapi/inc/ -> class.egw.inc.php (sommaire)

(pas de description)

Poids: 515 lignes (19 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 2 fichiers
 phpgwapi/inc/functions.inc.php
 phpgwapi/inc/class.error.inc.php

Définit 1 class

egw:: (15 méthodes):
  egw()
  setup()
  __wakeup()
  wakeup2()
  load_optional_classes()
  verify_session()
  check_app_rights()
  load_theme_info()
  define_egw_constants()
  invalidate_session_cache()
  strip_html()
  link()
  redirect_link()
  redirect()
  lang()


Classe: egw  - X-Ref

New written class to create the eGW enviroment AND restore it from a php-session

egw($domain_names=null)   X-Ref
Constructor: Instantiates the sub-classes

author: RalfBecker@outdoor-training.de
param: array $domain_names array with valid egw-domain names

setup($domain_names,$createsessionobject=True)   X-Ref
Called every time the constructor is called.  Also called by sessions to ensure the correct db,
in which case we do not recreate the session object.

author: RalfBecker@outdoor-training.de (moved to setup() by milos@groupwhere.org
param: array $domain_names array with valid egw-domain names
param: boolean $createsessionobject True to create the session object (default=True)

__wakeup()   X-Ref
__wakeup function gets called by php while unserializing the egw-object, eg. reconnects to the DB

author: RalfBecker@outdoor-training.de

wakeup2()   X-Ref
wakeup2 funcontion needs to be called after unserializing the egw-object

It adapts the restored object/enviroment to the changed (current) application / page-request

author: RalfBecker@outdoor-training.de

load_optional_classes()   X-Ref
load optional classes by mentioning them in egw_info[flags][enable_CLASS_class] => true

Also loads the template-class if not egw_info[flags][disable_Template_class] is set

Maybe the whole thing should be depricated ;-)

verify_session()   X-Ref
Verfiy there is a valid session

One can specify a callback, which gets called if there's no valid session. If the callback returns true, the parameter
containst account-details (in keys login, passwd and passwd_type) to automatic create an (anonymous session)

It also checks if enforce_ssl is set in the DB and redirects to the https:// version of the site.

If there is no valid session and none could be automatic created, the function will redirect to login and NOT return

check_app_rights()   X-Ref
Verify the user has rights for the requested app

If the user has no rights for the app (eg. called via URL) he get a permission denied page (this function does NOT return)

load_theme_info()   X-Ref
Load old theme info into egw_info[theme]


define_egw_constants()   X-Ref
create all the defines / constants of the eGW-environment (plus the deprecated phpgw ones)


invalidate_session_cache()   X-Ref
force the session cache to be re-created, because some of it's data changed

Needs to be called if user-preferences, system-config or enabled apps of the current user have been changed and
the change should have immediate effect

strip_html($s)   X-Ref
run string through htmlspecialchars and stripslashes

param: string $s
return: string The string with html special characters replaced with entities

link($url = '', $extravars = '')   X-Ref
Link url generator

Used for backwards compatibility and as a shortcut. If no url is passed, it will use PHP_SELF. Wrapper to session->link()

param: string    $string    The url the link is for
param: string/array    $extravars    Extra params to be passed to the url
return: string    The full url after processing

redirect_link($url = '',$extravars='')   X-Ref
Pas de description

redirect($url = '')   X-Ref
Handles redirects under iis and apache, it does NOT return (calls exit)

This function handles redirects under iis and apache it assumes that $phpgw->link() has already been called

param: string The url ro redirect to

lang($key,$args=null)   X-Ref
Shortcut to translation class

This function is a basic wrapper to translation->translate()

param: string    The key for the phrase



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