EGroupware / egroupware

calendar/importexport/class.import_events_csv.inc.php

Doc Comments -1 removed lines

@@ -94,7 +94,6 @@
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
 	 * @param definition $_definition
 	 */
 	public function import( $_stream, definition $_definition ) {

calendar/inc/class.calendar_bo.inc.php

Doc Comments +8 added lines, -13 removed lines

@@ -626,8 +626,8 @@ 
 	 * or an ExecMethod callback with parameters $id,$event
 	 *
 	 * @param string $app
-	 * @param int|string $id
-	 * @return string
+	 * @param string $id
+	 * @return boolean
 	 */
 	static function integration_get_private($app,$id,$event)
 	{
@@ -756,7 +756,7 @@ 
 	 * This methods operates in usertime, while $this->config['horizont'] is in servertime!
 	 *
 	 * @param array $event
-	 * @param mixed $start =0 minimum start-time for new recurrences or !$start = since the start of the event
+	 * @param integer $start =0 minimum start-time for new recurrences or !$start = since the start of the event
 	 */
 	function set_recurrences($event,$start=0)
 	{
@@ -976,10 +976,9 @@ 
 	 * Recurrences get calculated by rrule iterator implemented in calendar_rrule class.
 	 *
 	 * @param array $event repeating event whos repetions should be inserted
-	 * @param mixed $start start-date
+	 * @param mixed $_start start-date
 	 * @param mixed $end end-date
 	 * @param array $events where the repetions get inserted
-	 * @param array $recur_exceptions with date (in Ymd) as key (and True as values), seems not to be used anymore
 	 */
 	function insert_all_recurrences($event,$_start,$end,&$events)
 	{
@@ -1133,7 +1132,7 @@ 
 	 *	even if you have no general read-grant from that user.
 	 *
 	 * @param int $needed necessary ACL right: Acl::{READ|EDIT|DELETE}
-	 * @param mixed $event event as array or the event-id or 0 for a general check
+	 * @param integer $event event as array or the event-id or 0 for a general check
 	 * @param int $other uid to check (if event==0) or 0 to check against $this->user
 	 * @param string $date_format ='ts' date-format used for reading: 'ts'=timestamp, 'array'=array, 'string'=iso8601 string for xmlrpc
 	 * @param mixed $date_to_read =null date used for reading, internal param for the caching
@@ -1306,8 +1305,6 @@ 
 	 * @param string $msg message with parameters/variables like lang(), eg. '%1'
 	 * @param boolean $backtrace =True include a function-backtrace, default True=On
 	 *	should only be set to False=Off, if your code ensures a call with backtrace=On was made before !!!
-	 * @param mixed $param a variable number of parameters, to be inserted in $msg
-	 *	arrays get serialized with print_r() !
 	 */
 	static function debug_message($msg,$backtrace=True)
 	{
@@ -1370,7 +1367,7 @@ 
 	 * Formats one or two dates (range) as long date (full monthname), optionaly with a time
 	 *
 	 * @param mixed $_first first date
-	 * @param mixed $last =0 last date if != 0 (default)
+	 * @param integer $last =0 last date if != 0 (default)
 	 * @param boolean $display_time =false should a time be displayed too
 	 * @param boolean $display_day =false should a day-name prefix the date, eg. monday June 20, 2006
 	 * @return string with formated date
@@ -1839,7 +1836,6 @@ 
 	 *
 	 * Is called as hook to participate in the linking
 	 *
-	 * @param int|array $entry int cal_id or array with event
 	 * @param string|boolean string with title, null if not found or false if not read perms
 	 */
 	function link_title($event)
@@ -2028,7 +2024,8 @@ 
 	 *
 	 * @param array|int|string $entry array with event or cal_id, or cal_id:recur_date for virtual exceptions
 	 * @param string &$schedule_tag=null on return schedule-tag (egw_cal.cal_id:egw_cal.cal_etag, no participant modifications!)
-	 * @return string|boolean string with etag or false
+	 * @param string $schedule_tag
+	 * @return string string with etag or false
 	 */
 	function get_etag($entry, &$schedule_tag=null)
 	{
@@ -2068,7 +2065,6 @@ 
 	 * Hook for infolog  to set some extra data and links
 	 *
 	 * @param array $data event-array preset by infolog plus
-	 * @param int $data[id] cal_id
 	 * @return array with key => value pairs to set in new event and link_app/link_id arrays
 	 */
 	function infolog_set($data)
@@ -2120,7 +2116,6 @@ 
 	 * Hook for timesheet to set some extra data and links
 	 *
 	 * @param array $data
-	 * @param int $data[id] cal_id:recurrence
 	 * @return array with key => value pairs to set in new timesheet and link_app/link_id arrays
 	 */
 	function timesheet_set($data)

calendar/inc/class.calendar_boupdate.inc.php

Doc Comments +11 added lines, -6 removed lines

@@ -519,6 +519,7 @@ 
 	 * @param array $new_event Event after the change
 	 * @param string $role we treat CHAIR like event owners
 	 * @param string $status of current user
+	 * @param integer $msg_type
 	 * @return boolean true = update requested, false otherwise
 	 */
 	public static function update_requested($userid, $part_prefs, &$msg_type, $old_event ,$new_event, $role, $status=null)
@@ -594,7 +595,7 @@ 
 	/**
 	 * Check calendar prefs, if a given user (integer account_id) or email (user or externals) should get notified
 	 *
-	 * @param int|string $user_or_email
+	 * @param string $user_or_email
 	 * @param string $ical_method ='REQUEST'
 	 * @param string $role ='REQ-PARTICIPANT'
 	 * @return boolean true if user requested to be notified, false if not
@@ -645,8 +646,7 @@ 
 	 * Get iCal/iMip method from internal nummeric msg-type plus optional notification message and verbose name
 	 *
 	 * @param int $msg_type see MSG_* defines
-	 * @param string& $action=null on return verbose name
-	 * @param string& $msg=null on return notification message
+	 * @param string& $action on return verbose name
 	 */
 	function msg_type2ical_method($msg_type, &$action=null, &$msg=null)
 	{
@@ -1011,6 +1011,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $added
+	 */
 	function get_update_message($event,$added)
 	{
 		$nul = null;
@@ -1300,8 +1303,8 @@ 
 	 *
 	 * @param int $right self::CAT_ACL_{ADD|STATUS}
 	 * @param int|array $event
-	 * @return boolean true if use has the right, false if not
-	 * @return boolean false=access denied because of cat acl, true access granted because of cat acl,
+	 * @return null|boolean true if use has the right, false if not
+	 * @return null|boolean false=access denied because of cat acl, true access granted because of cat acl,
 	 * 	null = cat has no acl
 	 */
 	function check_cat_acl($right,$event)
@@ -1386,6 +1389,8 @@ 
 	 * Check if current user has a given right on a category (if it's restricted!)
 	 *
 	 * @param int $cat_id
+	 * @param integer $right
+	 * @param integer $user
 	 * @return boolean false=access denied because of cat acl, true access granted because of cat acl,
 	 * 	null = cat has no acl
 	 */
@@ -1647,7 +1652,7 @@ 
 	 * @param string $action
 	 * @param array $event_arr
 	 * @param array $disinvited
-	 * @return array
+	 * @return string
 	 */
 	function _get_event_details($event,$action,&$event_arr,$disinvited=array())
 	{

calendar/inc/class.calendar_groupdav.inc.php

Doc Comments +10 added lines, -10 removed lines

@@ -315,7 +315,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)
@@ -620,7 +620,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)
 	{
@@ -793,7 +793,7 @@ 
 	 * Check if $user is a participant of given $event incl. group-invitations
 	 *
 	 * @param array $event
-	 * @param int|string $user
+	 * @param integer $user
 	 * @return boolean
 	 */
 	public static function isParticipant(array $event, $user)
@@ -810,7 +810,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)
 	{
@@ -1038,7 +1038,7 @@ 
 	 * @param array &$options
 	 * @param int $id
 	 * @param int $user =null account_id of owner, default null
-	 * @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 post(&$options,$id,$user=null)
 	{
@@ -1112,7 +1112,7 @@ 
 	 * @param string $charset of ical
 	 * @param int $user account_id of owner
 	 * @param array &$options
-	 * @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')
 	 */
 	protected function outbox_freebusy_request($ical, $charset, $user, array &$options)
 	{
@@ -1187,7 +1187,7 @@ 
 	 * @param string $path
 	 * @param array $options
 	 * @param int $user account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|null boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function free_busy_report($path,$options,$user)
 	{
@@ -1416,7 +1416,7 @@ 
 	/**
 	 * Query ctag for calendar
 	 *
-	 * @return string
+	 * @return integer
 	 */
 	public function getctag($path,$user)
 	{
@@ -1432,7 +1432,7 @@ 
 	 *
 	 * @param array|int $entry array with event or cal_id
 	 * @param string $schedule_tag =null on return schedule-tag
-	 * @return string|boolean string with etag or false
+	 * @return string string with etag or false
 	 */
 	function get_etag($entry, &$schedule_tag=null)
 	{
@@ -1449,7 +1449,7 @@ 
 	 *
 	 * @param int|array $entry id or array of new created entry
 	 * @param string $path
-	 * @param int|string $retval
+	 * @param string|boolean $retval
 	 * @param boolean $path_attr_is_name =true true: path_attr is ca(l|rd)dav_name, false: id (GroupDAV needs Location header)
 	 */
 	function put_response_headers($entry, $path, $retval, $path_attr_is_name=true)

calendar/inc/class.calendar_holidays.inc.php

Doc Comments +3 added lines

@@ -135,6 +135,9 @@
 		return $until_year ? $years : $years[$year];
 	}
 
+	/**
+	 * @param string $url
+	 */
 	protected static function is_url($url)
 	{
 		return $url[0] == '/' || strpos($url, '://') !== false;

calendar/inc/class.calendar_ical.inc.php

Doc Comments +11 added lines, -7 removed lines

@@ -194,7 +194,7 @@ 
 	 *                          default 0 => export whole series (or events, if not recurring)
 	 * @param string $principalURL ='' Used for CalDAV exports
 	 * @param string $charset ='UTF-8' encoding of the vcalendar, default UTF-8
-	 * @param int|string $current_user =0 uid of current user to only export that one as participant for method=REPLY
+	 * @param integer $current_user =0 uid of current user to only export that one as participant for method=REPLY
 	 * @return string|boolean string with iCal or false on error (e.g. no permission to read the event)
 	 */
 	function &exportVCal($events, $version='1.0', $method='PUBLISH', $recur_date=0, $principalURL='', $charset='UTF-8', $current_user=0)
@@ -1094,16 +1094,15 @@ 
 	 * Import an iCal
 	 *
 	 * @param string|resource $_vcalData
-	 * @param int $cal_id=-1 must be -1 for new entries!
-	 * @param string $etag=null if an etag is given, it has to match the current etag or the import will fail
-	 * @param boolean $merge=false	merge data with existing entry
-	 * @param int $recur_date=0 if set, import the recurrence at this timestamp,
+	 * @param int $cal_id must be -1 for new entries!
+	 * @param int $recur_date if set, import the recurrence at this timestamp,
 	 *                          default 0 => import whole series (or events, if not recurring)
 	 * @param string $principalURL='' Used for CalDAV imports
-	 * @param int $user=null account_id of owner, default null
 	 * @param string $charset  The encoding charset for $text. Defaults to
 	 *                         utf-8 for new format, iso-8859-1 for old format.
-	 * @param string $caldav_name=null name from CalDAV client or null (to use default)
+	 * @param string $caldav_name name from CalDAV client or null (to use default)
+	 * @param integer $etag
+	 * @param integer $user
 	 * @return int|boolean|null cal_id > 0 on success, false on failure or 0 for a failed etag|permission denied or null for "403 Forbidden"
 	 */
 	function importVCal($_vcalData, $cal_id=-1, $etag=null, $merge=false, $recur_date=0, $principalURL='', $user=null, $charset=null, $caldav_name=null,$skip_notification=false)
@@ -3182,6 +3181,10 @@ 
 		return $event;
 	}
 
+	/**
+	 * @param integer $contentID
+	 * @param string $charset
+	 */
 	function search($_vcalData, $contentID=null, $relax=false, $charset=null)
 	{
 		if (($events = $this->icaltoegw($_vcalData, $charset)))
@@ -3221,6 +3224,7 @@ 
 	 * @param string $method ='PUBLISH' or eg. 'REPLY'
 	 * @param array $extra =null extra attributes to add
 	 * 	X-CALENDARSERVER-MASK-UID can be used to not include an event specified by this uid as busy
+	 * @return string|null
 	 */
 	function freebusy($user,$end=null,$utc=true, $charset='UTF-8', $start=null, $method='PUBLISH', array $extra=null)
 	{

calendar/inc/class.calendar_import_csv.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
 	 * @param importepport_iface_egw_record record The egw_record object being imported
 	 * @param importexport_iface_import_record import_csv Import object contains current state
 	 *
-	 * @return boolean success
+	 * @return null|boolean success
 	 */
 	public function import_record(\importexport_iface_egw_record &$record, &$import_csv)
 	{
@@ -254,7 +254,6 @@ 
 	 * perform the required action
 	 *
 	 * @param int $_action one of $this->actions
-	 * @param array $_data record data for the action
 	 * @return bool success or not
 	 */
 	protected function action ( $_action, importexport_iface_egw_record &$record, $record_num = 0 )
@@ -343,7 +342,7 @@ 
 	/**
 	 * Alter a row for preview to show multiple participants instead of Array
 	 *
-	 * @param egw_record $row_entry
+	 * @param importexport_iface_egw_record $row_entry
 	 */
 	protected function row_preview(importexport_iface_egw_record &$row_entry)
 	{

calendar/inc/class.calendar_merge.inc.php

Doc Comments -3 removed lines

@@ -113,8 +113,6 @@ 
 	 * @param array $ids array with contact id(s)
 	 * @param string &$err error-message on error
 	 * @param string $mimetype mimetype of complete document, eg. text/*, application/vnd.oasis.opendocument.text, application/rtf
-	 * @param array $fix=null regular expression => replacement pairs eg. to fix garbled placeholders
-	 * @param string $charset=null charset to override default set by mimetype or export charset
 	 * @return string|boolean merged document or false on error
 	 */
 	function merge_string($content,$ids,$err,$mimetype,$fix)
@@ -234,7 +232,6 @@ 
 	 * Return replacements for the calendar
 	 *
 	 * @param int|array $id event-id or array with id/recur_date, or array with event info
-	 * @param boolean $last_event_too=false also include information about the last event
 	 * @return array
 	 */
 	public function calendar_replacements($id,$prefix = '', &$content = '')

calendar/inc/class.calendar_so.inc.php

Doc Comments +13 added lines, -37 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)
@@ -682,24 +670,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
 	 */
@@ -1140,11 +1115,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)
 	 */
@@ -1312,6 +1287,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)
@@ -1722,7 +1698,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
@@ -1899,12 +1875,12 @@ 
 	 *
 	 * @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)
 	 *		true = only add participants if needed, no participant will be deleted (participants to check/add required in $participants)
-	 * @return int|boolean number of updated recurrences or false on error
+	 * @return boolean number of updated recurrences or false on error
 	 */
 	function participants($cal_id,$participants,$change_since=0,$add_only=false)
 	{
@@ -2045,7 +2021,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
@@ -2962,7 +2938,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
 	 */