@@ -27,7 +27,7 @@ |
||
27 | 27 | /** |
28 | 28 | * Exports records as defined in $_definition |
29 | 29 | * |
30 | - * @param egw_record $_definition |
|
30 | + * @param importexport_definition $_definition |
|
31 | 31 | */ |
32 | 32 | public function export( $_stream, importexport_definition $_definition) { |
33 | 33 | $options = $_definition->plugin_options; |
@@ -101,8 +101,7 @@ |
||
101 | 101 | /** |
102 | 102 | * imports entries according to given definition object. |
103 | 103 | * @param resource $_stream |
104 | - * @param string $_charset |
|
105 | - * @param definition $_definition |
|
104 | + * @param importexport_definition $_definition |
|
106 | 105 | */ |
107 | 106 | public function import( $_stream, importexport_definition $_definition ) { |
108 | 107 |
@@ -27,7 +27,7 @@ |
||
27 | 27 | /** |
28 | 28 | * Exports records as defined in $_definition |
29 | 29 | * |
30 | - * @param egw_record $_definition |
|
30 | + * @param importexport_definition $_definition |
|
31 | 31 | */ |
32 | 32 | public function export( $_stream, importexport_definition $_definition) { |
33 | 33 | $options = $_definition->plugin_options; |
@@ -19,7 +19,7 @@ discard block |
||
19 | 19 | /** |
20 | 20 | * Exports records as defined in $_definition |
21 | 21 | * |
22 | - * @param egw_record $_definition |
|
22 | + * @param importexport_definition $_definition |
|
23 | 23 | */ |
24 | 24 | public function export( $_stream, importexport_definition $_definition) { |
25 | 25 | $options = $_definition->plugin_options; |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | * return html for options. |
89 | 89 | * this way the plugin has all opportunities for options tab |
90 | 90 | * |
91 | - * @return string html |
|
91 | + * @return boolean html |
|
92 | 92 | */ |
93 | 93 | public function get_options_etpl() { |
94 | 94 | return false; |
@@ -92,8 +92,6 @@ |
||
92 | 92 | * Here we need to handle any incoming data. Setup is done in the constructor, |
93 | 93 | * output is handled by parent. |
94 | 94 | * |
95 | - * @param type $id |
|
96 | - * @param Etemplate $etemplate |
|
97 | 95 | */ |
98 | 96 | public static function process($content = array()) |
99 | 97 | { |
@@ -104,8 +104,7 @@ |
||
104 | 104 | /** |
105 | 105 | * imports entries according to given definition object. |
106 | 106 | * @param resource $_stream |
107 | - * @param string $_charset |
|
108 | - * @param definition $_definition |
|
107 | + * @param importexport_definition $_definition |
|
109 | 108 | */ |
110 | 109 | public function import( $_stream, importexport_definition $_definition ) |
111 | 110 | { |
@@ -273,7 +273,7 @@ |
||
273 | 273 | * @param int &$success number of succeded actions |
274 | 274 | * @param int &$failed number of failed actions (not enought permissions) |
275 | 275 | * @param string &$action_msg translated verb for the actions, to be used in a message like %1 timesheets 'deleted' |
276 | - * @param string/array $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup |
|
276 | + * @param string $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup |
|
277 | 277 | * @return boolean true if all actions succeded, false otherwise |
278 | 278 | */ |
279 | 279 | function action($action,$checked,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg) |
@@ -28,7 +28,7 @@ |
||
28 | 28 | * Create a session or if the user has no account return authenticate header and 401 Unauthorized |
29 | 29 | * |
30 | 30 | * @param array &$account |
31 | - * @return int session-id |
|
31 | + * @return string session-id |
|
32 | 32 | */ |
33 | 33 | function check_access(&$account) |
34 | 34 | { |
@@ -436,7 +436,7 @@ discard block |
||
436 | 436 | * forceEAProfileLoad |
437 | 437 | * used to force the load of a specific emailadmin profile; we assume administrative use only (as of now) |
438 | 438 | * @param int $_profile_id |
439 | - * @return object instance of Mail (by reference) |
|
439 | + * @return Mail instance of Mail (by reference) |
|
440 | 440 | */ |
441 | 441 | public static function &forceEAProfileLoad($_profile_id) |
442 | 442 | { |
@@ -711,7 +711,7 @@ discard block |
||
711 | 711 | /** |
712 | 712 | * Get all identities of given mailaccount |
713 | 713 | * |
714 | - * @param int|Mail\Account $account account-object or acc_id |
|
714 | + * @param integer $account account-object or acc_id |
|
715 | 715 | * @return array - array(email=>realname) |
716 | 716 | */ |
717 | 717 | function getAccountIdentities($account) |
@@ -1339,7 +1339,7 @@ discard block |
||
1339 | 1339 | * @param array $_filter filter to apply to getSortedList |
1340 | 1340 | * @param mixed $_thisUIDOnly = null, if given fetch the headers of this uid only (either one, or array of uids) |
1341 | 1341 | * @param boolean $_cacheResult = true try touse the cache of getSortedList |
1342 | - * @param mixed $_fetchPreviews = false (boolean/int) fetch part of the body of the messages requested (if integer the number is assumed to be the number of chars to be returned for preview; if set to true 300 chars are returned (when available)) |
|
1342 | + * @param boolean $_fetchPreviews = false (boolean/int) fetch part of the body of the messages requested (if integer the number is assumed to be the number of chars to be returned for preview; if set to true 300 chars are returned (when available)) |
|
1343 | 1343 | * @return array result as array(header=>array,total=>int,first=>int,last=>int) |
1344 | 1344 | */ |
1345 | 1345 | function getHeaders($_folderName, $_startMessage, $_numberOfMessages, $_sort, $_reverse, $_filter, $_thisUIDOnly=null, $_cacheResult=true, $_fetchPreviews=false) |
@@ -1939,6 +1939,7 @@ discard block |
||
1939 | 1939 | * |
1940 | 1940 | * @param mixed _sort the integer sort order / or a valid and handeled SORTSTRING (right now: UID/ARRIVAL/INTERNALDATE (->ARRIVAL)) |
1941 | 1941 | * @param bool _reverse wether to add REVERSE to the Sort String or not |
1942 | + * @param integer $_sort |
|
1942 | 1943 | * @return the sort sequence for horde search |
1943 | 1944 | */ |
1944 | 1945 | function _getSortString($_sort, $_reverse=false) |
@@ -3320,7 +3321,7 @@ discard block |
||
3320 | 3321 | * @param string $_mailbox |
3321 | 3322 | * @param string $delimiter |
3322 | 3323 | * @param string $prefix |
3323 | - * @param string $reclevel 0, counter to keep track of the current recursionlevel |
|
3324 | + * @param integer $reclevel 0, counter to keep track of the current recursionlevel |
|
3324 | 3325 | * @return array of mailboxes |
3325 | 3326 | */ |
3326 | 3327 | function getMailBoxesRecursive($_mailbox, $delimiter, $prefix, $reclevel=0) |
@@ -3370,7 +3371,7 @@ discard block |
||
3370 | 3371 | * abstraction layer for getDraftFolder, getTemplateFolder, getTrashFolder and getSentFolder |
3371 | 3372 | * @param string $_type the type to fetch (Drafts|Template|Trash|Sent) |
3372 | 3373 | * @param boolean $_checkexistance trigger check for existance |
3373 | - * @param boolean& $created =null on return true: if folder was just created, false if not |
|
3374 | + * @param boolean $created =null on return true: if folder was just created, false if not |
|
3374 | 3375 | * @return mixed string or false |
3375 | 3376 | */ |
3376 | 3377 | function _getSpecialUseFolder($_type, $_checkexistance=TRUE, &$created=null) |
@@ -3502,7 +3503,7 @@ discard block |
||
3502 | 3503 | /** |
3503 | 3504 | * getTemplateFolder wrapper for _getSpecialUseFolder Type Template |
3504 | 3505 | * @param boolean $_checkexistance trigger check for existance |
3505 | - * @return mixed string or false |
|
3506 | + * @return string string or false |
|
3506 | 3507 | */ |
3507 | 3508 | function getTemplateFolder($_checkexistance=TRUE) |
3508 | 3509 | { |
@@ -3532,7 +3533,7 @@ discard block |
||
3532 | 3533 | /** |
3533 | 3534 | * getOutboxFolder wrapper for _getSpecialUseFolder Type Outbox |
3534 | 3535 | * @param boolean $_checkexistance trigger check for existance |
3535 | - * @return mixed string or false |
|
3536 | + * @return string string or false |
|
3536 | 3537 | */ |
3537 | 3538 | function getOutboxFolder($_checkexistance=TRUE) |
3538 | 3539 | { |
@@ -4421,7 +4422,7 @@ discard block |
||
4421 | 4422 | /** |
4422 | 4423 | * get part of the message, if its stucture is indicating its of multipart alternative style |
4423 | 4424 | * a wrapper for multipartmixed |
4424 | - * @param string/int $_uid the messageuid, |
|
4425 | + * @param integer $_uid the messageuid, |
|
4425 | 4426 | * @param Horde_Mime_Part $_structure structure for parsing |
4426 | 4427 | * @param string $_htmlMode how to display a message, html, plain text, ... |
4427 | 4428 | * @param boolean $_preserveSeen flag to preserve the seenflag by using body.peek |
@@ -5077,6 +5078,9 @@ discard block |
||
5077 | 5078 | return $message; |
5078 | 5079 | } |
5079 | 5080 | |
5081 | + /** |
|
5082 | + * @param integer $cols |
|
5083 | + */ |
|
5080 | 5084 | static function wordwrap($str, $cols, $cut, $dontbreaklinesstartingwith=false) |
5081 | 5085 | { |
5082 | 5086 | $lines = explode("\n", $str); |
@@ -5529,7 +5533,6 @@ discard block |
||
5529 | 5533 | * @param string $_partID = null |
5530 | 5534 | * @param string $_folder = null |
5531 | 5535 | * @param boolean $_preserveSeen = false flag to preserve the seenflag by using body.peek |
5532 | - * @param Horde_Imap_Client_Fetch_Query $fquery=null default query just structure |
|
5533 | 5536 | * @return Horde_Mime_Part |
5534 | 5537 | */ |
5535 | 5538 | function getStructure($_uid, $_partID=null, $_folder=null, $_preserveSeen=false) |
@@ -6120,6 +6123,7 @@ discard block |
||
6120 | 6123 | * @param preserveHTML flag to pass through to getdisplayableBody |
6121 | 6124 | * @param addHeaderSection flag to be able to supress headersection |
6122 | 6125 | * @param includeAttachments flag to be able to supress possible attachments |
6126 | + * @param Mail $mailClass |
|
6123 | 6127 | * @return array/bool with 'mailaddress'=>$mailaddress, |
6124 | 6128 | * 'subject'=>$subject, |
6125 | 6129 | * 'message'=>$message, |
@@ -6573,7 +6577,7 @@ discard block |
||
6573 | 6577 | * |
6574 | 6578 | * @param Mailer $_mailObject instance of the Mailer Object to be used |
6575 | 6579 | * @param string $_html2parse the html to parse and to be altered, if conditions meet |
6576 | - * @param $mail_bo mail bo object |
|
6580 | + * @param Mail $mail_bo mail bo object |
|
6577 | 6581 | * @return array|null return inline images stored as tmp file in vfs as array of attachments otherwise null |
6578 | 6582 | */ |
6579 | 6583 | static function processURL2InlineImages(Mailer $_mailObject, &$_html2parse, $mail_bo) |
@@ -6696,7 +6700,7 @@ discard block |
||
6696 | 6700 | * @param Storage\Merge Storage\Merge bo_merge object |
6697 | 6701 | * @param string $document the full filename |
6698 | 6702 | * @param array $SendAndMergeTocontacts array of contact ids |
6699 | - * @param string& $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if |
|
6703 | + * @param string|null $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if |
|
6700 | 6704 | * folder is modified |
6701 | 6705 | * @param string& $importID ID for the imported message, used by attachments to identify them unambiguously |
6702 | 6706 | * @return mixed array of messages with success and failed messages or exception |
@@ -6940,7 +6944,7 @@ discard block |
||
6940 | 6944 | /** |
6941 | 6945 | * Parses a message/rfc mail from file to the mailobject |
6942 | 6946 | * |
6943 | - * @param object $mailer instance of the SMTP Mailer Object |
|
6947 | + * @param Mailer $mailer instance of the SMTP Mailer Object |
|
6944 | 6948 | * @param string $tmpFileName string that points/leads to the file to be imported |
6945 | 6949 | * @throws Exception\NotFound if $fle is not found |
6946 | 6950 | */ |