EGroupware / egroupware

infolog/inc/class.infolog_bo.inc.php

Doc Comments +2 added lines, -5 removed lines

@@ -1226,7 +1226,7 @@ 
 	 * Is called as hook to participate in the linking
 	 *
 	 * @param int|array $info int info_id or array with infolog entry
-	 * @return string|boolean string with the title, null if $info not found, false if no perms to view
+	 * @return string string with the title, null if $info not found, false if no perms to view
 	 */
 	function link_title($info)
 	{
@@ -1324,9 +1324,6 @@ 
 	/**
 	 * hook called be calendar to include events or todos in the cal-dayview
 	 *
-	 * @param int $args[year], $args[month], $args[day] date of the events
-	 * @param int $args[owner] owner of the events
-	 * @param string $args[location] calendar_include_{events|todos}
 	 * @return array of events (array with keys starttime, endtime, title, view, icon, content)
 	 */
 	function cal_to_include($args)
@@ -1515,7 +1512,7 @@ 
 	 * Get names for categories specified by their id's
 	 *
 	 * @param array|string $cat_id_list array or comma-sparated list of id's
-	 * @return array with names
+	 * @return string|boolean with names
 	 */
 	function get_categories($cat_id_list)
 	{

infolog/inc/class.infolog_groupdav.inc.php

Doc Comments +6 added lines, -6 removed lines

@@ -141,7 +141,7 @@ 
 	 * @param array &$options
 	 * @param array &$files
 	 * @param int $user account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function propfind($path,&$options,&$files,$user,$id='')
 	{
@@ -221,7 +221,7 @@ 
 	 *
 	 * @param string $path
 	 * @param array $filter
-	 * @param array|boolean $start =false false=return all or array(start,num)
+	 * @param integer[] $start =false false=return all or array(start,num)
 	 * @return array with "files" array with values for keys path and props
 	 */
 	function &propfind_callback($path,array $filter,$start=false)
@@ -521,7 +521,7 @@ 
 	 * @param array &$options
 	 * @param int $id
 	 * @param int $user =null account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function get(&$options,$id,$user=null)
 	{
@@ -546,7 +546,7 @@ 
 	 * @param int $id
 	 * @param int $user =null account_id of owner, default null
 	 * @param string $prefix =null user prefix from path (eg. /ralf from /ralf/addressbook)
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function put(&$options,$id,$user=null,$prefix=null)
 	{
@@ -682,7 +682,7 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function delete(&$options,$id)
 	{
@@ -757,7 +757,7 @@ 
 	 * etag currently uses the modifcation time (info_datemodified), 1.9.002 adds etag column, but it's not yet used!
 	 *
 	 * @param array|int $info array with infolog entry or info_id
-	 * @return string|boolean string with etag or false
+	 * @return false|string string with etag or false
 	 */
 	function get_etag($info)
 	{

infolog/inc/class.infolog_ical.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -1042,8 +1042,7 @@
 	 * Search a matching infolog entry for the VNOTE data
 	 *
 	 * @param string $_vcalData		VNOTE
-	 * @param int $contentID=null 	infolog_id (or null, if unkown)
-	 * @param boolean $relax=false 	if true, a weaker match algorithm is used
+	 * @param int $contentID 	infolog_id (or null, if unkown)
 	 * @param string $charset  The encoding charset for $text. Defaults to
      *                         utf-8 for new format, iso-8859-1 for old format.
 	 *

infolog/inc/class.infolog_import_infologs_csv.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -108,8 +108,7 @@ 
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function import( $_stream, importexport_definition $_definition ) {
 		$import_csv = new importexport_import_csv( $_stream, array(
@@ -527,6 +526,7 @@ 
 	 *
 	 * This is a copy of what's in importexport_basic_import_csv, and can go
 	 * away if this is changed to extend it
+	 * @param integer $record_num
 	 */
 	protected function link_by_cf($record_num, $app, $fieldname, $_value)
 	{

infolog/inc/class.infolog_so.inc.php

Doc Comments +1 added lines, -14 removed lines

@@ -85,6 +85,7 @@ 
 	 * Check if user is responsible for an entry: he or one of his memberships is in responsible
 	 *
 	 * @param array $info infolog entry as array
+	 * @param integer $user
 	 * @return boolean
 	 */
 	function is_responsible($info,$user=null)
@@ -476,8 +477,6 @@ 
 	 * changes or deletes entries with a spezified owner (for hook_delete_account)
 	 *
 	 * @param array $args hook arguments
-	 * @param int $args['account_id'] account to delete
-	 * @param int $args['new_owner']=0 new owner
 	 */
 	function change_delete_owner(array $args)  // new_owner=0 means delete
 	{
@@ -659,19 +658,7 @@ 
 	/**
 	 * searches InfoLog for a certain pattern in $query
 	 *
-	 * @param string $query[order] column-name to sort after
-	 * @param string $query[sort] sort-order DESC or ASC
-	 * @param string $query[filter] string with combination of acl-, date- and status-filters, eg. 'own-open-today' or ''
-	 * @param int $query[cat_id] category to use or 0 or unset
-	 * @param string $query[search] pattern to search, search is done in info_from, info_subject and info_des
-	 * @param string $query[action] / $query[action_id] if only entries linked to a specified app/entry show be used
 	 * @param int &$query[start], &$query[total] nextmatch-parameters will be used and set if query returns less entries
-	 * @param array $query[col_filter] array with column-name - data pairs, data == '' means no filter (!)
-	 * @param boolean $query[subs] return subs or not, if unset the user preference is used
-	 * @param int $query[num_rows] number of rows to return if $query[start] is set, default is to use the value from the general prefs
-	 * @param string|array $query[cols]=null what to query, if set the recordset / iterator get's returned
-	 * @param string $query[append]=null get's appended to sql query, eg. for GROUP BY
-	 * @param boolean $query['custom_fields']=false query custom-fields too, default not
 	 * @return array|iterator with id's as key of the matching log-entries or recordset/iterator if cols is set
 	 */
 	function search(&$query)

infolog/inc/class.infolog_tracking.inc.php

Doc Comments -1 removed lines

@@ -125,7 +125,6 @@
 	/**
 	 * Constructor
 	 *
-	 * @param botracker $botracker
 	 * @return tracker_tracking
 	 */
 	function __construct(&$infolog_bo)

infolog/inc/class.infolog_ui.inc.php

Doc Comments +9 added lines, -9 removed lines

@@ -295,6 +295,8 @@ 
 	 * @param array &$query
 	 * @param array &$rows
 	 * @param array &$readonlys
+	 * @param type|null $rows
+	 * @param type|null $readonlys
 	 * @return int
 	 */
 	function get_rows(&$query,&$rows,&$readonlys)
@@ -574,7 +576,6 @@ 
 	 * Hook for timesheet to set some extra data and links
 	 *
 	 * @param array $data
-	 * @param int $data[id] info_id
 	 * @return array with key => value pairs to set in new timesheet and link_app/link_id arrays
 	 */
 	function timesheet_set($data)
@@ -600,7 +601,6 @@ 
 	 * Hook for calendar to set some extra data and links
 	 *
 	 * @param array $data event-array preset by calendar plus
-	 * @param int $data[entry_id] info_id
 	 * @return array with key => value pairs to set in new event and link_app/link_id arrays
 	 */
 	function calendar_set($data)
@@ -688,11 +688,11 @@ 
 	/**
 	 * Shows the infolog list
 	 *
-	 * @param array/string $values etemplate content or 'reset_action_view' if called by index.php to reset an action-view
+	 * @param integer $values etemplate content or 'reset_action_view' if called by index.php to reset an action-view
 	 * @param string $action if set only entries liked to that $action:$action_id are shown
 	 * @param string $action_id if set only entries liked to that $action:$action_id are shown
-	 * @param mixed $called_as is how we got called, for a hook eg. the call-params of that page containing the hook
-	 * @param boolean $e$extra_app_header * @param boolean $return_html=false
+	 * @param integer $called_as is how we got called, for a hook eg. the call-params of that page containing the hook
+	 * @param boolean $extra_app_header * @param boolean $return_html
 	 * @param string $own_referer='' this is our own referer
 	 * @param string $action_title='' app_header for the action, if '' we try the link-title
 	 */
@@ -1288,7 +1288,7 @@ 
 	 * @param array $query get_rows parameter
 	 * @param string &$msg on return user feedback
 	 * @param boolean $skip_notifications true to NOT notify users about changes
-	 * @return boolean true if all actions succeded, false otherwise
+	 * @return boolean|null true if all actions succeded, false otherwise
 	 */
 	function action($_action, $checked, $use_all, &$success, &$failed, &$action_msg,
 		array $query, &$msg, $skip_notifications = false)
@@ -1526,9 +1526,9 @@ 
 	/**
 	 * Closes an infolog
 	 *
-	 * @param int|array $values=0 info_id (default _GET[info_id])
+	 * @param int|array $values info_id (default _GET[info_id])
 	 * @param string $_referer=''
-	 * @param boolean $closesingle=false
+	 * @param boolean $closesingle
 	 */
 	function close($values=0,$_referer='',$closesingle=false,$skip_notification = false)
 	{
@@ -1576,7 +1576,7 @@ 
 	/**
 	 * Deletes an InfoLog entry
 	 *
-	 * @param array|int $values info_id (default _GET[info_id])
+	 * @param integer $values info_id (default _GET[info_id])
 	 * @param string $_referer
 	 * @param string $called_by
 	 * @param boolean $skip_notification Do not send notification of deletion

json.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
  * callback if the session-check fails, redirects to login.php, if no valid basic auth credentials given
  *
  * @param array &$anon_account anon account_info with keys 'login', 'passwd' and optional 'passwd_type'
- * @return boolean|string true if we allow anon access and anon_account is set, a sessionid or false otherwise
+ * @return string|null true if we allow anon access and anon_account is set, a sessionid or false otherwise
  */
 function login_redirect(&$anon_account)
 {

mail/inc/class.mail_acl.inc.php

Doc Comments -2 removed lines

@@ -277,8 +277,6 @@
 	 * Update ACL rights of a folder or including subfolders for an account(s)
 	 *
 	 * @param array $content content including the acl rights
-	 * @param Boolean $recursive boolean flag FALSE|TRUE. If it is FALSE, only the folder take in to account, but in case of TRUE
-	 *		the mailbox including all its subfolders will be considered.
 	 * @param string $msg Message
 	 *
 	 */