EGroupware / egroupware

calendar/inc/class.calendar_so.inc.php

Doc Comments +12 added lines, -36 removed lines

@@ -211,23 +211,11 @@ 
 	 * @param int $start startdate of the search/list (servertime)
 	 * @param int $end enddate of the search/list (servertime)
 	 * @param int|array $users user-id or array of user-id's, !$users means all entries regardless of users
-	 * @param int|array $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all
+	 * @param integer $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all
 	 * @param string $filter ='default' string filter-name: all (not rejected), accepted, unknown, tentative, rejected or everything (incl. rejected, deleted)
 	 * @param int|boolean $offset =False offset for a limited query or False (default)
 	 * @param int $num_rows =0 number of rows to return if offset set, default 0 = use default in user prefs
 	 * @param array $params =array()
-	 * @param string|array $params['query'] string: pattern so search for, if unset or empty all matching entries are returned (no search)
-	 *		Please Note: a search never returns repeating events more then once AND does not honor start+end date !!!
-	 *      array: everything is directly used as $where
-	 * @param string $params['order'] ='cal_start' column-names plus optional DESC|ASC separted by comma
-	 * @param string $params['sql_filter'] sql to be and'ed into query (fully quoted)
-	 * @param string|array $params['cols'] what to select, default "$this->repeats_table.*,$this->cal_table.*,cal_start,cal_end,cal_recur_date",
-	 * 						if specified and not false an iterator for the rows is returned
-	 * @param string $params['append'] SQL to append to the query before $order, eg. for a GROUP BY clause
-	 * @param array $params['cfs'] custom fields to query, null = none, array() = all, or array with cfs names
-	 * @param array $params['users'] raw parameter as passed to calendar_bo::search() no memberships resolved!
-	 * @param boolean $params['master_only'] =false, true only take into account participants/status from master (for AS)
-	 * @param boolean $params['enum_recuring'] =true enumerate recuring events
 	 * @param int $remove_rejected_by_user =null add join to remove entry, if given user has rejected it
 	 * @return array of events
 	 */
@@ -594,7 +582,7 @@ 
 	/**
 	 * generate SQL to filter after a given category (incl. subcategories)
 	 *
-	 * @param array|int $cat_id cat-id or array of cat-ids, or !$cat_id for none
+	 * @param integer $cat_id cat-id or array of cat-ids, or !$cat_id for none
 	 * @return string SQL to include in the query
 	 */
 	function cat_filter($cat_id)
@@ -686,24 +674,11 @@ 
 	 * @param int $start startdate of the search/list (servertime)
 	 * @param int $end enddate of the search/list (servertime)
 	 * @param int|array $users user-id or array of user-id's, !$users means all entries regardless of users
-	 * @param int|array $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all
+	 * @param integer $cat_id =0 mixed category-id or array of cat-id's (incl. all sub-categories), default 0 = all
 	 * @param string $filter ='all' string filter-name: all (not rejected), accepted, unknown, tentative, rejected or everything (incl. rejected, deleted)
 	 * @param int|boolean $offset =False offset for a limited query or False (default)
 	 * @param int $num_rows =0 number of rows to return if offset set, default 0 = use default in user prefs
 	 * @param array $params =array()
-	 * @param string|array $params['query'] string: pattern so search for, if unset or empty all matching entries are returned (no search)
-	 *		Please Note: a search never returns repeating events more then once AND does not honor start+end date !!!
-	 *      array: everything is directly used as $where
-	 * @param string $params['order'] ='cal_start' column-names plus optional DESC|ASC separted by comma
-	 * @param string|array $params['sql_filter'] sql to be and'ed into query (fully quoted), or usual filter array
-	 * @param string|array $params['cols'] what to select, default "$this->repeats_table.*,$this->cal_table.*,cal_start,cal_end,cal_recur_date",
-	 * 						if specified and not false an iterator for the rows is returned
-	 * @param string $params['append'] SQL to append to the query before $order, eg. for a GROUP BY clause
-	 * @param array $params['cfs'] custom fields to query, null = none, array() = all, or array with cfs names
-	 * @param array $params['users'] raw parameter as passed to calendar_bo::search() no memberships resolved!
-	 * @param boolean $params['master_only'] =false, true only take into account participants/status from master (for AS)
-	 * @param boolean $params['enum_recuring'] =true enumerate recuring events
-	 * @param boolean $params['use_so_events'] =false, true return result of new $this->events()
 	 * @param int $remove_rejected_by_user =null add join to remove entry, if given user has rejected it
 	 * @return Iterator|array of events
 	 */
@@ -1168,11 +1143,11 @@ 
 	 * Ask other apps if they want to participate in calendar search / display
 	 *
 	 * @param &$selects parts of union query
-	 * @param $start see search()
-	 * @param $end
+	 * @param integer $start see search()
+	 * @param integer $end
 	 * @param $users as used in calendar_so ($users_raw plus all members and memberships added by calendar_bo)
