@@ -311,6 +311,8 @@ discard block |
||
311 | 311 | * @param string $path |
312 | 312 | * @param array &$dav |
313 | 313 | * @param array &$allow |
314 | + * @param integer[] $dav |
|
315 | + * @param boolean $allow |
|
314 | 316 | */ |
315 | 317 | function OPTIONS($path, &$dav, &$allow) |
316 | 318 | { |
@@ -1380,7 +1382,7 @@ discard block |
||
1380 | 1382 | * @param int|string $id |
1381 | 1383 | * @param array $attach array of array with values for keys 'name', 'params', 'value' |
1382 | 1384 | * @param boolean $delete_via_put |
1383 | - * @return boolean false on error, eg. invalid managed id, for false an xml-error body has been send |
|
1385 | + * @return null|false false on error, eg. invalid managed id, for false an xml-error body has been send |
|
1384 | 1386 | */ |
1385 | 1387 | public static function handle_attach($app, $id, $attach, $delete_via_put=false) |
1386 | 1388 | { |
@@ -1584,7 +1586,7 @@ discard block |
||
1584 | 1586 | * @param string $managed_id |
1585 | 1587 | * @param string $app =null app-name to check against path |
1586 | 1588 | * @param string|int $id =null id to check agains path |
1587 | - * @return string|boolean "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id |
|
1589 | + * @return false|string "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id |
|
1588 | 1590 | */ |
1589 | 1591 | static public function managed_id2path($managed_id, $app=null, $id=null) |
1590 | 1592 | { |
@@ -1783,7 +1785,7 @@ discard block |
||
1783 | 1785 | * MKCOL method handler |
1784 | 1786 | * |
1785 | 1787 | * @param array general parameter passing array |
1786 | - * @return bool true on success |
|
1788 | + * @return string true on success |
|
1787 | 1789 | */ |
1788 | 1790 | function MKCOL($options) |
1789 | 1791 | { |
@@ -1796,7 +1798,7 @@ discard block |
||
1796 | 1798 | * MOVE method handler |
1797 | 1799 | * |
1798 | 1800 | * @param array general parameter passing array |
1799 | - * @return bool true on success |
|
1801 | + * @return string true on success |
|
1800 | 1802 | */ |
1801 | 1803 | function MOVE($options) |
1802 | 1804 | { |
@@ -1809,7 +1811,7 @@ discard block |
||
1809 | 1811 | * COPY method handler |
1810 | 1812 | * |
1811 | 1813 | * @param array general parameter passing array |
1812 | - * @return bool true on success |
|
1814 | + * @return string true on success |
|
1813 | 1815 | */ |
1814 | 1816 | function COPY($options, $del=false) |
1815 | 1817 | { |
@@ -1822,7 +1824,7 @@ discard block |
||
1822 | 1824 | * LOCK method handler |
1823 | 1825 | * |
1824 | 1826 | * @param array general parameter passing array |
1825 | - * @return bool true on success |
|
1827 | + * @return string|boolean true on success |
|
1826 | 1828 | */ |
1827 | 1829 | function LOCK(&$options) |
1828 | 1830 | { |
@@ -1856,7 +1858,7 @@ discard block |
||
1856 | 1858 | * UNLOCK method handler |
1857 | 1859 | * |
1858 | 1860 | * @param array general parameter passing array |
1859 | - * @return bool true on success |
|
1861 | + * @return string true on success |
|
1860 | 1862 | */ |
1861 | 1863 | function UNLOCK(&$options) |
1862 | 1864 | { |
@@ -484,7 +484,6 @@ discard block |
||
484 | 484 | /** |
485 | 485 | * get selectbox options for the customfields |
486 | 486 | * |
487 | - * @param array $field =null |
|
488 | 487 | * @return array with options: |
489 | 488 | */ |
490 | 489 | public static function cf_options() |
@@ -536,7 +535,7 @@ discard block |
||
536 | 535 | * @param string $fileas_type '' or type of $this->fileas_types |
537 | 536 | * @param int $all =false update all contacts or only ones with empty values |
538 | 537 | * @param int &$errors=null on return number of errors |
539 | - * @return int|boolean number of contacts updated, false for wrong fileas type |
|
538 | + * @return string|null number of contacts updated, false for wrong fileas type |
|
540 | 539 | */ |
541 | 540 | function set_all_fileas($fileas_type,$all=false,&$errors=null,$ignore_acl=false) |
542 | 541 | { |
@@ -597,7 +596,7 @@ discard block |
||
597 | 596 | * remove unneeded carriage returns or set empty fields to NULL |
598 | 597 | * |
599 | 598 | * @param int &$errors=null on return number of errors |
600 | - * @return int|boolean number of contacts updated |
|
599 | + * @return string|null number of contacts updated |
|
601 | 600 | */ |
602 | 601 | function set_all_cleanup(&$errors=null,$ignore_acl=false) |
603 | 602 | { |
@@ -1122,7 +1121,7 @@ discard block |
||
1122 | 1121 | * @param mixed $contact contact as array or the contact-id |
1123 | 1122 | * @param boolean $deny_account_delete =false if true never allow to delete accounts |
1124 | 1123 | * @param int $user =null for which user to check, default current user |
1125 | - * @return boolean true permission granted, false for permission denied, null for contact does not exist |
|
1124 | + * @return null|boolean true permission granted, false for permission denied, null for contact does not exist |
|
1126 | 1125 | */ |
1127 | 1126 | function check_perms($needed,$contact,$deny_account_delete=false,$user=null) |
1128 | 1127 | { |
@@ -1179,7 +1178,7 @@ discard block |
||
1179 | 1178 | * @param int $check Acl::READ for read and Acl::EDIT for write or delete access |
1180 | 1179 | * @param string $rel_path =null currently not used in InfoLog |
1181 | 1180 | * @param int $user =null for which user to check, default current user |
1182 | - * @return boolean true if access is granted or false otherwise |
|
1181 | + * @return null|boolean true if access is granted or false otherwise |
|
1183 | 1182 | */ |
1184 | 1183 | function file_access($id,$check,$rel_path=null,$user=null) |
1185 | 1184 | { |
@@ -2094,6 +2093,9 @@ discard block |
||
2094 | 2093 | return $cat_id_list; |
2095 | 2094 | } |
2096 | 2095 | |
2096 | + /** |
|
2097 | + * @param string $cat_id_list |
|
2098 | + */ |
|
2097 | 2099 | function get_categories($cat_id_list) |
2098 | 2100 | { |
2099 | 2101 | if (!is_object($this->categories)) |
@@ -78,6 +78,7 @@ discard block |
||
78 | 78 | * Constructor |
79 | 79 | * |
80 | 80 | * The constructor instanciates the class in $GLOBALS['egw']->framework, from where it should be used |
81 | + * @param string $template |
|
81 | 82 | */ |
82 | 83 | function __construct($template) |
83 | 84 | { |
@@ -564,7 +565,7 @@ discard block |
||
564 | 565 | /** |
565 | 566 | * Returns Html with user and time |
566 | 567 | * |
567 | - * @return void |
|
568 | + * @return string |
|
568 | 569 | */ |
569 | 570 | protected static function _user_time_info() |
570 | 571 | { |
@@ -993,7 +994,6 @@ discard block |
||
993 | 994 | * |
994 | 995 | * Themes are css file in the template directory |
995 | 996 | * |
996 | - * @param string $themes_dir ='css' |
|
997 | 997 | */ |
998 | 998 | function list_themes() |
999 | 999 | { |
@@ -1184,11 +1184,6 @@ discard block |
||
1184 | 1184 | /** |
1185 | 1185 | * Add menu items to the topmenu template class to be displayed |
1186 | 1186 | * |
1187 | - * @param array $app application data |
|
1188 | - * @param mixed $alt_label string with alternative menu item label default value = null |
|
1189 | - * @param string $urlextra string with alternate additional code inside <a>-tag |
|
1190 | - * @access protected |
|
1191 | - * @return void |
|
1192 | 1187 | */ |
1193 | 1188 | abstract function _add_topmenu_item(array $app_data,$alt_label=null); |
1194 | 1189 | |
@@ -1281,7 +1276,6 @@ discard block |
||
1281 | 1276 | * @param string $package package or complete path (relative to EGW_SERVER_ROOT) to be included |
1282 | 1277 | * @param string|array $file =null file to be included - no ".js" on the end or array with get params |
1283 | 1278 | * @param string $app ='phpgwapi' application directory to search - default = phpgwapi |
1284 | - * @param boolean $append =true should the file be added |
|
1285 | 1279 | */ |
1286 | 1280 | static function includeJS($package, $file=null, $app='phpgwapi') |
1287 | 1281 | { |
@@ -1442,7 +1436,7 @@ discard block |
||
1442 | 1436 | * @param string $action "add" or "delete" |
1443 | 1437 | * @param boolean|int|string $group ID of the group to create the favorite for, or 'all' for all users |
1444 | 1438 | * @param array $filters =array() key => value pairs for the filter |
1445 | - * @return boolean Success |
|
1439 | + * @return boolean|null Success |
|
1446 | 1440 | */ |
1447 | 1441 | public static function ajax_set_favorite($app, $name, $action, $group, $filters = array()) |
1448 | 1442 | { |
@@ -1194,7 +1194,7 @@ |
||
1194 | 1194 | * @param string &$wildcard ='' on return wildcard char to use, if pattern does not already contain wildcards! |
1195 | 1195 | * @param string &$op ='AND' on return boolean operation to use, if pattern does not start with ! we use OR else AND |
1196 | 1196 | * @param string $extra_col =null extra column to search |
1197 | - * @param array $search_cols =array() List of columns to search. If not provided, all columns in $this->db_cols will be considered |
|
1197 | + * @param string[] $search_cols =array() List of columns to search. If not provided, all columns in $this->db_cols will be considered |
|
1198 | 1198 | * @return array or column => value pairs |
1199 | 1199 | */ |
1200 | 1200 | public function search2criteria($_pattern,&$wildcard='',&$op='AND',$extra_col=null, $search_cols = array()) |
@@ -632,8 +632,8 @@ discard block |
||
632 | 632 | * or an ExecMethod callback with parameters $id,$event |
633 | 633 | * |
634 | 634 | * @param string $app |
635 | - * @param int|string $id |
|
636 | - * @return string |
|
635 | + * @param string $id |
|
636 | + * @return boolean |
|
637 | 637 | */ |
638 | 638 | static function integration_get_private($app,$id,$event) |
639 | 639 | { |
@@ -762,7 +762,7 @@ discard block |
||
762 | 762 | * This methods operates in usertime, while $this->config['horizont'] is in servertime! |
763 | 763 | * |
764 | 764 | * @param array $event |
765 | - * @param mixed $start =0 minimum start-time for new recurrences or !$start = since the start of the event |
|
765 | + * @param integer $start =0 minimum start-time for new recurrences or !$start = since the start of the event |
|
766 | 766 | */ |
767 | 767 | function set_recurrences($event,$start=0) |
768 | 768 | { |
@@ -982,10 +982,9 @@ discard block |
||
982 | 982 | * Recurrences get calculated by rrule iterator implemented in calendar_rrule class. |
983 | 983 | * |
984 | 984 | * @param array $event repeating event whos repetions should be inserted |
985 | - * @param mixed $start start-date |
|
985 | + * @param mixed $_start start-date |
|
986 | 986 | * @param mixed $end end-date |
987 | 987 | * @param array $events where the repetions get inserted |
988 | - * @param array $recur_exceptions with date (in Ymd) as key (and True as values), seems not to be used anymore |
|
989 | 988 | */ |
990 | 989 | function insert_all_recurrences($event,$_start,$end,&$events) |
991 | 990 | { |
@@ -1139,7 +1138,7 @@ discard block |
||
1139 | 1138 | * even if you have no general read-grant from that user. |
1140 | 1139 | * |
1141 | 1140 | * @param int $needed necessary ACL right: Acl::{READ|EDIT|DELETE} |
1142 | - * @param mixed $event event as array or the event-id or 0 for a general check |
|
1141 | + * @param integer $event event as array or the event-id or 0 for a general check |
|
1143 | 1142 | * @param int $other uid to check (if event==0) or 0 to check against $this->user |
1144 | 1143 | * @param string $date_format ='ts' date-format used for reading: 'ts'=timestamp, 'array'=array, 'string'=iso8601 string for xmlrpc |
1145 | 1144 | * @param mixed $date_to_read =null date used for reading, internal param for the caching |
@@ -1312,8 +1311,6 @@ discard block |
||
1312 | 1311 | * @param string $msg message with parameters/variables like lang(), eg. '%1' |
1313 | 1312 | * @param boolean $backtrace =True include a function-backtrace, default True=On |
1314 | 1313 | * should only be set to False=Off, if your code ensures a call with backtrace=On was made before !!! |
1315 | - * @param mixed $param a variable number of parameters, to be inserted in $msg |
|
1316 | - * arrays get serialized with print_r() ! |
|
1317 | 1314 | */ |
1318 | 1315 | static function debug_message($msg,$backtrace=True) |
1319 | 1316 | { |
@@ -1378,7 +1375,7 @@ discard block |
||
1378 | 1375 | * Formats one or two dates (range) as long date (full monthname), optionaly with a time |
1379 | 1376 | * |
1380 | 1377 | * @param mixed $_first first date |
1381 | - * @param mixed $last =0 last date if != 0 (default) |
|
1378 | + * @param integer $last =0 last date if != 0 (default) |
|
1382 | 1379 | * @param boolean $display_time =false should a time be displayed too |
1383 | 1380 | * @param boolean $display_day =false should a day-name prefix the date, eg. monday June 20, 2006 |
1384 | 1381 | * @return string with formated date |
@@ -1847,7 +1844,6 @@ discard block |
||
1847 | 1844 | * |
1848 | 1845 | * Is called as hook to participate in the linking |
1849 | 1846 | * |
1850 | - * @param int|array $entry int cal_id or array with event |
|
1851 | 1847 | * @param string|boolean string with title, null if not found or false if not read perms |
1852 | 1848 | */ |
1853 | 1849 | function link_title($event) |
@@ -2036,6 +2032,7 @@ discard block |
||
2036 | 2032 | * |
2037 | 2033 | * @param array|int|string $entry array with event or cal_id, or cal_id:recur_date for virtual exceptions |
2038 | 2034 | * @param string &$schedule_tag=null on return schedule-tag (egw_cal.cal_id:egw_cal.cal_etag, no participant modifications!) |
2035 | + * @param string $schedule_tag |
|
2039 | 2036 | * @return string|boolean string with etag or false |
2040 | 2037 | */ |
2041 | 2038 | function get_etag($entry, &$schedule_tag=null) |
@@ -2076,7 +2073,6 @@ discard block |
||
2076 | 2073 | * Hook for infolog to set some extra data and links |
2077 | 2074 | * |
2078 | 2075 | * @param array $data event-array preset by infolog plus |
2079 | - * @param int $data[id] cal_id |
|
2080 | 2076 | * @return array with key => value pairs to set in new event and link_app/link_id arrays |
2081 | 2077 | */ |
2082 | 2078 | function infolog_set($data) |
@@ -2128,7 +2124,6 @@ discard block |
||
2128 | 2124 | * Hook for timesheet to set some extra data and links |
2129 | 2125 | * |
2130 | 2126 | * @param array $data |
2131 | - * @param int $data[id] cal_id:recurrence |
|
2132 | 2127 | * @return array with key => value pairs to set in new timesheet and link_app/link_id arrays |
2133 | 2128 | */ |
2134 | 2129 | function timesheet_set($data) |
@@ -315,7 +315,7 @@ discard block |
||
315 | 315 | * |
316 | 316 | * @param string $path |
317 | 317 | * @param array $filter |
318 | - * @param array|boolean $start =false false=return all or array(start,num) |
|
318 | + * @param integer[] $start =false false=return all or array(start,num) |
|
319 | 319 | * @return array with "files" array with values for keys path and props |
320 | 320 | */ |
321 | 321 | function &propfind_callback($path,array $filter,$start=false) |
@@ -620,7 +620,7 @@ discard block |
||
620 | 620 | * @param array &$options |
621 | 621 | * @param int $id |
622 | 622 | * @param int $user =null account_id |
623 | - * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
623 | + * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
624 | 624 | */ |
625 | 625 | function get(&$options,$id,$user=null) |
626 | 626 | { |
@@ -793,7 +793,7 @@ discard block |
||
793 | 793 | * Check if $user is a participant of given $event incl. group-invitations |
794 | 794 | * |
795 | 795 | * @param array $event |
796 | - * @param int|string $user |
|
796 | + * @param integer $user |
|
797 | 797 | * @return boolean |
798 | 798 | */ |
799 | 799 | public static function isParticipant(array $event, $user) |
@@ -810,7 +810,7 @@ discard block |
||
810 | 810 | * @param int $id |
811 | 811 | * @param int $user =null account_id of owner, default null |
812 | 812 | * @param string $prefix =null user prefix from path (eg. /ralf from /ralf/addressbook) |
813 | - * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
813 | + * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
814 | 814 | */ |
815 | 815 | function put(&$options,$id,$user=null,$prefix=null) |
816 | 816 | { |
@@ -1038,7 +1038,7 @@ discard block |
||
1038 | 1038 | * @param array &$options |
1039 | 1039 | * @param int $id |
1040 | 1040 | * @param int $user =null account_id of owner, default null |
1041 | - * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
1041 | + * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
1042 | 1042 | */ |
1043 | 1043 | function post(&$options,$id,$user=null) |
1044 | 1044 | { |
@@ -1112,7 +1112,7 @@ discard block |
||
1112 | 1112 | * @param string $charset of ical |
1113 | 1113 | * @param int $user account_id of owner |
1114 | 1114 | * @param array &$options |
1115 | - * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
1115 | + * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
1116 | 1116 | */ |
1117 | 1117 | protected function outbox_freebusy_request($ical, $charset, $user, array &$options) |
1118 | 1118 | { |
@@ -1187,7 +1187,7 @@ discard block |
||
1187 | 1187 | * @param string $path |
1188 | 1188 | * @param array $options |
1189 | 1189 | * @param int $user account_id |
1190 | - * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
1190 | + * @return string|null boolean true on success, false on failure or string with http status (eg. '404 Not Found') |
|
1191 | 1191 | */ |
1192 | 1192 | function free_busy_report($path,$options,$user) |
1193 | 1193 | { |
@@ -1416,7 +1416,7 @@ discard block |
||
1416 | 1416 | /** |
1417 | 1417 | * Query ctag for calendar |
1418 | 1418 | * |
1419 | - * @return string |
|
1419 | + * @return integer |
|
1420 | 1420 | */ |
1421 | 1421 | public function getctag($path,$user) |
1422 | 1422 | { |
@@ -1449,7 +1449,7 @@ discard block |
||
1449 | 1449 | * |
1450 | 1450 | * @param int|array $entry id or array of new created entry |
1451 | 1451 | * @param string $path |
1452 | - * @param int|string $retval |
|
1452 | + * @param string|boolean $retval |
|
1453 | 1453 | * @param boolean $path_attr_is_name =true true: path_attr is ca(l|rd)dav_name, false: id (GroupDAV needs Location header) |
1454 | 1454 | */ |
1455 | 1455 | function put_response_headers($entry, $path, $retval, $path_attr_is_name=true) |
@@ -211,23 +211,11 @@ discard block |
||
211 | 211 | * @param int $start startdate of the search/list (servertime) |
212 | 212 | * @param int $end enddate of the search/list (servertime) |
213 | 213 | * @param int|array $users user-id or array of user-id's, !$users means all entries regardless of users |
214 | - * @param int|array $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all |
|
214 | + * @param integer $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all |
|
215 | 215 | * @param string $filter ='default' string filter-name: all (not rejected), accepted, unknown, tentative, rejected or everything (incl. rejected, deleted) |
216 | 216 | * @param int|boolean $offset =False offset for a limited query or False (default) |
217 | 217 | * @param int $num_rows =0 number of rows to return if offset set, default 0 = use default in user prefs |
218 | 218 | * @param array $params =array() |
219 | - * @param string|array $params['query'] string: pattern so search for, if unset or empty all matching entries are returned (no search) |
|
220 | - * Please Note: a search never returns repeating events more then once AND does not honor start+end date !!! |
|
221 | - * array: everything is directly used as $where |
|
222 | - * @param string $params['order'] ='cal_start' column-names plus optional DESC|ASC separted by comma |
|
223 | - * @param string $params['sql_filter'] sql to be and'ed into query (fully quoted) |
|
224 | - * @param string|array $params['cols'] what to select, default "$this->repeats_table.*,$this->cal_table.*,cal_start,cal_end,cal_recur_date", |
|
225 | - * if specified and not false an iterator for the rows is returned |
|
226 | - * @param string $params['append'] SQL to append to the query before $order, eg. for a GROUP BY clause |
|
227 | - * @param array $params['cfs'] custom fields to query, null = none, array() = all, or array with cfs names |
|
228 | - * @param array $params['users'] raw parameter as passed to calendar_bo::search() no memberships resolved! |
|
229 | - * @param boolean $params['master_only'] =false, true only take into account participants/status from master (for AS) |
|
230 | - * @param boolean $params['enum_recuring'] =true enumerate recuring events |
|
231 | 219 | * @param int $remove_rejected_by_user =null add join to remove entry, if given user has rejected it |
232 | 220 | * @return array of events |
233 | 221 | */ |
@@ -594,7 +582,7 @@ discard block |
||
594 | 582 | /** |
595 | 583 | * generate SQL to filter after a given category (incl. subcategories) |
596 | 584 | * |
597 | - * @param array|int $cat_id cat-id or array of cat-ids, or !$cat_id for none |
|
585 | + * @param integer $cat_id cat-id or array of cat-ids, or !$cat_id for none |
|
598 | 586 | * @return string SQL to include in the query |
599 | 587 | */ |
600 | 588 | function cat_filter($cat_id) |
@@ -682,24 +670,11 @@ discard block |
||
682 | 670 | * @param int $start startdate of the search/list (servertime) |
683 | 671 | * @param int $end enddate of the search/list (servertime) |
684 | 672 | * @param int|array $users user-id or array of user-id's, !$users means all entries regardless of users |
685 | - * @param int|array $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all |
|
673 | + * @param integer $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all |
|
686 | 674 | * @param string $filter ='all' string filter-name: all (not rejected), accepted, unknown, tentative, rejected or everything (incl. rejected, deleted) |
687 | 675 | * @param int|boolean $offset =False offset for a limited query or False (default) |
688 | 676 | * @param int $num_rows =0 number of rows to return if offset set, default 0 = use default in user prefs |
689 | 677 | * @param array $params =array() |
690 | - * @param string|array $params['query'] string: pattern so search for, if unset or empty all matching entries are returned (no search) |
|
691 | - * Please Note: a search never returns repeating events more then once AND does not honor start+end date !!! |
|
692 | - * array: everything is directly used as $where |
|
693 | - * @param string $params['order'] ='cal_start' column-names plus optional DESC|ASC separted by comma |
|
694 | - * @param string|array $params['sql_filter'] sql to be and'ed into query (fully quoted), or usual filter array |
|
695 | - * @param string|array $params['cols'] what to select, default "$this->repeats_table.*,$this->cal_table.*,cal_start,cal_end,cal_recur_date", |
|
696 | - * if specified and not false an iterator for the rows is returned |
|
697 | - * @param string $params['append'] SQL to append to the query before $order, eg. for a GROUP BY clause |
|
698 | - * @param array $params['cfs'] custom fields to query, null = none, array() = all, or array with cfs names |
|
699 | - * @param array $params['users'] raw parameter as passed to calendar_bo::search() no memberships resolved! |
|
700 | - * @param boolean $params['master_only'] =false, true only take into account participants/status from master (for AS) |
|
701 | - * @param boolean $params['enum_recuring'] =true enumerate recuring events |
|
702 | - * @param boolean $params['use_so_events'] =false, true return result of new $this->events() |
|
703 | 678 | * @param int $remove_rejected_by_user =null add join to remove entry, if given user has rejected it |
704 | 679 | * @return Iterator|array of events |
705 | 680 | */ |
@@ -1140,11 +1115,11 @@ discard block |
||
1140 | 1115 | * Ask other apps if they want to participate in calendar search / display |
1141 | 1116 | * |
1142 | 1117 | * @param &$selects parts of union query |
1143 | - * @param $start see search() |
|
1144 | - * @param $end |
|
1118 | + * @param integer $start see search() |
|
1119 | + * @param integer $end |
|
1145 | 1120 | * @param $users as used in calendar_so ($users_raw plus all members and memberships added by calendar_bo) |
1146 | - * @param $cat_id |
|
1147 | - * @param $filter |
|
1121 | + * @param integer $cat_id |
|
1122 | + * @param string $filter |
|
1148 | 1123 | * @param $query |
1149 | 1124 | * @param $users_raw as passed to calendar_bo::search (no members and memberships added) |
1150 | 1125 | */ |
@@ -1312,6 +1287,7 @@ discard block |
||
1312 | 1287 | * @param int &$set_recurrences_start=0 on return: time from which on the recurrences should be rebuilt, default 0=all |
1313 | 1288 | * @param int $change_since =0 time from which on the repetitions should be changed, default 0=all |
1314 | 1289 | * @param int &$etag etag=null etag to check or null, on return new etag |
1290 | + * @param boolean $set_recurrences |
|
1315 | 1291 | * @return boolean|int false on error, 0 if etag does not match, cal_id otherwise |
1316 | 1292 | */ |
1317 | 1293 | function save($event,&$set_recurrences,&$set_recurrences_start=0,$change_since=0,&$etag=null) |
@@ -1722,7 +1698,7 @@ discard block |
||
1722 | 1698 | * @param int $cal_id |
1723 | 1699 | * @param int $start new starttime |
1724 | 1700 | * @param int $end new endtime |
1725 | - * @param int|boolean $change_since =0 false=new entry, > 0 time from which on the repetitions should be changed, default 0=all |
|
1701 | + * @param integer $change_since =0 false=new entry, > 0 time from which on the repetitions should be changed, default 0=all |
|
1726 | 1702 | * @param int $old_start =0 old starttime or (default) 0, to query it from the db |
1727 | 1703 | * @param int $old_end =0 old starttime or (default) 0 |
1728 | 1704 | * @todo Recalculate recurrences, if timezone changes |
@@ -1899,7 +1875,7 @@ discard block |
||
1899 | 1875 | * |
1900 | 1876 | * @param int $cal_id |
1901 | 1877 | * @param array $participants uid => status pairs |
1902 | - * @param int|boolean $change_since =0, false=new event, |
|
1878 | + * @param integer $change_since =0, false=new event, |
|
1903 | 1879 | * 0=all, > 0 time from which on the repetitions should be changed |
1904 | 1880 | * @param boolean $add_only =false |
1905 | 1881 | * false = add AND delete participants if needed (full list of participants required in $participants) |
@@ -2045,7 +2021,7 @@ discard block |
||
2045 | 2021 | * set the status of one participant for a given recurrence or for all recurrences since now (includes recur_date=0) |
2046 | 2022 | * |
2047 | 2023 | * @param int $cal_id |
2048 | - * @param char $user_type 'u' regular user, 'r' resource, 'c' contact |
|
2024 | + * @param string $user_type 'u' regular user, 'r' resource, 'c' contact |
|
2049 | 2025 | * @param int|string $user_id |
2050 | 2026 | * @param int|char $status numeric status (defines) or 1-char code: 'R', 'U', 'T' or 'A' |
2051 | 2027 | * @param int $recur_date =0 date to change, or 0 = all since now |
@@ -2962,7 +2938,7 @@ discard block |
||
2962 | 2938 | * Updates the modification timestamp to force an etag, ctag and sync-token change |
2963 | 2939 | * |
2964 | 2940 | * @param int $id event id |
2965 | - * @param int|boolean $update_master =false id of series master or true, to update series master too |
|
2941 | + * @param boolean $update_master =false id of series master or true, to update series master too |
|
2966 | 2942 | * @param int $time =null new timestamp, default current (server-)time |
2967 | 2943 | * @param int $modifier =null uid of the modifier, default current user |
2968 | 2944 | */ |
@@ -282,7 +282,7 @@ discard block |
||
282 | 282 | * @param int $truncsize |
283 | 283 | * @param int $bodypreference |
284 | 284 | * @param $optionbodypreference |
285 | - * @param bool $mimesupport |
|
285 | + * @param integer $mimesupport |
|
286 | 286 | * @return SyncMail |
287 | 287 | */ |
288 | 288 | function GetMeetingRequest($id, $truncsize, $bodypreference=false, $optionbodypreference=false, $mimesupport = 0) |
@@ -900,7 +900,7 @@ discard block |
||
900 | 900 | * @param string $id of the folder to delete |
901 | 901 | * |
902 | 902 | * @return |
903 | - * @TODO check what is to be returned |
|
903 | + boolean @TODO check what is to be returned |
|
904 | 904 | */ |
905 | 905 | public function DeleteFolder($parentid, $id) |
906 | 906 | { |
@@ -1596,6 +1596,7 @@ discard block |
||
1596 | 1596 | * Unpack timezone info from Sync |
1597 | 1597 | * |
1598 | 1598 | * copied from backend/ics.php |
1599 | + * @param string $data |
|
1599 | 1600 | */ |
1600 | 1601 | static public function _getTZFromSyncBlob($data) |
1601 | 1602 | { |
@@ -174,7 +174,7 @@ discard block |
||
174 | 174 | * dir working on just the eGW VFS: returns directory object |
175 | 175 | * |
176 | 176 | * @param string $path filename with absolute path in the eGW VFS |
177 | - * @return Directory |
|
177 | + * @return \Directory |
|
178 | 178 | */ |
179 | 179 | static function dir($path) |
180 | 180 | { |
@@ -1326,7 +1326,7 @@ discard block |
||
1326 | 1326 | * Also works around PHP under Windows returning dirname('/something') === '\\', which is NOT understood by EGroupware's VFS! |
1327 | 1327 | * |
1328 | 1328 | * @param string $_url path or url |
1329 | - * @return string|boolean parent or false if there's none ($path == '/') |
|
1329 | + * @return false|string parent or false if there's none ($path == '/') |
|
1330 | 1330 | */ |
1331 | 1331 | static function dirname($_url) |
1332 | 1332 | { |
@@ -1753,7 +1753,7 @@ discard block |
||
1753 | 1753 | * checkLock() helper |
1754 | 1754 | * |
1755 | 1755 | * @param string resource path to check for locks |
1756 | - * @return array|boolean false if there's no lock, else array with lock info |
|
1756 | + * @return string|null false if there's no lock, else array with lock info |
|
1757 | 1757 | */ |
1758 | 1758 | static function checkLock($path) |
1759 | 1759 | { |
@@ -1969,7 +1969,7 @@ discard block |
||
1969 | 1969 | /** |
1970 | 1970 | * Copies the files given in $src to $dst. |
1971 | 1971 | * |
1972 | - * @param array $src contains the source file |
|
1972 | + * @param string[] $src contains the source file |
|
1973 | 1973 | * @param string $dst is the destination directory |
1974 | 1974 | * @param int& $errs =null on return number of errors happened |
1975 | 1975 | * @param array& $copied =null on return files copied |
@@ -2221,7 +2221,6 @@ discard block |
||
2221 | 2221 | * In order for the appropriate error message to be returned, do not define this method if your wrapper does not support removing directories. |
2222 | 2222 | * |
2223 | 2223 | * @param string $path |
2224 | - * @param int $options Possible values include STREAM_REPORT_ERRORS. |
|
2225 | 2224 | * @return boolean TRUE on success or FALSE on failure. |
2226 | 2225 | */ |
2227 | 2226 | static function rmdir($path) |
@@ -2347,7 +2346,7 @@ discard block |
||
2347 | 2346 | * Requires root rights! |
2348 | 2347 | * |
2349 | 2348 | * @param string $path |
2350 | - * @param int|string $owner numeric user id or account-name |
|
2349 | + * @param integer $owner numeric user id or account-name |
|
2351 | 2350 | * @return boolean true on success, false otherwise |
2352 | 2351 | */ |
2353 | 2352 | static function chown($path,$owner) |