EGroupware / egroupware

etemplate/inc/class.so_sql.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -704,7 +704,7 @@ 
 	 *
 	 * @param array $_fields
 	 * @param boolean $merge =true if true $fields will be merged with $this->data (after update!), otherwise $this->data will be just $fields
-	 * @return int|boolean 0 on success, or errno != 0 on error, or true if $extra_where is given and no rows affected
+	 * @return integer 0 on success, or errno != 0 on error, or true if $extra_where is given and no rows affected
 	 */
 	function update($_fields,$merge=true)
 	{
@@ -1194,7 +1194,7 @@ 
 	 * @param string &$wildcard ='' on return wildcard char to use, if pattern does not already contain wildcards!
 	 * @param string &$op ='AND' on return boolean operation to use, if pattern does not start with ! we use OR else AND
 	 * @param string $extra_col =null extra column to search
-	 * @param array $search_cols =array() List of columns to search.  If not provided, all columns in $this->db_cols will be considered
+	 * @param string[] $search_cols =array() List of columns to search.  If not provided, all columns in $this->db_cols will be considered
 	 * @return array or column => value pairs
 	 */
 	public function search2criteria($_pattern,&$wildcard='',&$op='AND',$extra_col=null, $search_cols = array())

etemplate/inc/class.so_sql2.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	 * @param string $table should be set if table-defs to be read from <app>/setup/tables_current.inc.php
 	 * @param object/db $db database object, if not the one in $GLOBALS['egw']->db should be used, eg. for an other database
 	 * @param string $colum_prefix='' column prefix to automatic remove from the column-name, if the column name starts with it
-	 * @param boolean $no_clone=false can we avoid to clone the db-object, default no
+	 * @param boolean $no_clone can we avoid to clone the db-object, default no
 	 * 	new code using appnames and foreach(select(...,$app) can set it to avoid an extra instance of the db object
 	 *
 	 * @return so_sql2

etemplate/inc/class.so_sql_cf.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -366,7 +366,7 @@ 
 	 * @param string $join ='' sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
 	 *	"LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join!
 	 * @param boolean $need_full_no_count =false If true an unlimited query is run to determine the total number of rows, default false
-	 * @param mixed $only_keys =false, see search
+	 * @param boolean $only_keys =false, see search
 	 * @param string|array $extra_cols =array()
 	 * @return int total number of rows
 	 */
@@ -734,7 +734,7 @@ 
 	 * Check if cf is stored as 1:N relation in DB and array in memory
 	 *
 	 * @param string $name
-	 * @return string
+	 * @return boolean
 	 */
 	function is_multiple($name)
 	{

etemplate/inc/class.soetemplate.inc.php

Doc Comments +4 added lines, -5 removed lines

@@ -161,7 +161,7 @@ 
 	 *
 	 * @param string $type type of the widget
 	 * @param string $name name of widget
-	 * @param array $attributes=null array with further attributes
+	 * @param array $attributes array with further attributes
 	 * @return array the cell
 	 */
 	static function empty_cell($type='label',$name='',$attributes=null)
@@ -685,7 +685,7 @@ 
 	 * Calls it self recursivly for arrays / the rows
 	 *
 	 * @param array $arr the array to compress
-	 * @param boolean $remove_all_objs if true unset all objs, on false use as_array to save only the data of objs
+	 * @param boolean $remove_objs if true unset all objs, on false use as_array to save only the data of objs
 	 * @return array
 	 */
 	function compress_array($arr,$remove_objs=false)
@@ -1102,9 +1102,8 @@ 
 	 *
 	 * Please note: as call_user_func_array does not return references, methods ($func is an array) can not either!!!
 	 *
-	 * @param string/array $func function to use or array($obj,'method')
+	 * @param callable $func function to use or array($obj,'method')
 	 * @param mixed &$extra extra parameter passed to function
-	 * @param string $path='/' start-path
 	 * @return mixed return-value of func or null if nothing returned at all
 	 */
 	function &widget_tree_walk($func,&$extra,$path='/')
@@ -1146,7 +1145,7 @@ 
 	 * a further widget with children.
 	 *
 	 * @param array $widget the widget(-tree) the function should be applied too
-	 * @param string/array $func function to use or array($obj,'method')
+	 * @param callable $func function to use or array($obj,'method')
 	 * @param mixed &$extra extra parameter passed to function
 	 * @param string $path path of widget in the widget-tree
 	 * @return mixed return-value of func or null if nothing returned at all

etemplate/inc/class.solangfile.inc.php

Doc Comments +13 added lines

@@ -85,6 +85,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $fname
+	 */
 	function special_file($app,$fname,$langs_in)
 	{
 		//echo "<p>solangfile::special_file(app='$app',fname='$fname',langs_in='$langs_in')</p>\n";
@@ -183,6 +186,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $fd
+	 */
 	function parse_php_app($app,$fd)
 	{
 		$reg_expr = '/('.implode('|',array_keys($this->functions)).")[ \t]*\([ \t]*(.*)$/i";
@@ -275,6 +281,10 @@ 
 		$d->close();
 	}
 
+	/**
+	 * @param string $app
+	 * @param string $userlang
+	 */
 	function missing_app($app,$userlang=en)
 	{
 		$cur_lang=$this->load_app($app,$userlang);
@@ -421,6 +431,9 @@ 
 }
 if (!function_exists('display_section') && $_GET['menuaction'] == 'developer_tools.uilangfile.missingphrase')
 {
+	/**
+	 * @param string $appname
+	 */
 	function display_section($appname,$file,$file2='')		// hook_preferences, hook_admin
 	{
 		if (is_array($file2))

etemplate/inc/class.tab_widget.inc.php

Doc Comments -1 removed lines

@@ -55,7 +55,6 @@
 		 *
 		 * This function is called before the extension gets rendered
 		 *
-		 * @param string $name form-name of the control
 		 * @param mixed &$value value / existing content, can be modified
 		 * @param array &$cell array with the widget, can be modified for ui-independent widgets
 		 * @param array &$readonlys names of widgets as key, to be made readonly

etemplate/inc/class.uilangfile.inc.php

Doc Comments +6 added lines

@@ -484,6 +484,9 @@ 
 		return str_replace(array('[',']','&','"'),array('%5B','%5D','&','"'),$id);
 	}
 
+	/**
+	 * @return string
+	 */
 	function recode_id($id)
 	{
 		if (get_magic_quotes_gpc())
@@ -493,6 +496,9 @@ 
 		return str_replace(array('%5B','%5D'),array('[',']'),$id);	// & + " are recode by php
 	}
 
+	/**
+	 * @param string $which
+	 */
 	function download($which,$userlang)
 	{
 		switch ($which)

etemplate/inc/class.url_widget.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
 	 * replaces '%1' with the phonenumber to call, '%u' with the user's account_lid and '%t' with his work-phone-number
 	 *
 	 * @param string $number phone number
-	 * @return string|boolean string with link or false if no no telephony integration configured
+	 * @return false|string string with link or false if no no telephony integration configured
 	 */
 	static function phone2link($number)
 	{

etemplate/inc/class.vfs_widget.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -368,7 +368,6 @@ 
 	 * @param mixed &$value
 	 * @param string $path vfs path of download
 	 * @param string $name name of widget
-	 * @param string $label=null label, if not set basename($path) is used
 	 * @return array
 	 */
 	static function file_widget(&$value,$path,$name,$label=null)
@@ -404,7 +403,7 @@ 
 	 * If you rename a file, you have to clear the cache ($clear_after=true)!
 	 *
 	 * @param string &$path on call path without extension, if existing on return full path incl. extension
-	 * @param boolean $clear_after=null clear file-cache after (true) or before (false), default dont clear
+	 * @param boolean $clear_after clear file-cache after (true) or before (false), default dont clear
 	 * @return
 	 */
 	static function file_exists(&$path,$clear_after=null)