-	 * @param $cat_id
-	 * @param $filter
+	 * @param integer $cat_id
+	 * @param string $filter
 	 * @param $query
 	 * @param $users_raw as passed to calendar_bo::search (no members and memberships added)
 	 */
@@ -1340,6 +1315,7 @@ 
 	 * @param int &$set_recurrences_start=0 on return: time from which on the recurrences should be rebuilt, default 0=all
 	 * @param int $change_since =0 time from which on the repetitions should be changed, default 0=all
 	 * @param int &$etag etag=null etag to check or null, on return new etag
+	 * @param boolean $set_recurrences
 	 * @return boolean|int false on error, 0 if etag does not match, cal_id otherwise
 	 */
 	function save(&$event,&$set_recurrences,&$set_recurrences_start=0,$change_since=0,&$etag=null)
@@ -1735,7 +1711,7 @@ 
 	 * @param int $cal_id
 	 * @param int $start new starttime
 	 * @param int $end new endtime
-	 * @param int|boolean $change_since =0 false=new entry, > 0 time from which on the repetitions should be changed, default 0=all
+	 * @param integer $change_since =0 false=new entry, > 0 time from which on the repetitions should be changed, default 0=all
 	 * @param int $old_start =0 old starttime or (default) 0, to query it from the db
 	 * @param int $old_end =0 old starttime or (default) 0
 	 * @todo Recalculate recurrences, if timezone changes
@@ -1912,7 +1888,7 @@ 
 	 *
 	 * @param int $cal_id
 	 * @param array $participants uid => status pairs
-	 * @param int|boolean $change_since =0, false=new event,
+	 * @param integer $change_since =0, false=new event,
 	 * 		0=all, > 0 time from which on the repetitions should be changed
 	 * @param boolean $add_only =false
 	 *		false = add AND delete participants if needed (full list of participants required in $participants)
@@ -2058,7 +2034,7 @@ 
 	 * set the status of one participant for a given recurrence or for all recurrences since now (includes recur_date=0)
 	 *
 	 * @param int $cal_id
-	 * @param char $user_type 'u' regular user, 'r' resource, 'c' contact
+	 * @param string $user_type 'u' regular user, 'r' resource, 'c' contact
 	 * @param int|string $user_id
 	 * @param int|char $status numeric status (defines) or 1-char code: 'R', 'U', 'T' or 'A'
 	 * @param int $recur_date =0 date to change, or 0 = all since now
@@ -2975,7 +2951,7 @@ 
 	 * Updates the modification timestamp to force an etag, ctag and sync-token change
 	 *
 	 * @param int $id event id
-	 * @param int|boolean $update_master =false id of series master or true, to update series master too
+	 * @param boolean $update_master =false id of series master or true, to update series master too
 	 * @param int $time =null new timestamp, default current (server-)time
 	 * @param int $modifier =null uid of the modifier, default current user
 	 */

api/src/Mail/Imap.php

Doc Comments +8 added lines, -7 removed lines

@@ -132,7 +132,7 @@ 
 	 * Construtor
 	 *
 	 * @param array
-	 * @param bool|int|string $_adminConnection create admin connection if true or account_id or imap username
+	 * @param boolean|string $_adminConnection create admin connection if true or account_id or imap username
 	 * @param int $_timeout =null timeout in secs, if none given fmail pref or default of 20 is used
 	 * @return void
 	 */
