@@ -291,7 +291,7 @@ |
||
| 291 | 291 | * Check if next submission is due, in which case we call submit and NOT return to the admin hook |
| 292 | 292 | * |
| 293 | 293 | * @param boolean $redirect should we redirect or return true |
| 294 | - * @return boolean true if statistic submission is due |
|
| 294 | + * @return boolean|null true if statistic submission is due |
|
| 295 | 295 | */ |
| 296 | 296 | public static function check($redirect=true) |
| 297 | 297 | { |
@@ -491,6 +491,10 @@ |
||
| 491 | 491 | protected static function call_hook() |
| 492 | 492 | { |
| 493 | 493 | self::$hook_data = array(); |
| 494 | + |
|
| 495 | + /** |
|
| 496 | + * @param string $appname |
|
| 497 | + */ |
|
| 494 | 498 | function display_section($appname,$file,$file2=False) |
| 495 | 499 | { |
| 496 | 500 | admin_ui::$hook_data[$appname] = $file2 ? $file2 : $file; |
@@ -548,7 +548,7 @@ |
||
| 548 | 548 | * Validate and create a new content type |
| 549 | 549 | * |
| 550 | 550 | * @param array $content |
| 551 | - * @return string|boolean New type ID, or false for error |
|
| 551 | + * @return false|string New type ID, or false for error |
|
| 552 | 552 | */ |
| 553 | 553 | function create_content_type(&$content) |
| 554 | 554 | { |
@@ -360,7 +360,7 @@ discard block |
||
| 360 | 360 | * All key of the returned array use the 'account_' prefix. |
| 361 | 361 | * For backward compatibility some values are additionaly availible without the prefix, using them is depricated! |
| 362 | 362 | * |
| 363 | - * @param int|string $id numeric account_id or string with account_lid (use of default value of 0 is depricated!!!) |
|
| 363 | + * @param integer $id numeric account_id or string with account_lid (use of default value of 0 is depricated!!!) |
|
| 364 | 364 | * @param boolean $set_depricated_names =false set _additionaly_ the depricated keys without 'account_' prefix |
| 365 | 365 | * @return array/boolean array with account data (keys: account_id, account_lid, ...) or false if account not found |
| 366 | 366 | */ |
@@ -400,7 +400,7 @@ discard block |
||
| 400 | 400 | * - 'account_firstname','account_lastname','account_email','account_fullname','account_phone' |
| 401 | 401 | * |
| 402 | 402 | * @param int|string $id |
| 403 | - * @return string|boolean json or false if not found |
|
| 403 | + * @return string json or false if not found |
|
| 404 | 404 | */ |
| 405 | 405 | function json($id) |
| 406 | 406 | { |
@@ -791,7 +791,7 @@ discard block |
||
| 791 | 791 | * Not all existing accounts are visible because off account_selection preference: 'none' or 'groupmembers' |
| 792 | 792 | * |
| 793 | 793 | * @param int|string $account_id nummeric account_id or account_lid |
| 794 | - * @return boolean true = account is visible, false = account not visible, null = account does not exist |
|
| 794 | + * @return null|boolean true = account is visible, false = account not visible, null = account does not exist |
|
| 795 | 795 | */ |
| 796 | 796 | function visible($account_id) |
| 797 | 797 | { |
@@ -986,7 +986,6 @@ discard block |
||
| 986 | 986 | * |
| 987 | 987 | * @param string $account_lid |
| 988 | 988 | * @param string $passwd |
| 989 | - * @param array $GLOBALS['auto_create_acct'] values for 'firstname', 'lastname', 'email' and 'primary_group' |
|
| 990 | 989 | * @return int|boolean account_id or false on error |
| 991 | 990 | */ |
| 992 | 991 | function auto_add($account_lid, $passwd) |
@@ -1106,7 +1105,7 @@ discard block |
||
| 1106 | 1105 | * |
| 1107 | 1106 | * We use now an instance-wide read-cache storing account-data and members(hips). |
| 1108 | 1107 | * |
| 1109 | - * @param int|array $account_ids user- or group-id(s) for which cache should be invalidated, default 0 = only search/name2id cache |
|
| 1108 | + * @param integer $account_ids user- or group-id(s) for which cache should be invalidated, default 0 = only search/name2id cache |
|
| 1110 | 1109 | */ |
| 1111 | 1110 | static function cache_invalidate($account_ids=0) |
| 1112 | 1111 | { |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | /** |
| 130 | 130 | * Factory method and singelton to get adLDAP object for given configuration or default server config |
| 131 | 131 | * |
| 132 | - * @param array $config=null values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection' |
|
| 132 | + * @param array $config values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection' |
|
| 133 | 133 | * @return adLDAP |
| 134 | 134 | * @throws adLDAPException |
| 135 | 135 | */ |
@@ -1138,7 +1138,7 @@ discard block |
||
| 1138 | 1138 | * |
| 1139 | 1139 | * @param int $_account_id |
| 1140 | 1140 | * @param string $ip |
| 1141 | - * @return int lastlogin time |
|
| 1141 | + * @return boolean lastlogin time |
|
| 1142 | 1142 | */ |
| 1143 | 1143 | function update_lastlogin($_account_id, $ip) |
| 1144 | 1144 | { |
@@ -1335,7 +1335,7 @@ discard block |
||
| 1335 | 1335 | * - activate user |
| 1336 | 1336 | * |
| 1337 | 1337 | * @param array $attributes The attributes to set to the user account |
| 1338 | - * @return bool |
|
| 1338 | + * @return string|boolean |
|
| 1339 | 1339 | */ |
| 1340 | 1340 | public function create($attributes) |
| 1341 | 1341 | { |
@@ -1525,7 +1525,7 @@ discard block |
||
| 1525 | 1525 | * @param string $username The username to query |
| 1526 | 1526 | * @param array $attributes The attributes to modify. Note if you set the enabled attribute you must not specify any other attributes |
| 1527 | 1527 | * @param bool $isGUID Is the username passed a GUID or a samAccountName |
| 1528 | - * @return bool |
|
| 1528 | + * @return string|boolean |
|
| 1529 | 1529 | */ |
| 1530 | 1530 | public function modify($username, $attributes, $isGUID = false) |
| 1531 | 1531 | { |
@@ -1590,7 +1590,7 @@ discard block |
||
| 1590 | 1590 | * Extended to allow to specify $attribute["container"] as string, because array hardcodes "OU=", while Samba4 and win2008r2 uses "CN=Users" |
| 1591 | 1591 | * |
| 1592 | 1592 | * @param array $attributes Default attributes of the group |
| 1593 | - * @return bool |
|
| 1593 | + * @return string|boolean |
|
| 1594 | 1594 | */ |
| 1595 | 1595 | public function create($attributes) |
| 1596 | 1596 | { |
@@ -190,7 +190,7 @@ discard block |
||
| 190 | 190 | * If no account_id is set in data the account is added and the new id is set in $data. |
| 191 | 191 | * |
| 192 | 192 | * @param array $data array with account-data |
| 193 | - * @return int|boolean the account_id or false on error |
|
| 193 | + * @return false|string the account_id or false on error |
|
| 194 | 194 | */ |
| 195 | 195 | function save(&$data) |
| 196 | 196 | { |
@@ -995,7 +995,7 @@ discard block |
||
| 995 | 995 | * |
| 996 | 996 | * @param int $_account_id |
| 997 | 997 | * @param string $ip |
| 998 | - * @return int lastlogin time |
|
| 998 | + * @return boolean lastlogin time |
|
| 999 | 999 | */ |
| 1000 | 1000 | function update_lastlogin($_account_id, $ip) |
| 1001 | 1001 | { |
@@ -1097,7 +1097,6 @@ discard block |
||
| 1097 | 1097 | * @param int $gid gidnumber of group to set |
| 1098 | 1098 | * @param array $objectclass =null should we set the member and uniqueMember attributes (groupOf(Unique)Names|univentionGroup) (default detect it) |
| 1099 | 1099 | * @param string $use_cn =null if set $cn is used instead $gid and the attributes are returned, not written to ldap |
| 1100 | - * @param boolean $uniqueMember =null should we set the uniqueMember attribute (default detect it) |
|
| 1101 | 1100 | * @return boolean/array false on failure, array or true otherwise |
| 1102 | 1101 | */ |
| 1103 | 1102 | function set_members($members, $gid, array $objectclass=null, $use_cn=null) |
@@ -47,7 +47,7 @@ |
||
| 47 | 47 | * If no account_id is set in data the account is added and the new id is set in $data. |
| 48 | 48 | * |
| 49 | 49 | * @param array $data array with account-data |
| 50 | - * @return int|boolean the account_id or false on error |
|
| 50 | + * @return false|string the account_id or false on error |
|
| 51 | 51 | */ |
| 52 | 52 | function save(&$data) |
| 53 | 53 | { |
@@ -166,7 +166,7 @@ discard block |
||
| 166 | 166 | * Delete ACL record in the repository of the class |
| 167 | 167 | * |
| 168 | 168 | * @param string $appname appname or '' for $GLOBALS['egw_info']['flags']['currentapp'] |
| 169 | - * @param string/boolean $location location or false for all locations |
|
| 169 | + * @param boolean $location location or false for all locations |
|
| 170 | 170 | * @return array all ACL records from $this->data. |
| 171 | 171 | */ |
| 172 | 172 | function delete($appname,$location) |
@@ -267,8 +267,8 @@ discard block |
||
| 267 | 267 | /** |
| 268 | 268 | * check required rights agains the internal repository (included rights of $this->account_id and all it's memberships) |
| 269 | 269 | * |
| 270 | - * @param $location app location |
|
| 271 | - * @param $required required right to check against |
|
| 270 | + * @param string $location app location |
|
| 271 | + * @param integer $required required right to check against |
|
| 272 | 272 | * @param $appname optional defaults to currentapp |
| 273 | 273 | * @return boolean |
| 274 | 274 | */ |
@@ -324,7 +324,7 @@ discard block |
||
| 324 | 324 | * cancels a timer |
| 325 | 325 | * |
| 326 | 326 | * @param string $id has to be the one used to set it. |
| 327 | - * @return boolean True if the timer exists and is not expired. |
|
| 327 | + * @return integer True if the timer exists and is not expired. |
|
| 328 | 328 | */ |
| 329 | 329 | function cancel_timer($id) |
| 330 | 330 | { |
@@ -470,7 +470,7 @@ discard block |
||
| 470 | 470 | /** |
| 471 | 471 | * reads all matching db-rows / jobs |
| 472 | 472 | * |
| 473 | - * @param string $id =0 reads all expired rows / jobs ready to run\ |
|
| 473 | + * @param integer $id =0 reads all expired rows / jobs ready to run\ |
|
| 474 | 474 | * != 0 reads all rows/jobs matching $id (sql-wildcards '%' and '_' can be used) |
| 475 | 475 | * @param array|string $cols ='*' string or array of column-names / select-expressions |
| 476 | 476 | * @param int|bool $offset =False offset for a limited query or False (default) |
@@ -558,7 +558,7 @@ discard block |
||
| 558 | 558 | /** |
| 559 | 559 | * delete db-row / job with $id |
| 560 | 560 | * |
| 561 | - * @return boolean False if $id not found else True |
|
| 561 | + * @return integer False if $id not found else True |
|
| 562 | 562 | */ |
| 563 | 563 | function delete($id) |
| 564 | 564 | { |