Completed
Push — 14.2 ( c53e78...a8db63 )
by Ralf
29:08
created
phpgwapi/inc/class.categories.inc.php 1 patch
Doc Comments   +20 added lines, -28 removed lines patch added patch discarded remove patch
@@ -178,18 +178,16 @@  discard block
 block discarded – undo
178 178
 	/**
179 179
 	 * return an array populated with categories
180 180
 	 *
181
-	 * @param string $type='all' 'subs','mains','appandmains','appandsubs','noglobal','noglobalapp', defaults to 'all'
182
-	 * @param int $start=0 see $limit
181
+	 * @param int $start see $limit
183 182
 	 * @param boolean|int $limit if true limited query to maxmatches rows (starting with $start)
184 183
 	 * @param string $query='' query-pattern
185
-	 * @param string $sort='ASC' sort order, defaults to 'ASC'
186 184
 	 * @param string $order='' order by, default cat_main, cat_level, cat_name ASC
187 185
 	 * @param boolean|string $globals includes the global egroupware categories or not,
188 186
 	 * 	'all_no_acl' to return global and all non-private user categories independent of ACL
189
-	 * @param array|int $parent_id=null return only subcats of $parent_id(s)
187
+	 * @param array|int $parent_id return only subcats of $parent_id(s)
190 188
 	 * @param int $lastmod = -1 if > 0 return only cats modified since then
191 189
 	 * @param string $column='' if column-name given only that column is returned, not the full array with all cat-data
192
-	 * @param array $filter=null array with column-name (without cat_-prefix) => value pairs (! negates the value)
190
+	 * @param array $filter array with column-name (without cat_-prefix) => value pairs (! negates the value)
193 191
 	 * @return array of cat-arrays or $column values
194 192
 	 */
195 193
 	function return_array($type='all', $start=0, $limit=true, $query='', $sort='ASC',$order='',$globals=false, $parent_id=null, $lastmod=-1, $column='', $filter=null)
@@ -324,15 +322,13 @@  discard block
 block discarded – undo
324 322
 	/**
325 323
 	 * return a sorted array populated with categories (main sorting criteria is hierachy!)
326 324
 	 *
327
-	 * @param int $start=0 see $limit
328
-	 * @param boolean|int $limit if true limited query to maxmatches rows (starting with $start)
325
+	 * @param int $start see $limit
326
+	 * @param boolean $limit if true limited query to maxmatches rows (starting with $start)
329 327
 	 * @param string $query='' query-pattern
330
-	 * @param string $sort='ASC' sort order, either defaults to 'ASC'
331
-	 * @param string $order='cat_name' order by
332 328
 	 * @param boolean|string $globals includes the global egroupware categories or not,
333 329
 	 * 	'all_no_acl' to return global and all non-private user categories independent of ACL
334
-	 * @param array|int $parent_id=0 return only subcats of $parent_id(s)
335
-	 * @param boolean $unserialize_data=true return $cat['data'] as array (not serialized array)
330
+	 * @param array|int $parent_id return only subcats of $parent_id(s)
331
+	 * @param boolean $unserialize_data return $cat['data'] as array (not serialized array)
336 332
 	 * @return array with cats
337 333
 	 */
338 334
 	function return_sorted_array($start=0,$limit=True,$query='',$sort='ASC',$order='cat_name',$globals=False, $parent_id=0,$unserialize_data=true,$filter=null)
@@ -429,7 +425,7 @@  discard block
 block discarded – undo
429 425
 	 *
430 426
 	 * Owner and appname are set from the values used to instanciate the class!
431 427
 	 *
432
-	 * @param array $value cat-data
428
+	 * @param array $values cat-data
433 429
 	 * @return int new cat-id
434 430
 	 */
435 431
 	function add($values)
@@ -508,9 +504,9 @@  discard block
 block discarded – undo
508 504
 	 *
509 505
 	 * @param int $needed necessary ACL right: EGW_ACL_{READ|EDIT|DELETE}
510 506
 	 * @param mixed $category category as array or the category_id
511
-	 * @param boolean $no_acl_check=false if true, grants are NOT checked, gives access to all non-private categories of all users
507
+	 * @param boolean $no_acl_check if true, grants are NOT checked, gives access to all non-private categories of all users
512 508
 	 * @param boolean $allow_global_read if true, global cats are allowed (independent of app) for reading
513
-	 * @return boolean true permission granted, false for permission denied, null for category does not exist
509
+	 * @return null|boolean true permission granted, false for permission denied, null for category does not exist
514 510
 	 */
