EGroupware / egroupware

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
 	 */

calendar/inc/class.calendar_timezones.inc.php

Doc Comments +1 added lines

@@ -204,6 +204,7 @@
 	 *
 	 * @param boolean &$updated=null on return true if update was neccessary, false if tz's were already up to date
 	 * @param string $file ='calendar/setup/timezones.sqlite' filename relative to EGW_SERVER_ROOT
+	 * @param boolean $updated
 	 * @return string message about update
 	 * @throws Api\Exception\WrongParameter if $file is not readable or wrong format/version
 	 * @throws Api\Exception\WrongUserinput if no PDO sqlite support

calendar/inc/class.calendar_uiforms.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -1077,7 +1077,7 @@ 
 	 *	date instead of today
 	 * @param boolean $no_notifications Toggle notifications to participants
 	 *
-	 * @return false or error message
+	 * @return string|false or error message
 	 */
 	function _break_recurring(&$event, $old_event, $as_of_date = null, $no_notifications = true)
 	{
@@ -2173,7 +2173,7 @@ 
 	 * Freetime search
 	 *
 	 * As the function is called in a popup via javascript, parametes get initialy transfered via the url
-	 * @param array $content=null array with parameters or false (default) to use the get-params
+	 * @param array $content array with parameters or false (default) to use the get-params
 	 * @param string start[str] start-date
 	 * @param string start[hour] start-hour
 	 * @param string start[min] start-minutes
@@ -2417,7 +2417,7 @@ 
 	/**
      * Export events as vCalendar version 2.0 files (iCal)
      *
-     * @param int|array $content numeric cal_id or submitted content from etempalte::exec
+     * @param integer $content numeric cal_id or submitted content from etempalte::exec
      * @param boolean $return_error should an error-msg be returned or a regular page with it generated (default)
      * @return string error-msg if $return_error
      */

calendar/inc/class.calendar_uilist.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -539,8 +539,9 @@
 	 * @param int &$success number of succeded actions
 	 * @param int &$failed number of failed actions (not enought permissions)
 	 * @param string &$action_msg translated verb for the actions, to be used in a message like %1 events 'deleted'
-	 * @param string/array $session_name 'calendar_list'
-	 * @return boolean true if all actions succeded, false otherwise
+	 * @param string $session_name 'calendar_list'
+	 * @param null|string $msg
+	 * @return null|boolean true if all actions succeded, false otherwise
 	 */
 	function action($action,$checked,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg,$skip_notification=false)
 	{

calendar/inc/class.calendar_uiviews.inc.php

Doc Comments +8 added lines, -6 removed lines

@@ -412,7 +412,7 @@ 
 	/**
 	 * Displays the planner view
 	 *
-	 * @param boolean|Etemplate $home = false if etemplate return content suitable for home-page
+	 * @param null|Etemplate $home = false if etemplate return content suitable for home-page
 	 */
 	function &planner($content = array(), $home=false)
 	{
@@ -497,7 +497,7 @@ 
 	 * Used for home app
 	 *
 	 * @param int $weeks = 0 number of weeks to show, if 0 (default) all weeks of one month are shown
-	 * @param boolean|etemplate2 $home = false if not false return content suitable for home-page
+	 * @param null|Etemplate $home = false if not false return content suitable for home-page
 	 */
 	function &month($weeks=0,$home=false)
 	{
@@ -580,6 +580,8 @@ 
 	 * @param int &$first timestamp 0h of first day of week containing the first of the current month
 	 * @param int &$last timestamp 23:59:59 of last day of week containg the last day of the current month
 	 * @param int $day = 1 should the alignment be based on the 1. of the month or an other date, eg. the 15.
+	 * @param integer $first
+	 * @param integer $last
 	 */
 	function _week_align_month(&$first,&$last,$day=1)
 	{
@@ -604,7 +606,7 @@ 
 	 * Displays the weekview, with 5 or 7 days
 	 *
 	 * @param int $days = 0 number of days to show, if 0 (default) the value from the URL or the prefs is used
-	 * @param boolean|etemplate2 $home = false if not false return content suitable for home-page
+	 * @param null|Etemplate $home = false if not false return content suitable for home-page
 	 */
 	function week($days=0,$home=false)
 	{
@@ -740,7 +742,7 @@ 
 	/**
 	 * Query the open ToDo's via a hook from InfoLog or any other 'calendar_include_todos' provider
 	 *
-	 * @param array/string $todo_label label for the todo-box or array with 2 values: the label and a boolean show_all
+	 * @param string $todo_label label for the todo-box or array with 2 values: the label and a boolean show_all
 	 *	On return $todo_label contains the label for the todo-box
 	 * @return string/boolean Api\Html with a table of open todo's or false if no hook availible
 	 */
@@ -824,7 +826,7 @@ 
 	 * - 'edit_popup' => '400x300' (optional)
 	 *
 	 * @param string $app
-	 * @param int|string $id
+	 * @param string $id
 	 * @return string
 	 */
 	public static function integration_get_popup($app,$id)
@@ -864,7 +866,7 @@ 
 	 * Icons specified in $events['icons'] are always displayed!
 	 *
 	 * @param string $app
-	 * @param int|string $id
+	 * @param string $id
 	 * @param array $event
 	 * @return array
 	 */

calendar/inc/class.calendar_zpush.inc.php

Doc Comments +4 added lines, -3 removed lines

@@ -272,7 +272,7 @@ 
 	 * @param int $truncsize
 	 * @param int $bodypreference
 	 * @param $optionbodypreference
-	 * @param bool $mimesupport
+	 * @param integer $mimesupport
 	 * @return SyncMail
 	 */
 	function GetMeetingRequest($id, $truncsize, $bodypreference=false, $optionbodypreference=false, $mimesupport = 0)
@@ -875,7 +875,7 @@ 
 	 * @param string $displayname => new folder name (to be created, or to be renamed to)
 	 * @param string $type folder type, ignored in IMAP
 	 *
-	 * @return array|boolean stat array or false on error
+	 * @return boolean stat array or false on error
 	 */
 	public function ChangeFolder($id, $oldid, $displayname, $type)
 	{
@@ -890,7 +890,7 @@ 
 	 * @param string $id of the folder to delete
 	 *
 	 * @return
-	 * @TODO check what is to be returned
+	 boolean @TODO check what is to be returned
 	 */
 	public function DeleteFolder($parentid, $id)
 	{
@@ -1578,6 +1578,7 @@ 
 	 * Unpack timezone info from Sync
 	 *
 	 * copied from backend/ics.php
+	 * @param string $data
 	 */
 	static public function _getTZFromSyncBlob($data)
 	{

calendar/setup/tables_update.inc.php

Doc Comments +5 added lines, -1 removed lines

@@ -11,6 +11,10 @@ 
 
 use EGroupware\Api;
 
+/**
+ * @param string $table
+ * @param string $field
+ */
 function calendar_v0_9_2to0_9_3update_owner($table, $field)
 {
 	$GLOBALS['egw_setup']->oProc->query("select distinct($field) from $table");
@@ -2306,7 +2310,7 @@ 
  *
  * Also fix recurring events containing a reference to an other master, created when an exception is made a recurring event.
  *
- * @return type
+ * @return string
  */
 function calendar_upgrade14_1()
 {

doc/fix_api.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
  *
  * @param string $file filename
  * @param boolean $dry_run =false true: only echo fixed file, not fix it
- * @return boolean false on error
+ * @return boolean|null false on error
  */
 function fix_api($file, $dry_run=false)
 {