[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] CVS: phpgwapi/inc common_functions.inc.php,NONE,1.1 f
|
From: |
Mark A Peters <address@hidden> |
|
Subject: |
[Phpgroupware-cvs] CVS: phpgwapi/inc common_functions.inc.php,NONE,1.1 functions.inc.php,1.131,1.132 |
|
Date: |
Fri, 01 Mar 2002 07:31:53 -0500 |
Update of /cvsroot/phpgroupware/phpgwapi/inc
In directory subversions:/tmp/cvs-serv20299/phpgwapi/inc
Modified Files:
functions.inc.php
Added Files:
common_functions.inc.php
Log Message:
Split out common files from functions.inc.php so that the API and setup can
have a single source base.
***** Error reading new file: [Errno 2] No such file or directory:
'common_functions.inc.php'
Index: functions.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/phpgwapi/inc/functions.inc.php,v
retrieving revision 1.131
retrieving revision 1.132
diff -C2 -r1.131 -r1.132
*** functions.inc.php 28 Feb 2002 03:46:34 -0000 1.131
--- functions.inc.php 1 Mar 2002 12:31:50 -0000 1.132
***************
*** 35,560 ****
}
!
/****************************************************************************\
! * Direct functions, which are not part of the API class
*
! * because they are require to be availble at the lowest level.
*
!
\****************************************************************************/
! /*!
! @collection_start direct functions
! @abstract Direct functions, which are not part of the API class
because they are require to be availble at the lowest level.
! */
! /*!
! @function print_debug_subarray
! @abstract Not to be used directly. Should only be used by print_debug()
! */
! function print_debug_subarray($array)
! {
! while(list($key, $value) = each($array))
! {
! if (is_array($value))
! {
! $vartypes[$key] = print_debug_subarray($value);
! }
! else
! {
! $vartypes[$key] = gettype($value);
! }
! }
! return $vartypes;
! }
!
! /*!
! @function print_debug
! @abstract print debug data only when debugging mode is turned on.
! @author seek3r
! @discussion This function is used to debugging data.
! @syntax print_debug('message', $somevar);
! @example print_debug('this is some debugging data',$somevar);
! */
! function print_debug($message,$var = 'messageonly',$part = 'app',
$level = 3)
! {
! if (($part == 'app' && EXP_DEBUG_APP == True) || ($part ==
'api' && DEBUG_API == True))
! {
! if (!defined('DEBUG_OUTPUT'))
! {
! define('DEBUG_OUTPUT', 1);
! }
! if ($level >= DEBUG_LEVEL)
! {
! if (!is_array($var))
! {
! if ($var != 'messageonly')
! {
! if (!DEBUG_DATATYPES)
! {
! $output =
"$message\n$var";
! }
! else
! {
! $output =
"$message\n$var is a ".gettype($var);
! }
! }
! else
! {
! $output = $message;
! }
!
! /* Bit 1 means to output to screen */
! if (!!(DEBUG_OUTPUT & 1))
! {
! echo "$output<br>\n";
! }
! /* Bit 2 means to output to sql */
! if (!!(DEBUG_OUTPUT & 2))
! {
! /* Need to flesh this out
still. I dont have a table to dump this in yet.*/
! /* So the SQL statement will go
here*/
! }
!
! /* Example of how this can be extended
to output to other locations as well. This example uses a COM object */
! /*
! if (!!(DEBUG_OUTPUT & 32))
! {
! $obj_debug = new
COM('Some_COM_App.Class','localhost');
! if (is_object($obj_debug))
! {
! $DebugMessage_return =
$obj_debug->DebugMessage($output);
! }
! }
! */
! }
! else
! {
! if (floor(phpversion()) > 3 &&
!!(DEBUG_OUTPUT & 2))
! {
! ob_start();
! }
! echo "<pre>\n$message\n";
! print_r($var);
! if (DEBUG_DATATYPES)
! {
! while(list($key, $value) =
each($var))
! {
! if (is_array($value))
! {
! $vartypes[$key]
= print_debug_subarray($value);
! }
! else
! {
! $vartypes[$key]
= gettype($value);
! }
! }
! echo "Data Types:\n";
! print_r($vartypes);
! }
! echo "\n<pre>\n";
! if (floor(phpversion()) > 3 &&
!!(DEBUG_OUTPUT & 2))
! {
! $output .= ob_get_contents();
! ob_end_clean();
! /* Need to flesh this out
still. I dont have a table to dump this in yet.*/
! /* So the SQL statement will go
here*/
! if (!!(DEBUG_OUTPUT & 1))
! {
! echo "$output<br>\n";
! }
! }
! }
! }
! }
! }
/*!
- @function sanitize
- @abstract Validate data.
- @author seek3r
- @discussion This function is used to validate input data.
- @syntax sanitize('type', 'match string');
- @example sanitize('number',$somestring);
- */
-
- /*
- $GLOBALS['phpgw_info']['server']['sanitize_types']['number'] =
Array('type' => 'preg_match', 'string' => '/^[0-9]+$/i');
- */
-
- function sanitize($string,$type)
- {
- switch ($type)
- {
- case 'bool':
- if ($string == 1 || $string == 0)
- {
- return True;
- }
- break;
- case 'number':
- if (preg_match("/^[0-9]+$/i", $string))
- {
- return True;
- }
- break;
- case 'string':
- if (preg_match("/^[a-z]+$/i", $string))
- {
- return True;
- }
- break;
- case 'alpha':
- if (preg_match("/^[a-z0-9 -._]+$/i", $string))
- {
- return True;
- }
- break;
- case 'ip':
- if
(eregi("^[0-9]{1,3}(\.[0-9]{1,3}){3}$",$string))
- {
- $octets = split('\.',$string);
- for ($i=0; $i != count($octets); $i++)
- {
- if ($octets[$i] < 0 ||
$octets[$i] > 255)
- {
- return False;
- }
- }
- return True;
- }
- return False;
- break;
- case 'file':
- if (preg_match("/^[a-z0-9_]+\.+[a-z]+$/i",
$string))
- {
- return True;
- }
- break;
- case 'email':
- if
(eregi("^([[:alnum:]_%+=.-]+)@([[:alnum:]_.-]+)\.([a-z]{2,3}|[0-9]{1,3})$",$string))
- {
- return True;
- }
- break;
- case 'any':
- return True;
- break;
- default :
- if
(isset($GLOBALS['phpgw_info']['server']['sanitize_types'][$type]['type']))
- {
- if
($GLOBALS['phpgw_info']['server']['sanitize_types'][$type]['type']($GLOBALS['phpgw_info']['server']['sanitize_types'][$type]['string'],
$string))
- {
- return True;
- }
- }
- return False;
- }
- }
-
- function registervar($varname, $valuetype = 'alpha', $posttype =
'post', $allowblank = True)
- {
- switch ($posttype)
- {
- case 'get':
- $posttype = 'HTTP_GET_VARS';
- break;
- case 'cookie':
- $posttype = 'HTTP_COOKIE_VARS';
- break;
- default :
- $posttype = 'HTTP_POST_VARS';
- }
-
- if (isset($GLOBALS[$posttype][$varname]))
- {
- if (!is_array($GLOBALS[$posttype][$varname]))
- {
- if ($allowblank == True &&
$GLOBALS[$posttype][$varname] == '')
- {
-
$GLOBALS['phpgw_info'][$GLOBALS['phpgw_info']['flags']['currentapp']][$varname]
= $GLOBALS[$posttype][$varname];
- return 'Post';
- }
- else
- {
- if
(sanitize($GLOBALS[$posttype][$varname],$valuetype) == 1)
- {
-
$GLOBALS['phpgw_info'][$GLOBALS['phpgw_info']['flags']['currentapp']][$varname]
= $GLOBALS[$posttype][$varname];
- return 'Post';
- }
- else
- {
- return False;
- }
- }
- return False;
- }
- else
- {
- if (is_array($valuetype))
- {
- reset($GLOBALS[$posttype][$varname]);
- $isvalid = True;
- while(list($key, $value) =
each($GLOBALS[$posttype][$varname]))
- {
- if ($allowblank == True &&
$GLOBALS[$posttype][$varname][$key] == '')
- {
- }
- else
- {
- if
(sanitize($GLOBALS[$posttype][$varname][$key],$valuetype[$key]) == 1)
- {
- }
- else
- {
- $isvalid =
False;
- }
- }
- }
- if ($isvalid)
- {
-
$GLOBALS['phpgw_info'][$GLOBALS['phpgw_info']['flags']['currentapp']][$varname]
= $GLOBALS[$posttype][$varname];
- return 'Post';
- }
- else
- {
- return 'Session';
- }
- return False;
- }
- }
- return False;
- }
- elseif (count($GLOBALS[$posttype]) == 0)
- {
- return 'Session';
- }
- else
- {
- return False;
- }
- }
-
-
- /*!
- @function get_var
- @abstract retrieve a value from either a POST, GET, COOKIE, or from a
class variable.
- @author skeeter
- @discussion 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'));
- @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 $method ordered array of methods to search for supplied variable
- @param $default_value (optional)
- */
- function get_var($variable,$method,$default_value='')
- {
- for($i=0;$i<count($method);$i++)
- {
- switch(strtoupper($method[$i]))
- {
- case 'DEFAULT':
- if($default_value)
- {
- $var = $default_value;
- }
- break;
- case 'GLOBAL':
- if(@isset($GLOBALS[$variable]))
- {
- $var = $GLOBALS[$variable];
- }
- break;
- case 'POST':
- case 'GET':
- case 'COOKIE':
-
if(@isset($GLOBALS['HTTP_'.strtoupper($method[$i]).'_VARS'][$variable]))
- {
- $var =
$GLOBALS['HTTP_'.strtoupper($method[$i]).'_VARS'][$variable];
- }
- break;
- default:
-
if(@isset($GLOBALS[strtoupper($method[$i])][$variable]))
- {
- $var =
$GLOBALS[strtoupper($method[$i])][$variable];
- }
- break;
- }
- }
- return $var;
- }
-
- /*!
- @function CreateObject
- @abstract Load a class and include the class file if not done so
already.
- @author mdean
- @author milosch
- @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.
- @syntax CreateObject('app.class', 'constructor_params');
- @example $phpgw->acl = CreateObject('phpgwapi.acl');
- @param $classname name of class
- @param $p1-$p16 class parameters (all optional)
- */
- function CreateObject($class,
- $p1='_UNDEF_',$p2='_UNDEF_',$p3='_UNDEF_',$p4='_UNDEF_',
- $p5='_UNDEF_',$p6='_UNDEF_',$p7='_UNDEF_',$p8='_UNDEF_',
- $p9='_UNDEF_',$p10='_UNDEF_',$p11='_UNDEF_',$p12='_UNDEF_',
- $p13='_UNDEF_',$p14='_UNDEF_',$p15='_UNDEF_',$p16='_UNDEF_')
- {
- global $phpgw_info, $phpgw;
-
- if (is_object(@$GLOBALS['phpgw']->log) && $class !=
'phpgwapi.error' && $class != 'phpgwapi.errorlog')
- {
- //$GLOBALS['phpgw']->log->write(array('text'=>'D-Debug,
dbg: %1','p1'=>'This class was run:
'.$class,'file'=>__FILE__,'line'=>__LINE__));
- }
-
- /* error_reporting(0); */
- list($appname,$classname) = explode('.', $class);
-
- if
(!isset($GLOBALS['phpgw_info']['flags']['included_classes'][$classname]) ||
-
!$GLOBALS['phpgw_info']['flags']['included_classes'][$classname])
- {
-
if(@file_exists(PHPGW_INCLUDE_ROOT.'/'.$appname.'/inc/class.'.$classname.'.inc.php'))
- {
-
include(PHPGW_INCLUDE_ROOT.'/'.$appname.'/inc/class.'.$classname.'.inc.php');
-
$GLOBALS['phpgw_info']['flags']['included_classes'][$classname] = True;
- }
- else
- {
-
$GLOBALS['phpgw_info']['flags']['included_classes'][$classname] = False;
- }
- }
-
if($GLOBALS['phpgw_info']['flags']['included_classes'][$classname])
- {
- if ($p1 == '_UNDEF_' && $p1 != 1)
- {
- eval('$obj = new ' . $classname . ';');
- }
- else
- {
- $input =
array($p1,$p2,$p3,$p4,$p5,$p6,$p7,$p8,$p9,$p10,$p11,$p12,$p13,$p14,$p15,$p16);
- $i = 1;
- $code = '$obj = new ' . $classname . '(';
- while (list($x,$test) = each($input))
- {
- if (($test == '_UNDEF_' && $test != 1 )
|| $i == 17)
- {
- break;
- }
- else
- {
- $code .= '$p' . $i . ',';
- }
- $i++;
- }
- $code = substr($code,0,-1) . ');';
- eval($code);
- }
- /* error_reporting(E_ERROR | E_WARNING | E_PARSE); */
- return $obj;
- }
- }
-
- /*!
- @function ExecMethod
- @abstract Execute a function, and load a class and include the class
file if not done so already.
- @author seek3r
- @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');
- @param $method to execute
- @param $functionparams function param should be an array
- @param $loglevel developers choice of logging level
- @param $classparams params to be sent to the contructor
- @example ExecObject('phpgwapi.acl.read');
- */
- function ExecMethod($method, $functionparams = '_UNDEF_', $loglevel =
3, $classparams = '_UNDEF_')
- {
- /* Need to make sure this is working against a single
dimensional object */
- $partscount = count(explode('.',$method)) - 1;
- if ($partscount == 2)
- {
- list($appname,$classname,$functionname) = explode(".",
$method);
- if (!is_object($GLOBALS[$classname]))
- {
- if ($classparams != '_UNDEF_' && ($classparams
|| $classparams != 'True'))
- {
- $GLOBALS[$classname] =
CreateObject($appname.'.'.$classname, $classparams);
- }
- else
- {
- $GLOBALS[$classname] =
CreateObject($appname.'.'.$classname);
- }
- }
-
- if ((is_array($functionparams) || $functionparams !=
'_UNDEF_') && ($functionparams || $functionparams != 'True'))
- {
- return
$GLOBALS[$classname]->$functionname($functionparams);
- }
- else
- {
- return $GLOBALS[$classname]->$functionname();
- }
- }
- /* if the $method includes a parent class (multi-dimensional)
then we have to work from it */
- elseif ($partscount >= 3)
- {
- $GLOBALS['methodparts'] = explode(".", $method);
- $classpartnum = $partscount - 1;
- $appname = $GLOBALS['methodparts'][0];
- $classname = $GLOBALS['methodparts'][$classpartnum];
- $functionname = $GLOBALS['methodparts'][$partscount];
- /* Now I clear these out of the array so that I can do
a proper */
- /* loop and build the $parentobject */
- unset ($GLOBALS['methodparts'][0]);
- unset ($GLOBALS['methodparts'][$classpartnum]);
- unset ($GLOBALS['methodparts'][$partscount]);
- reset ($GLOBALS['methodparts']);
- $firstparent = 'True';
- while (list ($key, $val) = each
($GLOBALS['methodparts']))
- {
- if ($firstparent == 'True')
- {
- $parentobject = '$GLOBALS["'.$val.'"]';
- $firstparent = False;
- }
- else
- {
- $parentobject .= '->'.$val;
- }
- }
- unset($GLOBALS['methodparts']);
- $code = '$isobject =
is_object('.$parentobject.'->'.$classname.');';
- eval ($code);
- if (!$isobject)
- {
- if ($classparams != '_UNDEF_' && ($classparams
|| $classparams != 'True'))
- {
- if (is_string($classparams))
- {
-
eval($parentobject.'->'.$classname.' =
CreateObject("'.$appname.'.'.$classname.'", "'.$classparams.'");');
- }
- else
- {
-
eval($parentobject.'->'.$classname.' =
CreateObject("'.$appname.'.'.$classname.'", '.$classparams.');');
- }
- }
- else
- {
- eval($parentobject.'->'.$classname.' =
CreateObject("'.$appname.'.'.$classname.'");');
- }
- }
-
- if ($functionparams != '_UNDEF_' && ($functionparams ||
$functionparams != 'True'))
- {
- eval('$returnval =
'.$parentobject.'->'.$classname.'->'.$functionname.'('.$functionparams.');');
- return $returnval;
- }
- else
- {
- eval('$returnval =
'.$parentobject.'->'.$classname.'->'.$functionname.'();');
- return $returnval;
- }
- }
- else
- {
- return 'error in parts';
- }
- }
- /*!
@function lang
@abstract function to handle multilanguage support
--- 35,41 ----
}
! include(PHPGW_API_INC.'/common_functions.inc.php');
/*!
@function lang
@abstract function to handle multilanguage support
***************
*** 578,658 ****
{
return $GLOBALS['phpgw']->common->check_code($code);
- }
-
- /*!
- @function get_account_id
- @abstract Return a properly formatted account_id.
- @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.
- @syntax get_account_id($accountid);
- @example $account_id = get_account_id($accountid);
- @param $account_id either a name or an id
- @param $default_id either a name or an id
- */
- function get_account_id($account_id = '',$default_id = '')
- {
- if (gettype($account_id) == 'integer')
- {
- return $account_id;
- }
- elseif ($account_id == '')
- {
- if ($default_id == '')
- {
- return
(isset($GLOBALS['phpgw_info']['user']['account_id'])?$GLOBALS['phpgw_info']['user']['account_id']:0);
- }
- elseif (is_string($default_id))
- {
- return
$GLOBALS['phpgw']->accounts->name2id($default_id);
- }
- return intval($default_id);
- }
- elseif (is_string($account_id))
- {
-
if($GLOBALS['phpgw']->accounts->exists(intval($account_id)) == True)
- {
- return intval($account_id);
- }
- else
- {
- return
$GLOBALS['phpgw']->accounts->name2id($account_id);
- }
- }
- }
-
- /*!
- @function filesystem_separator
- @abstract sets the file system seperator depending on OS
- @result file system separator
- */
- function filesystem_separator()
- {
- if (PHP_OS == 'Windows' || PHP_OS == 'OS/2')
- {
- return '\\';
- }
- else
- {
- return '/';
- }
- }
-
- /* Just a wrapper to my new print_r() function I added to the php3
support file. Seek3r */
- function _debug_array($array)
- {
- $four = False;
- if(@floor(phpversion()) == 4)
- {
- $four = True;
- }
- if($four)
- {
- echo '<pre>';
- }
- print_r($array);
- if($four)
- {
- echo '</pre>';
- }
}
--- 59,62 ----
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] CVS: phpgwapi/inc common_functions.inc.php,NONE,1.1 functions.inc.php,1.131,1.132,
Mark A Peters <address@hidden> <=
- Prev by Date:
[Phpgroupware-cvs] CVS: phpgwapi/setup tables_update.inc.php,1.55,1.56 tables_update_0_9_14.inc.php,1.1,1.2
- Next by Date:
[Phpgroupware-cvs] CVS: inv/templates/default category_form.tpl,1.22,1.22.2.1 inv_listproducts.tpl,1.19,1.19.2.1 invoice_print.tpl,1.12,1.12.2.1 listcategorys.tpl,1.20,1.20.2.1 product_form.tpl,1.30,1.30.2.1
- Previous by thread:
[Phpgroupware-cvs] CVS: phpgwapi/setup tables_update.inc.php,1.55,1.56 tables_update_0_9_14.inc.php,1.1,1.2
- Next by thread:
[Phpgroupware-cvs] CVS: inv/templates/default category_form.tpl,1.22,1.22.2.1 inv_listproducts.tpl,1.19,1.19.2.1 invoice_print.tpl,1.12,1.12.2.1 listcategorys.tpl,1.20,1.20.2.1 product_form.tpl,1.30,1.30.2.1
- Index(es):