extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2024-12-23 07:09:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

added inline comments (start of)

Browse Source
This commit is contained in:
themaniac 2001-03-09 04:38:42 +00:00
parent a26155472a
commit a4b37d1f37
1 changed files with 70 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
phpgwapi/inc/class.preferences.inc.php
View File

@ -23,18 +23,29 @@
\**************************************************************************/
/* $Id$ */
/*!
@class preferences
@abstract preferences class used for setting application preferences
@discussion Author: none yet
*/
class preferences
{
{ /*! @var account_id */
var $account_id;
/*! @var account_type */
var $account_type;
/*! @var data */
var $data = Array();
/*! @var db */
var $db;
/**************************************************************************\
* Standard constructor for setting $this->account_id *
\**************************************************************************/
/*!
@function preferences
@abstract Standard constructor for setting $this->account_id
@discussion Author:
*/
function preferences($account_id = False)
{
global $phpgw, $phpgw_info;
@ -46,6 +57,12 @@
* These are the standard $this->account_id specific functions *
\**************************************************************************/
/*!
@function read_repository
@abstract private - read preferences from the repository
@discussion private function should only be called from within this class
*/
function read_repository()
{
$this->db->lock("phpgw_preferences");
@ -62,6 +79,14 @@
return $this->data;
}
/*!
@function read
@abstract public - read preferences from repository and stores in an array
@discussion Syntax array read(); <>
Example1: preferences->read();
@result $data array containing user preferences
*/
function read()
{
if (count($this->data) == 0){ $this->read_repository(); }
@ -69,6 +94,15 @@
return $this->data;
}
/*!
@function add
@abstract add preference to $app_name a particular app
@discussion
@param $app_name name of the app
@param $var name of preference to be stored
@param $value value of the preference
*/
function add($app_name,$var,$value = "")
{
if (! $value) {
@ -81,6 +115,14 @@
return $this->data;
}
/*!
@function delete
@abstract delete preference from $app_name
@discussion
@param $app_name name of app
@param $var variable to be deleted
*/
function delete($app_name, $var = "")
{
if ($var == "") {
@ -92,6 +134,12 @@
return $this->data;
}
/*!
@function save_repository
@abstract save the the preferences to the repository
@discussion
*/
function save_repository($update_session_info = False)
{
global $phpgw, $phpgw_info;
@ -118,6 +166,13 @@
return $this->data;
}
/*!
@function update_data
@abstract update the preferences array
@discussion
@param $data array of preferences
*/
function update_data($data) {
reset($data);
$this->data = Array();
@ -139,6 +194,13 @@
/**************************************************************************\
* These are the non-standard $this->account_id specific functions *
\**************************************************************************/
/*!
@function verify_basic_settings
@abstract verify basic settings
@discussion
*/
function verify_basic_settings()
{
global $phpgw, $phpgw_info;