extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2025-01-11 16:38:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

start of inline documentation

Browse Source
This commit is contained in:
themaniac 2001-03-13 23:28:27 +00:00
parent d0d0276f66
commit d2b0d33199
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
phpgwapi/inc/functions.inc.php
View File

@ -29,15 +29,16 @@
* Direct functions, which are not part of the API class * * Direct functions, which are not part of the API class *
* because they are require to be availble at the lowest level. * * because they are require to be availble at the lowest level. *
\****************************************************************************/ \****************************************************************************/
/*!! /*!
* @Type: function @function CreateObject
* @Name: CreateObject @abstract Load a class and include the class file if not done so already.
* @Author: mdean @discussion Author: mdean <br>
* @Title: Load a class and include the class file if not done so already. This function is used to create an instance of a class,
* @Description: This function is used to create an instance of a class, and if the class file has not been included it will do so. <br>
* and if the class file has not been included it will do so. Syntax: CreateObject('app.class', 'constructor_params'); <br>
* @Syntax: CreateObject('app.class', 'constructor_params'); Example1: $phpgw->acl = CreateObject('phpgwapi.acl');
* @Example1: $phpgw->acl = CreateObject('phpgwapi.acl'); @param $classname name of class
@param $constructor_param constructor parameter
*/ */
function CreateObject($classname, $constructor_param = "") function CreateObject($classname, $constructor_param = "")
{ {
@ -56,7 +57,10 @@
} }
return $obj; return $obj;
} }
/*!
@function lang
@abstract function to deal with multilanguage support
*/
function lang($key, $m1="", $m2="", $m3="", $m4="", $m5="", $m6="", $m7="", $m8="", $m9="", $m10="" ) function lang($key, $m1="", $m2="", $m3="", $m4="", $m5="", $m6="", $m7="", $m8="", $m9="", $m10="" )
{ {
global $phpgw; global $phpgw;
@ -73,7 +77,11 @@
global $phpgw; global $phpgw;
return $phpgw->common->check_code($code); return $phpgw->common->check_code($code);
} }
/*!
@function filesystem_separator()
@abstract sets the file system seperator depending on OS
@result file system separator
*/
function filesystem_separator() function filesystem_separator()
{ {
if (PHP_OS == 'Windows' || PHP_OS == 'OS/2') { if (PHP_OS == 'Windows' || PHP_OS == 'OS/2') {