@@ -28,9 +28,6 @@ |
||
28 | 28 | /** |
29 | 29 | * Constructor |
30 | 30 | * |
31 | - * @param boolean $data=true true: send only the remote_hash, domain and webserver_url, |
|
32 | - * false: the complete header vars, plus install_id and webserver_url from the config table, |
|
33 | - * null: only the header vars |
|
34 | 31 | */ |
35 | 32 | function __construct($data=true,$header_admin_user=null,$header_admin_password=null) |
36 | 33 | { |
@@ -252,7 +252,7 @@ |
||
252 | 252 | /** |
253 | 253 | * Check if header exists and is up to date |
254 | 254 | * |
255 | - * @return int 1=no header.inc.php, 2=no header admin pw, 3=no instances, 4=need upgrade, 10=ok |
|
255 | + * @return string 1=no header.inc.php, 2=no header admin pw, 3=no instances, 4=need upgrade, 10=ok |
|
256 | 256 | */ |
257 | 257 | function check_header() |
258 | 258 | { |
@@ -53,10 +53,7 @@ |
||
53 | 53 | * the mother of all multipass upgrade parental loop functions |
54 | 54 | * |
55 | 55 | * @param array $setup_info array of application info from setup.inc.php files |
56 | - * @param string $type='new' defaults to new(install), could also be 'upgrade' |
|
57 | - * @param boolean $DEBUG=false print debugging info |
|
58 | - * @param boolean $force_en=false install english language files, not used anymore |
|
59 | - * @param string $system_charset=null charset to use |
|
56 | + * @param boolean $force_en install english language files, not used anymore |
|
60 | 57 | * @param array $preset_config=array() |
61 | 58 | */ |
62 | 59 | function pass(array $setup_info,$method='new',$DEBUG=False,$force_en=False,$preset_config=array()) |
@@ -261,7 +261,7 @@ discard block |
||
261 | 261 | * |
262 | 262 | * @param statuses List of statuses to process, with sub-statuses in a 'substatus' array |
263 | 263 | * @param labels Array of labels, pass array() and labels will be built in it |
264 | - * @param depth Current depth |
|
264 | + * @param depth integer depth |
|
265 | 265 | * |
266 | 266 | * @return None, labels are built in labels parameter |
267 | 267 | */ |
@@ -305,7 +305,7 @@ discard block |
||
305 | 305 | * |
306 | 306 | * @param array|int $data =null use $this->data or $this->data['ts_id'] (to fetch the data) |
307 | 307 | * @param int $user =null for which user to check, default current user |
308 | - * @return boolean true if the rights are ok, false if no rights |
|
308 | + * @return null|boolean true if the rights are ok, false if no rights |
|
309 | 309 | */ |
310 | 310 | function check_statusForEditRights($data=null,$user=null) |
311 | 311 | { |
@@ -340,7 +340,7 @@ discard block |
||
340 | 340 | * @param int $required Acl::READ, EGW_ACL_WRITE, Acl::ADD, Acl::DELETE, EGW_ACL_BUDGET, EGW_ACL_EDIT_BUDGET |
341 | 341 | * @param array|int $data =null project or project-id to use, default the project in $this->data |
342 | 342 | * @param int $user =null for which user to check, default current user |
343 | - * @return boolean true if the rights are ok, null if not found, false if no rights |
|
343 | + * @return null|boolean true if the rights are ok, null if not found, false if no rights |
|
344 | 344 | */ |
345 | 345 | function check_acl($required,$data=null,$user=null) |
346 | 346 | { |
@@ -397,11 +397,11 @@ discard block |
||
397 | 397 | * @param array|string $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!) |
398 | 398 | * @param boolean|string $only_keys =true True returns only keys, False returns all cols. comma seperated list of keys to return |
399 | 399 | * @param string $order_by ='' fieldnames + {ASC|DESC} separated by colons ',', can also contain a GROUP BY (if it contains ORDER BY) |
400 | - * @param string|array $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num" |
|
400 | + * @param string $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num" |
|
401 | 401 | * @param string $wildcard ='' appended befor and after each criteria |
402 | 402 | * @param boolean $empty =false False=empty criteria are ignored in query, True=empty have to be empty in row |
403 | 403 | * @param string $op ='AND' defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together |
404 | - * @param mixed $start =false if != false, return only maxmatch rows begining with start, or array($start,$num) |
|
404 | + * @param boolean $start =false if != false, return only maxmatch rows begining with start, or array($start,$num) |
|
405 | 405 | * @param array $filter =null if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards |
406 | 406 | * @param string $join ='' sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or |
407 | 407 | * "LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join! |
@@ -658,8 +658,6 @@ discard block |
||
658 | 658 | * delete / move all timesheets of a given user |
659 | 659 | * |
660 | 660 | * @param array $data |
661 | - * @param int $data['account_id'] owner to change |
|
662 | - * @param int $data['new_owner'] new owner or 0 for delete |
|
663 | 661 | */ |
664 | 662 | function deleteaccount($data) |
665 | 663 | { |
@@ -686,7 +684,7 @@ discard block |
||
686 | 684 | * |
687 | 685 | * @param array $keys =null if given array with col => value pairs to characterise single timesheet or null for $this->data |
688 | 686 | * @param int $status =0 |
689 | - * @return int affected rows, should be 1 if ok, 0 if an error |
|
687 | + * @return boolean affected rows, should be 1 if ok, 0 if an error |
|
690 | 688 | */ |
691 | 689 | function set_status($keys=null, $status=0) |
692 | 690 | { |
@@ -816,7 +814,7 @@ discard block |
||
816 | 814 | * @param int $check Acl::READ for read and Acl::EDIT for write or delete access |
817 | 815 | * @param string $rel_path =null currently not used in InfoLog |
818 | 816 | * @param int $user =null for which user to check, default current user |
819 | - * @return boolean true if access is granted or false otherwise |
|
817 | + * @return null|boolean true if access is granted or false otherwise |
|
820 | 818 | */ |
821 | 819 | function file_access($id,$check,$rel_path=null,$user=null) |
822 | 820 | { |
@@ -42,7 +42,7 @@ |
||
42 | 42 | * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont' |
43 | 43 | * @param array $content |
44 | 44 | * @param array &$validated=array() validated content |
45 | - * @return boolean true if no validation error, false otherwise |
|
45 | + * @return boolean|null true if no validation error, false otherwise |
|
46 | 46 | */ |
47 | 47 | public function validate($cname, array $expand, array $content, &$validated=array()) |
48 | 48 | { |
@@ -42,7 +42,7 @@ |
||
42 | 42 | * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont' |
43 | 43 | * @param array $content |
44 | 44 | * @param array &$validated=array() validated content |
45 | - * @return boolean true if no validation error, false otherwise |
|
45 | + * @return boolean|null true if no validation error, false otherwise |
|
46 | 46 | */ |
47 | 47 | public function validate($cname, array $expand, array $content, &$validated=array()) |
48 | 48 | { |
@@ -42,7 +42,7 @@ |
||
42 | 42 | * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont' |
43 | 43 | * @param array $content |
44 | 44 | * @param array &$validated=array() validated content |
45 | - * @return boolean true if no validation error, false otherwise |
|
45 | + * @return boolean|null true if no validation error, false otherwise |
|
46 | 46 | */ |
47 | 47 | public function validate($cname, array $expand, array $content, &$validated=array()) |
48 | 48 | { |
@@ -81,7 +81,7 @@ |
||
81 | 81 | * |
82 | 82 | * @param string $key Cache key to expire. |
83 | 83 | * |
84 | - * @return boolean Success or failure. |
|
84 | + * @return boolean|null Success or failure. |
|
85 | 85 | */ |
86 | 86 | public function expire($key) |
87 | 87 | { |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | * @param string $parent name of tempalte containing $handle |
157 | 157 | * @param string $handle name of part |
158 | 158 | * @param string $name name of variable/placeholder |
159 | - * @return boolean |
|
159 | + * @return false|null |
|
160 | 160 | */ |
161 | 161 | function set_block($parent, $handle, $name = '') |
162 | 162 | { |
@@ -311,6 +311,8 @@ discard block |
||
311 | 311 | |
312 | 312 | /** |
313 | 313 | * This is short for finish parse |
314 | + * @param string $target |
|
315 | + * @param string $handle |
|
314 | 316 | */ |
315 | 317 | function fp($target, $handle, $append = False) |
316 | 318 | { |
@@ -319,6 +321,8 @@ discard block |
||
319 | 321 | |
320 | 322 | /** |
321 | 323 | * This is a short cut for print finish parse |
324 | + * @param string $target |
|
325 | + * @param string $handle |
|
322 | 326 | */ |
323 | 327 | function pfp($target, $handle, $append = False) |
324 | 328 | { |
@@ -365,6 +369,7 @@ discard block |
||
365 | 369 | * Return undefined variables/placeholders of a handle |
366 | 370 | * |
367 | 371 | * @param string handle handle of a template |
372 | + * @param string $handle |
|
368 | 373 | * @return array|boolean array with undefined variables as key and value, or false if none |
369 | 374 | */ |
370 | 375 | function get_undefined($handle) |