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

trying to make progress on the documentation system

Browse Source
This commit is contained in:
seek3r 2001-05-10 07:59:48 +00:00
parent 75db6dc449
commit 12132dac30
1 changed files with 59 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
phpgwapi/inc/class.phpgw.inc.php
View File

@ -26,15 +26,12 @@
/** /**
* Base class * Parent class for the phpgwAPI
* Dan Kuykendall dan@kuykendall.org\n * Parent class. Has a few functions but is more importantly used as a parent class for everything else.
* Base class. Has a few functions but is more importantly used as a parent class for everything else.\n * @author Dan Kuykendall <dan@kuykendall.org>
* Written by: Seek3r\n * @copyright LGPL
* Order: short description - detailed description - doc tags.
* @package phpgwapi * @package phpgwapi
* @param string A string which identifies the desired class - app.class * @access public
* Syntax: CreateObject('phpgwapi.phpgw'); <br>
* Example1: $phpgw = CreateObject('phpgwapi.acl');
*/ */
class phpgw class phpgw
@ -43,8 +40,12 @@
var $applications; var $applications;
var $acl; var $acl;
var $auth; var $auth;
/*! @var db */
var $db; var $db;
/**
* Turn on debug mode. Will output additional data for debugging purposes.
* @var string $debug
* @access public
*/
var $debug = 0; // This will turn on debugging information. var $debug = 0; // This will turn on debugging information.
var $crypto; var $crypto;
var $categories; var $categories;
@ -68,24 +69,35 @@
* Core functions * * Core functions *
\**************************************************************************/ \**************************************************************************/
/*! /**
@function strip_html * Strips out html chars
@abstract strips out html chars *
@discussion Author: Seek3r. <br> * Used as a shortcut for stripping out html special chars.
Description: Used as a shortcut for stripping out html special chars. *
<br> Example1: $reg_string = strip_html($urlencode_string); * @access public
@param urlencode_string string-the string to be stripped of html special chars. * @param $s string The string to have its html special chars stripped out.
@result Object - the string with html special characters removed * @return string The string with html special characters removed
* @syntax strip_html($string)
* @example $reg_string = strip_html($urlencode_string);
*/ */
function strip_html($s) function strip_html($s)
{ {
return htmlspecialchars(stripslashes($s)); return htmlspecialchars(stripslashes($s));
} }
/*! /**
@function link * Link url generator
@abstract wrapper to session->link() *
@discussion Used for backwards compatibility and as a shortcut. If not url is passed, it will use PHP_SELF <br> * Used for backwards compatibility and as a shortcut. If no url is passed, it will use PHP_SELF. Wrapper to session->link()
*
* @access public
* @param string $string The url the link is for
* @param string $extravars Extra params to be passed to the url
* @return string The full url after processing
* @see session->link()
* @syntax link($string, $extravars)
* @example None yet
*/ */
function link($url = "", $extravars = "") function link($url = "", $extravars = "")
{ {
@ -93,20 +105,18 @@
return $this->session->link($url, $extravars); return $this->session->link($url, $extravars);
} }
/*! /**
@function redirect * Handles redirects under iis and apache
@abstract Handles redirects under iis and apache *
@discussion Author: Seek3r <br> * This function handles redirects under iis and apache it assumes that $phpgw->link() has already been called
Title: Handles redirects under iis and apache <br> *
Description: This function handles redirects under iis and apache * @access public
it assumes that $phpgw->link() has already been called <br> * @param string The url ro redirect to
Syntax: string redirect(url as string) <br> * @syntax redirect(key as string)
Example1: None yet * @example None yet
@param url
*/ */
function redirect($url = "") function redirect($url = "")
{ {
global $HTTP_ENV_VARS; global $HTTP_ENV_VARS;
$iis = strpos($HTTP_ENV_VARS["SERVER_SOFTWARE"], "IIS", 0); $iis = strpos($HTTP_ENV_VARS["SERVER_SOFTWARE"], "IIS", 0);
@ -128,14 +138,18 @@
} }
} }
/*! /**
@function lang * Shortcut to tranlation class
@abstract Shortcut to tranlation class *
@discussion Author: Jengo <br> * This function is a basic wrapper to translation->translate()
Title: Shortcut to translation class <br> *
Description: This function is a basic wrapper to translation->translate() <br> * @access public
Syntax: string redirect(key as string) <br> * @param string The key for the phrase
Example1: None yet * @param string the first additional param
* @param string the second additional param
* @param string the thrid additional param
* @param string the fourth additional param
* @see translation->translate()
*/ */
function lang($key, $m1 = "", $m2 = "", $m3 = "", $m4 = "") function lang($key, $m1 = "", $m2 = "", $m3 = "", $m4 = "")
{ {