@@ -450,7 +450,7 @@ 
 	/**
 	 * getSpecialUseFolders
 	 *
-	 * @return current mailbox, or if none check on INBOX, and return upon existance
+	 * @return string mailbox, or if none check on INBOX, and return upon existance
 	 */
 	function getCurrentMailbox()
 	{
@@ -568,7 +568,7 @@ 
 	 * Returns an array containing the names of the selected mailboxes
 	 *
 	 * @param   string  $reference          base mailbox to start the search (default is current mailbox)
-	 * @param   string  $restriction_search false or 0 means return all mailboxes
+	 * @param   integer  $restriction_search false or 0 means return all mailboxes
 	 *                                      true or 1 return only the mailbox that contains that exact name
 	 *                                      2 return all mailboxes in that hierarchy level
 	 * @param   string  $returnAttributes   true means return an assoc array containing mailbox names and mailbox attributes
@@ -652,7 +652,7 @@ 
 	 * Returns an array containing the names of the subscribed selected mailboxes
 	 *
 	 * @param   string  $reference          base mailbox to start the search
-	 * @param   string  $restriction_search false or 0 means return all mailboxes
+	 * @param   integer  $restriction_search false or 0 means return all mailboxes
 	 *                                      true or 1 return only the mailbox that contains that exact name
 	 *                                      2 return all mailboxes in that hierarchy level
 	 * @param   string  $returnAttributes   true means return an assoc array containing mailbox names and mailbox attributes
@@ -720,7 +720,7 @@ 
 	 * Returns an array containing the names of the selected unsubscribed mailboxes
 	 *
 	 * @param   string  $reference          base mailbox to start the search
-	 * @param   string  $restriction_search false or 0 means return all mailboxes
+	 * @param   integer  $restriction_search false or 0 means return all mailboxes
 	 *                                      true or 1 return only the mailbox that contains that exact name
 	 *                                      2 return all mailboxes in that hierarchy level
 	 *
@@ -898,6 +898,7 @@ 
 	 *
 	 * @var array $_nameSpace
 	 * @var string $_folderName
+	 * @param string $_folderName
 	 * @return string the prefix (may be an empty string)
 	 */
 	static function getFolderPrefixFromNamespace($_nameSpace, $_folderName)
@@ -916,7 +917,7 @@ 
 	 * @param string $_mailbox
 	 * @param string $delimiter
 	 * @param string $prefix
-	 * @param string $reclevel = 0, counter to keep track of the current recursionlevel
+	 * @param integer $reclevel = 0, counter to keep track of the current recursionlevel
 	 * @return array of mailboxes
 	 */
 	function getMailBoxesRecursive($_mailbox, $delimiter, $prefix, $reclevel=0)
@@ -1355,7 +1356,7 @@ 
 	/**
 	 * Get vacation message for given user
 	 *
-	 * @param int|string $_euser nummeric account_id or imap username
+	 * @param string|null $_euser nummeric account_id or imap username
 	 * @param string $_scriptName =null
 	 * @throws Exception on connection error or authentication failure
 	 * @return array

admin/inc/class.admin_export_acl_csv.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@ 
 	/**
 	 * Exports records as defined in $_definition
 	 *
-	 * @param egw_record $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function export( $_stream, importexport_definition $_definition)
 	{
@@ -149,7 +149,7 @@ 
 	 * return html for options.
 	 * this way the plugin has all opportunities for options tab
 	 *
-	 * @return string html
+	 * @return boolean html
 	 */
 	public function get_options_etpl()
 	{

api/src/Contacts/Storage.php

Doc Comments +1 added lines, -10 removed lines

@@ -625,7 +625,7 @@ 
 	 * @param array|string $criteria array of key and data cols, OR string to search over all standard search fields
 	 * @param boolean|string $only_keys =true True returns only keys, False returns all cols. comma seperated list of keys to return
 	 * @param string $order_by ='' fieldnames + {ASC|DESC} separated by colons ',', can also contain a GROUP BY (if it contains ORDER BY)
-	 * @param string|array $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
+	 * @param string $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
 	 * @param string $wildcard ='' appended befor and after each criteria
 	 * @param boolean $empty =false False=empty criteria are ignored in query, True=empty have to be empty in row
 	 * @param string $op ='AND' defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together
@@ -833,13 +833,6 @@ 
 	 * Find contacts that appear to be duplicates
 	 *
 	 * @param Array $param
-	 * @param string $param[org_view] 'org_name', 'org_name,adr_one_location', 'org_name,org_unit' how to group
-	 * @param int $param[owner] addressbook to search
-	 * @param string $param[search] search pattern for org_name
-	 * @param string $param[searchletter] letter the org_name need to start with
-	 * @param int $param[start]
-	 * @param int $param[num_rows]
-	 * @param string $param[sort] ASC or DESC
 	 *
 	 * @return array of arrays
 	 */
@@ -932,8 +925,6 @@ 
 	 * delete / move all contacts of an addressbook
 	 *
 	 * @param array $data
-	 * @param int $data['account_id'] owner to change
-	 * @param int $data['new_owner']  new owner or 0 for delete
 	 */
 	function deleteaccount($data)
 	{

importexport/inc/class.importexport_definition.inc.php

Doc Comments -1 removed lines

@@ -176,7 +176,6 @@
 	/**
 	 * sets options
 	 *
-	 * @param array $options
 	 */
 	private function set_options(array $_plugin_options) {
 		// Check conditions

api/tests/Etemplate/Widget/DateTest.php

Doc Comments -1 removed lines

@@ -94,7 +94,6 @@
 	 * Check some basic validation stuff
 	 *
 	 * @param type $content
-	 * @param type $validation_errors
 	 *
 	 * @dataProvider validationProvider
 	 */

api/tests/Etemplate/Widget/UrlEmailTest.php

Doc Comments -1 removed lines

@@ -80,7 +80,6 @@
 	 * Check validation with failing strings
 	 *
 	 * @param type $content
-	 * @param type $validation_errors
 	 *
 	 * @dataProvider validationProvider
 	 */

api/tests/Etemplate/Widget/UrlTest.php

Doc Comments -1 removed lines

@@ -64,7 +64,6 @@
 	 * Check validation with failing strings
 	 *
 	 * @param type $content
-	 * @param type $validation_errors
 	 *
 	 * @dataProvider invalidProvider
 	 */

collabeditor/src/Bo.php

Doc Comments +1 added lines, -1 removed lines

@@ -201,7 +201,7 @@
 	/**
 	 * Check if session is valid
 	 *
-	 * @param type $es_id
+	 * @param string $es_id
 	 *
 	 * @return boolean return true if session is valid otherwise false
 	 */