forked from extern/egroupware
added inline documentation
This commit is contained in:
parent
aaa9340030
commit
c144045ce0
@ -24,14 +24,12 @@
|
|||||||
|
|
||||||
/* $Id$ */
|
/* $Id$ */
|
||||||
|
|
||||||
/*!!
|
/*!
|
||||||
* @Type: class
|
@class phpgw
|
||||||
* @Name: phpgw
|
@abstract Main class. Has a few functions but is more importantly used as a parent class for everything else.
|
||||||
* @Author: Seek3r
|
@discussion written by: Seek3r <br>
|
||||||
* @Title: Main class.
|
Syntax: CreateObject('phpgwapi.phpgw'); <br>
|
||||||
* @Description: Main class. Has a few functions but is more importantly used as a parent class for everything else.
|
Example1: $phpgw = CreateObject('phpgwapi.acl');
|
||||||
* @Syntax: CreateObject('phpgwapi.phpgw');
|
|
||||||
* @Example1: $phpgw = CreateObject('phpgwapi.acl');
|
|
||||||
*/
|
*/
|
||||||
class phpgw
|
class phpgw
|
||||||
{
|
{
|
||||||
@ -39,6 +37,7 @@
|
|||||||
var $applications;
|
var $applications;
|
||||||
var $acl;
|
var $acl;
|
||||||
var $auth;
|
var $auth;
|
||||||
|
/*! @var db */
|
||||||
var $db;
|
var $db;
|
||||||
var $debug = 0; // This will turn on debugging information.
|
var $debug = 0; // This will turn on debugging information.
|
||||||
var $crypto;
|
var $crypto;
|
||||||
@ -63,29 +62,24 @@
|
|||||||
* Core functions *
|
* Core functions *
|
||||||
\**************************************************************************/
|
\**************************************************************************/
|
||||||
|
|
||||||
/*!!
|
/*!
|
||||||
* @Type: function
|
@function strip_html
|
||||||
* @Name: strip_html
|
@abstract strips out html chars
|
||||||
* @Author: Seek3r
|
@discussion Author: Seek3r. <br>
|
||||||
* @Title: Strips out html chars.
|
Description: 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);
|
||||||
* @Syntax: string strip_html(string as string)
|
@param urlencode_string string-the string to be stripped of html special chars.
|
||||||
* @Example1: $reg_string = strip_html($urlencode_string);
|
@result Object - the string with html special characters removed
|
||||||
*/
|
*/
|
||||||
function strip_html($s)
|
function strip_html($s)
|
||||||
{
|
{
|
||||||
return htmlspecialchars(stripslashes($s));
|
return htmlspecialchars(stripslashes($s));
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!!
|
/*!
|
||||||
* @Type: function
|
@function link
|
||||||
* @Name: link
|
@abstract wrapper to session->link()
|
||||||
* @Author: Seek3r
|
@discussion Used for backwards compatibility and as a shortcut. If not url is passed, it will use PHP_SELF <br>
|
||||||
* @Title: Wrapper to session->link()
|
|
||||||
* @Description: Used for backward compatibility and as a shortcut.
|
|
||||||
* If no url is passed, it will use PHP_SELF
|
|
||||||
* @Syntax: string link(url as string, extra_vars as string)
|
|
||||||
* @Example1: <a href="<?php echo $phpgw->link('otherpage.php');?>">click here</a>
|
|
||||||
*/
|
*/
|
||||||
function link($url = "", $extravars = "")
|
function link($url = "", $extravars = "")
|
||||||
{
|
{
|
||||||
@ -93,15 +87,16 @@
|
|||||||
return $this->session->link($url, $extravars);
|
return $this->session->link($url, $extravars);
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!!
|
/*!
|
||||||
* @Type: function
|
@function redirect
|
||||||
* @Name: link
|
@abstract Handles redirects under iis and apache
|
||||||
* @Author: Seek3r
|
@discussion Author: Seek3r <br>
|
||||||
* @Title: Handles redirects under iis and apache
|
Title: Handles redirects under iis and apache <br>
|
||||||
* @Description: This function handles redirects under iis and apache
|
Description: This function handles redirects under iis and apache
|
||||||
* it assumes that $phpgw->link() has already been called
|
it assumes that $phpgw->link() has already been called <br>
|
||||||
* @Syntax: string redirect(url as string)
|
Syntax: string redirect(url as string) <br>
|
||||||
* @Example1: None yet
|
Example1: None yet
|
||||||
|
@param url
|
||||||
*/
|
*/
|
||||||
function redirect($url = "")
|
function redirect($url = "")
|
||||||
{
|
{
|
||||||
@ -127,14 +122,14 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!!
|
/*!
|
||||||
* @Type: function
|
@function lang
|
||||||
* @Name: lang
|
@abstract Shortcut to tranlation class
|
||||||
* @Author: Jengo
|
@discussion Author: Jengo <br>
|
||||||
* @Title: Shortcut to translation class
|
Title: Shortcut to translation class <br>
|
||||||
* @Description: This function is a basic wrapper to translation->translate()
|
Description: This function is a basic wrapper to translation->translate() <br>
|
||||||
* @Syntax: string redirect(key as string)
|
Syntax: string redirect(key as string) <br>
|
||||||
* @Example1: None yet
|
Example1: None yet
|
||||||
*/
|
*/
|
||||||
function lang($key, $m1 = "", $m2 = "", $m3 = "", $m4 = "")
|
function lang($key, $m1 = "", $m2 = "", $m3 = "", $m4 = "")
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user