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

phpgw --> egw plus some documentation

Browse Source
This commit is contained in:
Ralf Becker 2005-11-09 12:44:32 +00:00
parent bd325a811f
commit c5a6a2bcc0
1 changed files with 149 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

253
phpgwapi/inc/common_functions.inc.php
View File

@ -28,18 +28,12 @@
* Direct functions which are not part of the API classes * * Direct functions which are not part of the API classes *
* because they are required to be available at the lowest level. * * because they are required to be available at the lowest level. *
\***************************************************************************/ \***************************************************************************/
/*!
@collection_start direct functions
@abstract Direct functions which are not part of the API classes because they are required to be available at the lowest level.
*/
/*! /**
@function print_debug_subarray * @internal Not to be used directly. Should only be used by print_debug()
@abstract Not to be used directly. Should only be used by print_debug()
*/ */
function print_debug_subarray($array) function print_debug_subarray($array)
{ {
// while(list($key, $value) = each($array))
foreach($array as $key => $value) foreach($array as $key => $value)
{ {
if (is_array($value)) if (is_array($value))
@ -54,17 +48,15 @@
return $vartypes; return $vartypes;
} }
/*! /**
@function print_debug * print debug data only when debugging mode is turned on.
@abstract print debug data only when debugging mode is turned on. *
@author seek3r * @author seek3r
@discussion This function is used to debugging data. * This function is used to debugging data.
@syntax print_debug('message', $somevar); * print_debug('this is some debugging data',$somevar);
@example print_debug('this is some debugging data',$somevar);
*/ */
function print_debug($message,$var = 'messageonly',$part = 'app', $level = 3) function print_debug($message,$var = 'messageonly',$part = 'app', $level = 3)
{ {
// if (($part == 'app' && EXP_DEBUG_APP == True) || ($part == 'api' && DEBUG_API == True))
if (($part == 'app' && DEBUG_APP == True) || ($part == 'api' && DEBUG_API == True)) if (($part == 'app' && DEBUG_APP == True) || ($part == 'api' && DEBUG_API == True))
{ {
if (!defined('DEBUG_OUTPUT')) if (!defined('DEBUG_OUTPUT'))
@ -107,7 +99,7 @@
/* /*
if (!!(DEBUG_OUTPUT & 32)) if (!!(DEBUG_OUTPUT & 32))
{ {
$obj_debug = new COM('Some_COM_App.Class','localhost'); $obj_debug =& new COM('Some_COM_App.Class','localhost');
if (is_object($obj_debug)) if (is_object($obj_debug))
{ {
$DebugMessage_return = $obj_debug->DebugMessage($output); $DebugMessage_return = $obj_debug->DebugMessage($output);
@ -157,13 +149,12 @@
} }
} }
/*! /**
@function safe_args * Allows for array and direct function params as well as sanatization.
@abstract Allows for array and direct function params as well as sanatization. *
@author seek3r * @author seek3r
@discussion This function is used to validate param data as well as offer flexible function usage. * This function is used to validate param data as well as offer flexible function usage.
@syntax safe_args($expected_args, $recieved_args,__LINE__,__FILE__); *
@example
function somefunc() function somefunc()
{ {
$expected_args[0] = Array('name'=>'fname','default'=>'joe', 'type'=>'string'); $expected_args[0] = Array('name'=>'fname','default'=>'joe', 'type'=>'string');
@ -277,19 +268,13 @@
return $args; return $args;
} }
/*! /**
@function sanitize * Validate data.
@abstract Validate data. *
@author seek3r * @author seek3r
@discussion This function is used to validate input data. * This function is used to validate input data.
@syntax sanitize('type', 'match string'); * sanitize('number',$somestring);
@example sanitize('number',$somestring);
*/ */
/*
$GLOBALS['egw_info']['server']['sanitize_types']['number'] = Array('type' => 'preg_match', 'string' => '/^[0-9]+$/i');
*/
function sanitize($string,$type) function sanitize($string,$type)
{ {
switch ($type) switch ($type)
@ -645,16 +630,15 @@
return $result; return $result;
} }
/*! /**
@function get_var * retrieve a value from either a POST, GET, COOKIE, SERVER or from a class variable.
@abstract retrieve a value from either a POST, GET, COOKIE, SERVER or from a class variable. *
@author skeeter * @author skeeter
@discussion This function is used to retrieve a value from a user defined order of methods. * This function is used to retrieve a value from a user defined order of methods.
@syntax get_var('id',array('HTTP_POST_VARS'||'POST','HTTP_GET_VARS'||'GET','HTTP_COOKIE_VARS'||'COOKIE','GLOBAL','DEFAULT')); * $this->id = get_var('id',array('HTTP_POST_VARS'||'POST','HTTP_GET_VARS'||'GET','HTTP_COOKIE_VARS'||'COOKIE','GLOBAL','DEFAULT'));
@example $this->id = get_var('id',array('HTTP_POST_VARS'||'POST','HTTP_GET_VARS'||'GET','HTTP_COOKIE_VARS'||'COOKIE','GLOBAL','DEFAULT')); * @param $variable name
@param $variable name * @param $method ordered array of methods to search for supplied variable
@param $method ordered array of methods to search for supplied variable * @param $default_value (optional)
@param $default_value (optional)
*/ */
function get_var($variable,$method='any',$default_value='') function get_var($variable,$method='any',$default_value='')
{ {
@ -665,17 +649,16 @@
return reg_var($variable,$method,'any',$default_value,False); return reg_var($variable,$method,'any',$default_value,False);
} }
/*! /**
@function CreateObject * Load a class and include the class file if not done so already.
@abstract Load a class and include the class file if not done so already. *
@author mdean * This function is used to create an instance of a class, and if the class file has not been included it will do so.
@author milosch * $GLOBALS['egw']->acl =& CreateObject('phpgwapi.acl');
@author (thanks to jengo and ralf) *
@discussion This function is used to create an instance of a class, and if the class file has not been included it will do so. * @author RalfBecker@outdoor-training.de
@syntax CreateObject('app.class', 'constructor_params'); * @param $classname name of class
@example $phpgw->acl = CreateObject('phpgwapi.acl'); * @param $p1,$p2,... class parameters (all optional)
@param $classname name of class * @return object reference to an object
@param $p1,$p2,... class parameters (all optional)
*/ */
function &CreateObject($class) function &CreateObject($class)
{ {
@ -717,6 +700,7 @@
* *
* @param string app.class.method method to execute * @param string app.class.method method to execute
* @example ExecObject('etemplates.so_sql.search',$criteria,$key_only,...); * @example ExecObject('etemplates.so_sql.search',$criteria,$key_only,...);
* @return mixed reference to returnvalue of the method
*/ */
function &ExecMethod2($acm) function &ExecMethod2($acm)
{ {
@ -735,7 +719,7 @@
$args = func_get_args(); $args = func_get_args();
unset($args[0]); unset($args[0]);
$code = '$return = $obj->'.$method.'('; $code = '$return =& $obj->'.$method.'(';
foreach ($args as $n => $arg) foreach ($args as $n => $arg)
{ {
if ($n) if ($n)
@ -749,17 +733,17 @@
return $return; return $return;
} }
/*! /**
@function ExecMethod * Execute a function, and load a class and include the class file if not done so already.
@abstract Execute a function, and load a class and include the class file if not done so already. *
@author seek3r * This function is used to create an instance of a class, and if the class file has not been included it will do so.
@discussion This function is used to create an instance of a class, and if the class file has not been included it will do so. *
@syntax ExecObject('app.class', 'constructor_params'); * @author seek3r
@param $method to execute * @param $method to execute
@param $functionparams function param should be an array * @param $functionparams function param should be an array
@param $loglevel developers choice of logging level * @param $loglevel developers choice of logging level
@param $classparams params to be sent to the contructor * @param $classparams params to be sent to the contructor
@example ExecObject('phpgwapi.acl.read'); * @return mixed returnvalue of method
*/ */
function ExecMethod($method, $functionparams = '_UNDEF_', $loglevel = 3, $classparams = '_UNDEF_') function ExecMethod($method, $functionparams = '_UNDEF_', $loglevel = 3, $classparams = '_UNDEF_')
{ {
@ -772,11 +756,11 @@
{ {
if ($classparams != '_UNDEF_' && ($classparams || $classparams != 'True')) if ($classparams != '_UNDEF_' && ($classparams || $classparams != 'True'))
{ {
$GLOBALS[$classname] = CreateObject($appname.'.'.$classname, $classparams); $GLOBALS[$classname] =& CreateObject($appname.'.'.$classname, $classparams);
} }
else else
{ {
$GLOBALS[$classname] = CreateObject($appname.'.'.$classname); $GLOBALS[$classname] =& CreateObject($appname.'.'.$classname);
} }
} }
@ -831,16 +815,16 @@
{ {
if (is_string($classparams)) if (is_string($classparams))
{ {
eval($parentobject.'->'.$classname.' = CreateObject("'.$appname.'.'.$classname.'", "'.$classparams.'");'); eval($parentobject.'->'.$classname.' =& CreateObject("'.$appname.'.'.$classname.'", "'.$classparams.'");');
} }
else else
{ {
eval($parentobject.'->'.$classname.' = CreateObject("'.$appname.'.'.$classname.'", '.$classparams.');'); eval($parentobject.'->'.$classname.' =& CreateObject("'.$appname.'.'.$classname.'", '.$classparams.');');
} }
} }
else else
{ {
eval($parentobject.'->'.$classname.' = CreateObject("'.$appname.'.'.$classname.'");'); eval($parentobject.'->'.$classname.' =& CreateObject("'.$appname.'.'.$classname.'");');
} }
} }
@ -861,15 +845,15 @@
} }
} }
/*! /**
@function copyobj * duplicates the result of copying an object under php3/4 even when using php5
@abstract duplicates the result of copying an object under php3/4 even when using php5 *
@author milosch * This is critical when looping on db object output and updating or inserting to the database using a copy of the db object. This was first added to GroupWhere
@discussion This is critical when looping on db object output and updating or inserting to the database using a copy of the db object. This was first added to GroupWhere *
@syntax copyobj($source_object,$target_object); * @deprecated use $copy = clone($obj);
@example copyobj($GLOBALS['egw']->db,$mydb); * @author milosch
@param $a - Source Object * @param $a - Source Object
@param $b - Target Object (copy) * @param $b - Target Object (copy)
*/ */
function copyobj($a,&$b) function copyobj($a,&$b)
{ {
@ -884,15 +868,15 @@
return; return;
} }
/*! /**
@function get_account_id * Return a properly formatted account_id.
@abstract Return a properly formatted account_id. *
@author skeeter * @author skeeter
@discussion This function will return a properly formatted account_id. This can take either a name or an account_id as paramters. If a name is provided it will return the associated id. * This function will return a properly formatted account_id. This can take either a name or an account_id as paramters. If a name is provided it will return the associated id.
@syntax get_account_id($accountid); * $account_id = get_account_id($accountid);
@example $account_id = get_account_id($accountid); * @param int/string $account_id either a name or an id
@param $account_id either a name or an id * @param int/string $default_id either a name or an id
@param $default_id either a name or an id * @return int account_id
*/ */
function get_account_id($account_id = '',$default_id = '') function get_account_id($account_id = '',$default_id = '')
{ {
@ -925,10 +909,12 @@
} }
} }
/*! /**
@function filesystem_separator * sets the file system seperator depending on OS
@abstract sets the file system seperator depending on OS *
@result file system separator * This is completely unnecessary, as you can use forward slashes in php under every OS -- RalfBecker 2005/11/09
*
* @return file system separator
*/ */
function filesystem_separator() function filesystem_separator()
{ {
@ -942,6 +928,13 @@
} }
} }
/**
* print an array or object as pre-formatted html
*
* @param mixed $array
* @param boolean $print=true print or return the content
* @return string if !$print
*/
function _debug_array($array,$print=True) function _debug_array($array,$print=True)
{ {
$four = False; $four = False;
@ -971,12 +964,12 @@
} }
} }
/* /**
@function alessthanb * eGW version checking, is eGW version in $a < $b
@abstract phpgw version checking, is param 1 < param 2 in phpgw versionspeak? *
@param $a phpgw version number to check if less than $b * @param string $a egw version number to check if less than $b
@param $b phpgw version number to check $a against * @param string $b egw version number to check $a against
#return True if $a < $b * @return boolean True if $a < $b
*/ */
function alessthanb($a,$b,$DEBUG=False) function alessthanb($a,$b,$DEBUG=False)
{ {
@ -1059,12 +1052,12 @@
} }
} }
/*! /**
@function amorethanb * eGW version checking, is eGW version in $a > $b
@abstract phpgw version checking, is param 1 > param 2 in phpgw versionspeak? *
@param $a phpgw version number to check if more than $b * @param string $a eGW version number to check if more than $b
@param $b phpgw version number to check $a against * @param string $b eGW version number to check check $a against
#return True if $a < $b * @return boolean True if $a > $b
*/ */
function amorethanb($a,$b,$DEBUG=False) function amorethanb($a,$b,$DEBUG=False)
{ {
@ -1139,13 +1132,13 @@
} }
} }
/*! /**
@function prepend_tables_prefix * prepend a prefix to an array of table names
@abstract prepend a prefix to an array of table names *
@author Adam Hull (aka fixe) - No copyright claim * @author Adam Hull (aka fixe) - No copyright claim
@param $prefix the string to be prepended * @param $prefix the string to be prepended
@param $tables and array of tables to have the prefix prepended to * @param $tables and array of tables to have the prefix prepended to
@return array of table names with the prefix prepended * @return array of table names with the prefix prepended
*/ */
function prepend_tables_prefix($prefix,$tables) function prepend_tables_prefix($prefix,$tables)
{ {
@ -1156,11 +1149,12 @@
return $tables; return $tables;
} }
/*! /**
@function function_backtrace * backtrace of the calling functions for php4.3+ else menuaction/scriptname
@abstract backtrace of the calling functions for php4.3+ else menuaction/scriptname *
@author ralfbecker * @author RalfBecker-AT-outdoor-training.de
@return function-names separated by slashes (beginning with the calling function not this one) * @param int $remove=0 number of levels to remove
* @return string function-names separated by slashes (beginning with the calling function not this one)
*/ */
function function_backtrace($remove=0) function function_backtrace($remove=0)
{ {
@ -1184,6 +1178,13 @@
return $_GET['menuaction'] ? $_GET['menuaction'] : str_replace(EGW_SERVER_ROOT,'',$_SERVER['SCRIPT_FILENAME']); return $_GET['menuaction'] ? $_GET['menuaction'] : str_replace(EGW_SERVER_ROOT,'',$_SERVER['SCRIPT_FILENAME']);
} }
/**
* check $_REQUEST data for XSS, vars containing script tags are moved to $GLOBALS['egw_unset_vars']
*
* @internal
* @param array &$var reference of array to check
* @param string $name='' name of the array
*/
function _check_script_tag(&$var,$name='') function _check_script_tag(&$var,$name='')
{ {
if (is_array($var)) if (is_array($var))
@ -1244,12 +1245,16 @@
'); ');
} }
/**
* function to handle multilanguage support
*/
if (!function_exists('lang')) // setup declares an own version if (!function_exists('lang')) // setup declares an own version
{ {
function lang($key,$vars='') /**
* function to handle multilanguage support
*
* @param string $key message in englich with %1, %2, ... placeholders
* @param string $vars=null multiple values to replace the placeholders
* @return string translated message with placeholders replaced
*/
function lang($key,$vars=null)
{ {
if(!is_array($m1)) if(!is_array($m1))
{ {