515 511
 	public function check_perms($needed, $category, $no_acl_check=false, $allow_global_read=false)
516 512
 	{
@@ -570,8 +566,8 @@  discard block
 block discarded – undo
570 566
 	 * delete a category
571 567
 	 *
572 568
 	 * @param int $cat_id category id
573
-	 * @param boolean $drop_subs=false if true delete sub-cats too
574
-	 * @param boolean $modify_subs=false if true make the subs owned by the parent of $cat_id
569
+	 * @param boolean $drop_subs if true delete sub-cats too
570
+	 * @param boolean $modify_subs if true make the subs owned by the parent of $cat_id
575 571
 	 */
576 572
 	function delete($cat_id, $drop_subs = False, $modify_subs = False)
577 573
 	{
@@ -769,7 +765,6 @@  discard block
 block discarded – undo
769 765
 	 * - cat's of other user
770 766
 	 *
771 767
 	 * @param string $cat_name cat-name
772
-	 * @param boolean|string $strip=false if true, strips 'X-'  ($strip) from category names added by some SyncML clients
773 768
 	 * @return int cat-id or 0 if not found
774 769
 	 */
775 770
 	function name2id($cat_name, $strip=false)
@@ -821,8 +816,8 @@  discard block
 block discarded – undo
821 816
 	 * Check if category is global (owner <= 0 || appname == 'phpgw')
822 817
 	 *
823 818
 	 * @param int|array $cat
824
-	 * @param boolean $application_global=false true check for application global categories only (appname == 'phpgw')
825
-	 * @return boolean
819
+	 * @param boolean $application_global true check for application global categories only (appname == 'phpgw')
820
+	 * @return null|boolean
826 821
 	 */
827 822
 	static function is_global($cat,$application_global=false)
828 823
 	{
@@ -842,8 +837,7 @@  discard block
 block discarded – undo
842 837
 	 * We use a shared cache together with read
843 838
 	 * $item == 'data' is returned as array (not serialized array)!
844 839
 	 *
845
-	 * @param int $cat_id=0 cat-id
846
-	 * @param string $item='name' requested information, 'path' = / delimited path of category names (incl. parents)
840
+	 * @param int $cat_id cat-id
847 841
 	 * @return string information or '--' if not found or !$cat_id
848 842
 	 */
849 843
 	static function id2name($cat_id=0, $item='name')
@@ -883,8 +877,8 @@  discard block
 block discarded – undo
883 877
 	 *
884 878
 	 * @param string $type subs or mains
885 879
 	 * @param string $cat_name='' category name
886
-	 * @param int $cat_id=0 category id
887
-	 * @param int $parent=0 category id of parent
880
+	 * @param int $cat_id category id
881
+	 * @param int $parent category id of parent
888 882
 	 * @return int/boolean cat_id or false if cat not exists
889 883
 	 */
890 884
 	function exists($type,$cat_name = '',$cat_id = 0,$parent = 0)
@@ -914,8 +908,6 @@  discard block
 block discarded – undo
914 908
 	 * Change the owner of all cats owned by $owner to $to OR deletes them if !$to
915 909
 	 *
916 910
 	 * @param int $owner owner or the cats to delete or change
917
-	 * @param int $to=0 new owner or 0 to delete the cats
918
-	 * @param string $app='' if given only cats matching $app are modifed/deleted
919 911
 	 */
920 912
 	function change_owner($owner,$to=0,$app='')
921 913
 	{
@@ -1030,7 +1022,7 @@  discard block
 block discarded – undo
1030 1022
 	 *
1031 1023
 	 * @param string appname
1032 1024
 	 *
1033
-	 * @return Returns the URL, but you do not need to do anything with it.
1025
+	 * @return string the URL, but you do not need to do anything with it.
1034 1026
 	 */
1035 1027
 	public static function css($appname)
1036 1028
 	{
@@ -1047,7 +1039,7 @@  discard block
 block discarded – undo
1047 1039
 	 * Delete categories belonging to a given account, when account got deleted
1048 1040
 	 *
1049 1041
 	 * @param int $account_id
1050
-	 * @param int $new_owner=null for users data can be transfered to new owner
1042
+	 * @param int $new_owner for users data can be transfered to new owner
1051 1043
 	 * @return int number of deleted or modified categories
1052 1044
 	 */
1053 1045
 	public static function delete_account($account_id, $new_owner=null)
@@ -1138,7 +1130,7 @@  discard block
 block discarded – undo
1138 1130
 	/**
1139 1131
 	 * return into a select box, list or other formats
1140 1132
 	 *
1141
-	 * @param string/array $format string 'select' or 'list', or array with all params
1133
+	 * @param string $format string 'select' or 'list', or array with all params
1142 1134
 	 * @param string $type='' subs or mains
1143 1135
 	 * @param int/array $selected - cat_id or array with cat_id values
1144 1136
 	 * @param boolean $globals True or False, includes the global egroupware categories or not
Please login to merge, or discard this patch.
phpgwapi/inc/class.common.inc.php 1 patch
Doc Comments   +14 added lines, -20 removed lines patch added patch discarded remove patch
@@ -31,6 +31,7 @@  discard block
 block discarded – undo
31 31
 	 *
32 32
 	 * @param $category=LC_ALL category to set, see setlocal function
33 33
 	 * @param $charset=null default system charset
34
+	 * @param integer $category
34 35
 	 * @return string the local (or best estimate) set
35 36
 	 */
36 37
 	static function setlocale($category=LC_ALL,$charset=null)
@@ -158,7 +159,7 @@  discard block
 block discarded – undo
158 159
 	* get the local content id from a global UID
159 160
 	*
160 161
 	* @param sting $_globalUid the global UID
161
-	* @return int local egw content id
162
+	* @return false|string local egw content id
162 163
 	*/
163 164
 	static function get_egwId($_globalUid)
164 165
 	{
@@ -278,7 +279,7 @@  discard block
 block discarded – undo
278 279
 	/**
279 280
 	 * return a random string of size $size
280 281
 	 *
281
-	 * @param $size int-size of random string to return
282
+	 * @param integer $size int-size of random string to return
282 283
 	 */
283 284
 	static function randomstring($size)
284 285
 	{
@@ -307,6 +308,7 @@  discard block
 block discarded – undo
307 308
 	 * This is used for reporting errors in a nice format.
308 309
 	 *
309 310
 	 * @param $error - array of errors
311
+	 * @param string $errors
310 312
 	 */
311 313
 	static function error_list($errors,$text='Error')
312 314
 	{
@@ -573,7 +575,7 @@  discard block
 block discarded – undo
573 575
 	 * get template dir of an application
574 576
 	 *
575 577
 	 * @param $appname appication name optional can be derived from $GLOBALS['egw_info']['flags']['currentapp'];
576
-	 * @return string|boolean dir or false if no dir is found
578
+	 * @return string|false dir or false if no dir is found
577 579
 	 */
578 580
 	static function get_tpl_dir($appname = '')
579 581
 	{
@@ -631,6 +633,7 @@  discard block
 block discarded – undo
631 633
 	 * 	on a per image basis to the default dir
632 634
 	 *
633 635
 	 * @deprecated
636
+	 * @param string $dir
634 637
 	 */
635 638
 	static function is_image_dir($dir)
636 639
 	{
@@ -742,11 +745,8 @@  discard block
 block discarded – undo
742 745
 	/**
743 746
 	 * Searches an image of a given type, if not found also without extension
744 747
 	 *
745
-	 * @param string $appname
746 748
 	 * @param string|array $image one or more image-name in order of precedence
747 749
 	 * @param string $extension='' extension to $image, makes sense only with an array
748
-	 * @param boolean $svg=false should svg images be returned or not:
749
-	 *	true: always return svg, false: never return svg (current default), null: browser dependent, see svg_usable()
750 750
 	 * @return string url of image or null if not found
751 751
 	 */
752 752
 	static function image_on($app,$image,$extension='_on',$svg=false)
@@ -757,11 +757,8 @@  discard block
 block discarded – undo
757 757
 	/**
758 758
 	 * Searches a appname, template and maybe language and type-specific image
759 759
 	 *
760
-	 * @param string $appname
761 760
 	 * @param string|array $image one or more image-name in order of precedence
762 761
 	 * @param string $extension='' extension to $image, makes sense only with an array
763
-	 * @param boolean $svg=false should svg images be returned or not:
764
-	 *	true: always return svg, false: never return svg (current default), null: browser dependent, see svg_usable()
765 762
 	 * @return string url of image or null if not found
766 763
 	 */
767 764
 	static function image($app,$image,$extension='',$svg=false)
@@ -841,8 +838,8 @@  discard block
 block discarded – undo
841 838
 	 *
842 839
 	 * VFS image directory is treated like an application named 'vfs'.
843 840
 	 *
844
-	 * @param string $template_set=null 'default', 'idots', 'jerryr', default is template-set from user prefs
845
-	 * @param boolean $svg=null prefer svg images, default for all browsers but IE<9
841
+	 * @param string $template_set 'default', 'idots', 'jerryr', default is template-set from user prefs
842
+	 * @param boolean $svg
846 843
 	 * @return array of application => image-name => full path
847 844
 	 */
848 845
 	static function image_map($template_set=null, $svg=null)
@@ -1119,9 +1116,8 @@  discard block
 block discarded – undo
1119 1116
 	/**
1120 1117
 	 * return a formatted timestamp or current time
1121 1118
 	 *
1122
-	 * @param int $t=0 timestamp, default current time
1123 1119
 	 * @param string $format='' timeformat, default '' = read from the user prefernces
1124
-	 * @param boolean $adjust_to_usertime=true should datetime::tz_offset be added to $t or not, default true
1120
+	 * @param boolean $adjust_to_usertime should datetime::tz_offset be added to $t or not, default true
1125 1121
 	 * @deprecated use egw_time::to($time, $format) egw_time::server2user($time, $format)
1126 1122
 	 * @return string the formated date/time
1127 1123
 	 */
@@ -1139,8 +1135,7 @@  discard block
 block discarded – undo
1139 1135
 	 *
1140 1136
 	 * @param string $yearstr year
1141 1137
 	 * @param string $monthstr month
1142
-	 * @param string $day day
1143
-	 * @param boolean $add_seperator=false add the separator specifed in the prefs or not, default no
1138
+	 * @param boolean $add_seperator add the separator specifed in the prefs or not, default no
1144 1139
 	 * @return string
1145 1140
 	 */
1146 1141
 	static function dateformatorder($yearstr,$monthstr,$daystr,$add_seperator = False)
@@ -1165,7 +1160,6 @@  discard block
 block discarded – undo
1165 1160
 	 *
1166 1161
 	 * @param int $hour hour
1167 1162
 	 * @param int $min minutes
1168
-	 * @param int/string $sec='' defaults to ''
1169 1163
 	 * @return string formated time
1170 1164
 	 */
1171 1165
 	static function formattime($hour,$min,$sec='')
@@ -1494,8 +1488,8 @@  discard block
 block discarded – undo
1494 1488
 	 * Return a value for the next id an app/class may need to insert values into LDAP
1495 1489
 	 *
1496 1490
 	 * @param string $appname app-name
1497
-	 * @param int $min=0 if != 0 minimum id
1498
-	 * @param int $max=0 if != 0 maximum id allowed, if it would be exceeded we return false
1491
+	 * @param int $min if != 0 minimum id
1492
+	 * @param int $max if != 0 maximum id allowed, if it would be exceeded we return false
1499 1493
 	 * @return int/boolean the next id or false if $max given and exceeded
1500 1494
 	 */
1501 1495
 	static function next_id($appname,$min=0,$max=0)
@@ -1524,8 +1518,8 @@  discard block
 block discarded – undo
1524 1518
 	 * Return a value for the last id entered, which an app may need to check values for LDAP
1525 1519
 	 *
1526 1520
 	 * @param string $appname app-name
1527
-	 * @param int $min=0 if != 0 minimum id
1528
-	 * @param int $max=0 if != 0 maximum id allowed, if it would be exceeded we return false
1521
+	 * @param int $min if != 0 minimum id
1522
+	 * @param int $max if != 0 maximum id allowed, if it would be exceeded we return false
1529 1523
 	 * @return int current id in the next_id table for a particular app/class or -1 for no app and false if $max is exceeded.
1530 1524
 	 */
1531 1525
 	static function last_id($appname,$min=0,$max=0)
Please login to merge, or discard this patch.
phpgwapi/inc/class.config.inc.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -118,7 +118,7 @@  discard block
 block discarded – undo
118 118
 	 * @param string $name name of the config-value
119 119
 	 * @param mixed $value content, empty or null values are not saved, but deleted
120 120
 	 * @param string $app app-name (depreacted to use default of $this->appname set via the constructor!)
121
-	 * @param boolean $update_cache=true update instance cache and for phpgwapi invalidate session-cache
121
+	 * @param boolean $update_cache update instance cache and for phpgwapi invalidate session-cache
122 122
 	 * @throws egw_exception_wrong_parameter if no $app parameter given for static call
123 123
 	 * @return boolean|int true if no change, else number of affected rows
124 124
 	 */
@@ -195,7 +195,7 @@  discard block
 block discarded – undo
195 195
 	/**
196 196
 	 * sets a single value in the repositry, you need to call save_repository after
197 197
 	 *
198
-	 * @param $variable_name string name of the config
198
+	 * @param string $variable_name string name of the config
199 199
 	 * @param $variable_data mixed the content
200 200
 	 */
201 201
 	function value($variable_name,$variable_data)
@@ -224,8 +224,8 @@  discard block
 block discarded – undo
224 224
 	 * get customfield array of an application
225 225
 	 *
226 226
 	 * @param string $app
227
-	 * @param boolean $all_private_too=false should all the private fields be returned too, default no
228
-	 * @param string $only_type2=null if given only return fields of type2 == $only_type2
227
+	 * @param boolean $all_private_too should all the private fields be returned too, default no
228
+	 * @param string $only_type2 if given only return fields of type2 == $only_type2
229 229
 	 * @deprecated use egw_customfields::get()
230 230
 	 * @return array with customfields
231 231
 	 */
Please login to merge, or discard this patch.
phpgwapi/inc/class.contacts.inc.php 1 patch
Doc Comments   +8 added lines, -10 removed lines patch added patch discarded remove patch
@@ -67,14 +67,14 @@  discard block
 block discarded – undo
67 67
 	 * This method was named read in eGW 1.0 and 1.2
68 68
 	 *
69 69
 	 * @deprecated since 1.3 use search() instead
70
-	 * @param int $start=0 starting number of the range, if $limit != 0
71
-	 * @param int $limit=0 max. number of entries to return, 0=all
72
-	 * @param array $fields=null fields to return or null for all stock fields, fields are either in the keys or values
70
+	 * @param int $start starting number of the range, if $limit != 0
71
+	 * @param int $limit max. number of entries to return, 0=all
72
+	 * @param array $fields fields to return or null for all stock fields, fields are either in the keys or values
73 73
 	 * @param string $query='' search pattern or '' for none
74 74
 	 * @param string $filter='' filters with syntax like <name>=<value>,<name2>=<value2>,<name3>=!'' for not empty
75 75
 	 * @param string $sort='' sorting: ASC or DESC
76 76
 	 * @param string $order='' column to order, default ('') n_family,n_given,email ASC
77
-	 * @param int $lastmod=-1 return only values modified after given timestamp, default (-1) return all
77
+	 * @param int $lastmod return only values modified after given timestamp, default (-1) return all
78 78
 	 * @param string $cquery='' return only entries starting with given character, default ('') all
79 79
 	 * @return array of contacts
80 80
 	 */
@@ -182,9 +182,8 @@  discard block
 block discarded – undo
182 182
 	 * @deprecated since 1.3 use save() instead
183 183
 	 * @param int $owner owner of the entry
184 184
 	 * @param array $fields contains access, cat_id and tif if their param is null
185
-	 * @param string $access=null 'private' or 'public'
186
-	 * @param int $cat_id=null
187
-	 * @param string $tid=null 'n'
185
+	 * @param string $access 'private' or 'public'
186
+	 * @param int $cat_id
188 187
 	 * @return array/boolean contact or false on failure
189 188
 	 */
190 189
 	function add($owner,$fields,$access=NULL,$cat_id=NULL,$tid=NULL)
@@ -214,9 +213,8 @@  discard block
 block discarded – undo
214 213
 	 * @param int $id id of the entry
215 214
 	 * @param int $owner owner of the entry
216 215
 	 * @param array $fields contains access, cat_id and tif if their param is null
217
-	 * @param string $access=null 'private' or 'public'
218
-	 * @param int $cat_id=null
219
-	 * @param string $tid=null 'n'
216
+	 * @param string $access 'private' or 'public'
217
+	 * @param int $cat_id
220 218
 	 * @return array/boolean contact or false on failure
221 219
 	 */
222 220
 	function update($id,$owner,$fields,$access=NULL,$cat_id=NULL,$tid=NULL)
Please login to merge, or discard this patch.
phpgwapi/inc/class.country.inc.php 1 patch
Doc Comments   +2 added lines, -5 removed lines patch added patch discarded remove patch
@@ -350,8 +350,6 @@  discard block
 block discarded – undo
350 350
 	 * Selectbox for country-selection
351 351
 	 *
352 352
 	 * @deprecated use html::select with country_array
353
-	 * @param string $selected 2-letter iso country-code
354
-	 * @param string $name='country'
355 353
 	 * @return string
356 354
 	 */
357 355
 	function form_select($code,$name='country')
@@ -362,8 +360,7 @@  discard block
 block discarded – undo
362 360
 	/**
363 361
 	 * Get country-name from the 2-letter iso code
364 362
 	 *
365
-	 * @param string $selected 2-letter iso country-code
366
-	 * @param boolean $translated=true use translated name or english
363
+	 * @param boolean $translated use translated name or english
367 364
 	 * @return string
368 365
 	 */
369 366
 	function get_full_name($code,$translated=true)
@@ -424,7 +421,7 @@  discard block
 block discarded – undo
424 421
 	/**
425 422
 	 * Get list of country names
426 423
 	 *
427
-	 * @param boolean $translated=true use translated names or english
424
+	 * @param boolean $translated use translated names or english
428 425
 	 * @return array with 2-letter code => name pairs
429 426
 	 */
430 427
 	function countries($translated=true)
Please login to merge, or discard this patch.
phpgwapi/inc/class.db_backup.inc.php 1 patch
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -496,7 +496,7 @@  discard block
 block discarded – undo
496 496
 	 * Restore data from a (compressed) csv file
497 497
 	 *
498 498
 	 * @param resource $f file opened with fopen for reading
499
-	 * @param int|string $insert_n_rows =10 how many rows to insert in one sql statement, or string with column-name used as unique key for insert
499
+	 * @param integer $insert_n_rows =10 how many rows to insert in one sql statement, or string with column-name used as unique key for insert
500 500
 	 * @returns int number of rows read from csv file
501 501
 	 */
502 502
 	function db_restore($f, $insert_n_rows=10)
@@ -1044,7 +1044,7 @@  discard block
 block discarded – undo
1044 1044
 	/**
1045 1045
 	 * Backup all schemas in the form of a setup/tables_current.inc.php file
1046 1046
 	 *
1047
-	 * @param resource|boolean $f
1047
+	 * @param resource $f
1048 1048
 	 */
1049 1049
 	function schema_backup($f=False)
1050 1050
 	{
@@ -1089,6 +1089,7 @@  discard block
 block discarded – undo
1089 1089
 	 * Dump an array as php source
1090 1090
 	 *
1091 1091
 	 * copied from etemplate/inc/class.db_tools.inc.php
1092
+	 * @param integer $depth
1092 1093
 	 */
1093 1094
 	private static function write_array($arr,$depth,$parent='')
1094 1095
 	{
Please login to merge, or discard this patch.
phpgwapi/inc/class.egw_cache.inc.php 1 patch
Doc Comments   +21 added lines, -24 removed lines patch added patch discarded remove patch
@@ -103,7 +103,7 @@  discard block
 block discarded – undo
103 103
 	 * @param string $app application storing data
104 104
 	 * @param string $location location name for data
105 105
 	 * @param mixed $data
106
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
106
+	 * @param int $expiration expiration time in seconds, default 0 = never
107 107
 	 * @return boolean true if data could be stored, false otherwise
108 108
 	 */
109 109
 	static public function setCache($level,$app,$location,$data,$expiration=0)
@@ -138,9 +138,9 @@  discard block
 block discarded – undo
138 138
 	 * @param string $level use egw_cache::(TREE|INSTANCE|SESSION|REQUEST)
139 139
 	 * @param string $app application storing data
140 140
 	 * @param string|array $location location(s) name for data
141
-	 * @param callback $callback=null callback to get/create the value, if it's not cache
141
+	 * @param callback $callback callback to get/create the value, if it's not cache
142 142
 	 * @param array $callback_params=array() array with parameters for the callback
143
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
143
+	 * @param int $expiration expiration time in seconds, default 0 = never
144 144
 	 * @return mixed NULL if data not found in cache (and no callback specified) or
145 145
 	 * 	if $location is an array: location => data pairs for existing location-data, non-existing is not returned
146 146
 	 */
@@ -242,7 +242,7 @@  discard block
 block discarded – undo
242 242
 	 * @param string $app application storing data
243 243
 	 * @param string $location location name for data
244 244
 	 * @param mixed $data
245
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
245
+	 * @param int $expiration expiration time in seconds, default 0 = never
246 246
 	 * @return boolean true if data could be stored, false otherwise
247 247
 	 */
248 248
 	static public function setTree($app,$location,$data,$expiration=0)
@@ -256,9 +256,9 @@  discard block
 block discarded – undo
256 256
 	 *
257 257
 	 * @param string $app application storing data
258 258
 	 * @param string $location location name for data
259
-	 * @param callback $callback=null callback to get/create the value, if it's not cache
259
+	 * @param callback $callback callback to get/create the value, if it's not cache
260 260
 	 * @param array $callback_params=array() array with parameters for the callback
261
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
261
+	 * @param int $expiration expiration time in seconds, default 0 = never
262 262
 	 * @return mixed NULL if data not found in cache (and no callback specified)
263 263
 	 */
264 264
 	static public function getTree($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
@@ -284,7 +284,7 @@  discard block
 block discarded – undo
284 284
 	 * @param string $app application storing data
285 285
 	 * @param string $location location name for data
286 286
 	 * @param mixed $data
287
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
287
+	 * @param int $expiration expiration time in seconds, default 0 = never
288 288
 	 * @return boolean true if data could be stored, false otherwise
289 289
 	 */
290 290
 	static public function setInstance($app,$location,$data,$expiration=0)
@@ -297,9 +297,9 @@  discard block
 block discarded – undo
297 297
 	 *
298 298
 	 * @param string $app application storing data
299 299
 	 * @param string $location location name for data
300
-	 * @param callback $callback=null callback to get/create the value, if it's not cache
300
+	 * @param string[] $callback callback to get/create the value, if it's not cache
301 301
 	 * @param array $callback_params=array() array with parameters for the callback
302
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
302
+	 * @param int $expiration expiration time in seconds, default 0 = never
303 303
 	 * @return mixed NULL if data not found in cache (and no callback specified)
304 304
 	 */
305 305
 	static public function getInstance($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
@@ -325,7 +325,7 @@  discard block
 block discarded – undo
325 325
 	 * @param string $app application storing data
326 326
 	 * @param string $location location name for data
327 327
 	 * @param mixed $data
328
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
328
+	 * @param int $expiration expiration time in seconds, default 0 = never
329 329
 	 * @return boolean true if data could be stored, false otherwise
330 330
 	 */
331 331
 	static public function setSession($app,$location,$data,$expiration=0)
@@ -348,9 +348,9 @@  discard block
 block discarded – undo
348 348
 	 *
349 349
 	 * @param string $app application storing data
350 350
 	 * @param string $location location name for data
351
-	 * @param callback $callback=null callback to get/create the value, if it's not cache
351
+	 * @param callback $callback callback to get/create the value, if it's not cache
352 352
 	 * @param array $callback_params=array() array with parameters for the callback
353
-	 * @param int $expiration=0 expiration time in seconds, default 0 = never
353
+	 * @param int $expiration expiration time in seconds, default 0 = never
354 354
 	 * @return mixed NULL if data not found in cache (and no callback specified)
355 355
 	 */
356 356
 	static public function &getSession($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
@@ -404,7 +404,7 @@  discard block
 block discarded – undo
404 404
 	 * @param string $app application storing data
405 405
 	 * @param string $location location name for data
406 406
 	 * @param mixed $data
407
-	 * @param int $expiration=0 expiration time is NOT used for REQUEST!
407
+	 * @param int $expiration expiration time is NOT used for REQUEST!
408 408
 	 * @return boolean true if data could be stored, false otherwise
409 409
 	 */
410 410
 	static public function setRequest($app,$location,$data,$expiration=0)
@@ -420,9 +420,9 @@  discard block
 block discarded – undo
420 420
 	 *
421 421
 	 * @param string $app application storing data
422 422
 	 * @param string $location location name for data
423
-	 * @param callback $callback=null callback to get/create the value, if it's not cache
423
+	 * @param callback $callback callback to get/create the value, if it's not cache
424 424
 	 * @param array $callback_params=array() array with parameters for the callback
425
-	 * @param int $expiration=0 expiration time is NOT used for REQUEST!
425
+	 * @param int $expiration expiration time is NOT used for REQUEST!
426 426
 	 * @return mixed NULL if data not found in cache (and no callback specified)
427 427
 	 */
428 428
 	static public function getRequest($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
@@ -459,7 +459,7 @@  discard block
 block discarded – undo
459 459
 	 * The returned provider already has an opened connection
460 460
 	 *
461 461
 	 * @param string $level egw_cache::(TREE|INSTANCE) or install_id
462
-	 * @param boolean $log_not_found=true false do not log if no provider found, used eg. to supress error via unsetCache during installation
462
+	 * @param boolean $log_not_found false do not log if no provider found, used eg. to supress error via unsetCache during installation
463 463
 	 * @return egw_cache_provider
464 464
 	 */
465 465
 	static protected function get_provider($level, $log_not_found=true)
@@ -525,7 +525,6 @@  discard block
 block discarded – undo
525 525
 	 * Get a system configuration, even if in setup and it's not read
526 526
 	 *
527 527
 	 * @param string $name
528
-	 * @param boolean $throw=true throw an exception, if we can't retriev the value
529 528
 	 * @return string|boolean string with config or false if not found and !$throw
530 529
 	 */
531 530
 	static public function get_system_config($name,$throw=true)
@@ -565,8 +564,7 @@  discard block
 block discarded – undo
565 564
 	/**
566 565
 	 * Flush (delete) whole (instance) cache or application/class specific part of it
567 566
 	 *
568
-	 * @param $string $level=self::INSTANCE
569
-	 * @param string $app=null
567
+	 * @param string $app
570 568
 	 */
571 569
 	static public function flush($level=self::INSTANCE, $app=null)
572 570
 	{
@@ -612,7 +610,7 @@  discard block
 block discarded – undo
612 610
 	/**
613 611
 	 * Generate a new instance key and by doing so effectivly flushes whole instance cache
614 612
 	 *
615
-	 * @param string $install_id=null default use install_id of current instance
613
+	 * @param string $install_id default use install_id of current instance
616 614
 	 * @return string new key also stored in self::$instance_key
617 615
 	 */
618 616
 	static public function generate_instance_key($install_id=null)
@@ -633,8 +631,7 @@  discard block
 block discarded – undo
633 631
 	 * Get keys array from $level, $app and $location
634 632
 	 *
635 633
 	 * @param string $level egw_cache::(TREE|INSTANCE) or instance_id
636
-	 * @param string $app=null
637
-	 * @param string $location=null
634
+	 * @param string $location
638 635
 	 * @return array
639 636
 	 */
640 637
 	static public function keys($level, $app=null, $location=null)
@@ -714,7 +711,7 @@  discard block
 block discarded – undo
714 711
 	 *
715 712
 	 * @param array $keys eg. array($level,$app,$location)
716 713
 	 * @param mixed $data
717
-	 * @param int $expiration=0
714
+	 * @param int $expiration
718 715
 	 * @return boolean true on success, false on error
719 716
 	 */
720 717
 	function set(array $keys,$data,$expiration=0);
@@ -769,7 +766,7 @@  discard block
 block discarded – undo
769 766
 	/**
770 767
 	 * Run several checks on a caching provider
771 768
 	 *
772
-	 * @param boolean $verbose=false true: echo failed checks
769
+	 * @param boolean $verbose true: echo failed checks
773 770
 	 * @return int number of failed checks
774 771
 	 */
775 772
 	function check($verbose=false)
Please login to merge, or discard this patch.
phpgwapi/inc/class.egw_cache_files.inc.php 1 patch
Doc Comments   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -59,7 +59,7 @@  discard block
 block discarded – undo
59 59
 	 *
60 60
 	 * @param array $keys eg. array($level,$app,$location)
61 61
 	 * @param mixed $data
62
-	 * @param int $expiration=0
62
+	 * @param int $expiration
63 63
 	 * @return boolean true on success, false on error
64 64
 	 */
65 65
 	function set(array $keys,$data,$expiration=0)
@@ -162,7 +162,6 @@  discard block
 block discarded – undo
162 162
 	 * Create a path from $keys and $basepath
163 163
 	 *
164 164
 	 * @param array $keys
165
-	 * @param boolean $mkdir=false should we create the directory
166 165
 	 * @return string
167 166
 	 */
168 167
 	function filename(array $keys,$mkdir=false)
Please login to merge, or discard this patch.
phpgwapi/inc/class.egw_cache_memcache.inc.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -70,7 +70,7 @@
 block discarded – undo
70 70
 	 *
71 71
 	 * @param array $keys eg. array($level,$app,$location)
72 72
 	 * @param mixed $data
73
-	 * @param int $expiration=0
73
+	 * @param int $expiration
74 74
 	 * @return boolean true on success, false on error
75 75
 	 */
76 76
 	function set(array $keys,$data,$expiration=0)
Please login to merge, or discard this patch.