EGroupware / egroupware

calendar/inc/class.calendar_rrule.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -359,7 +359,7 @@
 	/**
 	 * Return the current element
 	 *
-	 * @return DateTime
+	 * @return string
 	 */
 	public function current()
 	{

calendar/inc/class.calendar_sif.inc.php

Doc Comments +2 added lines, -6 removed lines

@@ -409,11 +409,7 @@ 
 	/**
 	* @return int event id
 	* @param string	$_sifdata   the SIFE data
-	* @param int	$_calID=-1	the internal addressbook id
-	* @param boolean $merge=false	merge data with existing entry
-	* @param int $recur_date=0 if set, import the recurrence at this timestamp,
-	*                          default 0 => import whole series (or events, if not recurring)
-	* @desc import a SIFE into the calendar
+	* @param int	$_calID	the internal addressbook id
 	*/
 	function addSIF($_sifdata, $_calID=-1, $merge=false, $recur_date=0)
 	{
@@ -797,7 +793,7 @@ 
 	* return a sife
 	*
 	* @param int	$_id		the id of the event
-	* @param int $recur_date=0	if set export the next recurrence at or after the timestamp,
+	* @param int $recur_date	if set export the next recurrence at or after the timestamp,
 	*                          	default 0 => export whole series (or events, if not recurring)
 	* @return string containing the SIFE
 	*/

calendar/inc/class.calendar_so.inc.php

Doc Comments +15 added lines, -39 removed lines

@@ -207,23 +207,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
 	 */
@@ -357,7 +345,7 @@ 
 	/**
 	 * Get full event information from an iterator of a select on egw_cal
 	 *
-	 * @param array|Iterator $rs
+	 * @param ADORecordSet $rs
 	 * @param int $recur_date =0
 	 * @return array
 	 */
@@ -571,7 +559,7 @@ 
 	 *
 	 * @param array $query filter, keys have to use 'cal_' prefix
 	 * @param string|array $cols ='cal_id,cal_reference,cal_etag,cal_modified,cal_user_modified' cols to query
-	 * @return Iterator as egw_db::select
+	 * @return ADORecordSet as egw_db::select
 	 */
 	function get_cal_data(array $query, $cols='cal_id,cal_reference,cal_etag,cal_modified,cal_user_modified')
 	{
@@ -590,7 +578,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)
@@ -678,24 +666,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
 	 */
@@ -1136,11 +1111,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)
 	 */
@@ -1308,6 +1283,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)
@@ -1718,7 +1694,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
@@ -1895,12 +1871,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)
 	{
@@ -2041,7 +2017,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
@@ -2958,7 +2934,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_ui.inc.php

Doc Comments +3 added lines

@@ -521,6 +521,9 @@
 	/**
 	* Create a select-box item in the sidebox-menu
 	* @privat used only by sidebox_menu !
+	* @param string $title
+	* @param string $name
+	* @param string $options
 	*/
 	function _select_box($title,$name,$options,$width='99%')
 	{

calendar/inc/class.calendar_uiforms.inc.php

Doc Comments +4 added lines, -4 removed lines

@@ -2202,7 +2202,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
@@ -2446,7 +2446,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
 	 */
@@ -2683,12 +2683,12 @@ 
 	/**
 	 * moves an event to another date/time
 	 *
-	 * @param string $eventId id of the event which has to be moved
+	 * @param string $_eventId id of the event which has to be moved
 	 * @param string $calendarOwner the owner of the calendar the event is in
 	 * @param string $targetDateTime the datetime where the event should be moved to, format: YYYYMMDD
 	 * @param string $targetOwner the owner of the target calendar
 	 * @param string $durationT the duration to support resizable calendar event
-	 * @return string XML response if no error occurs
+	 * @return false|null XML response if no error occurs
 	 */
 	function ajax_moveEvent($_eventId,$calendarOwner,$targetDateTime,$targetOwner,$durationT=null)
 	{

calendar/inc/class.calendar_uilist.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -48,7 +48,7 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param array $set_states=null to manualy set / change one of the states, default NULL = use $_REQUEST
+	 * @param array $set_states to manualy set / change one of the states, default NULL = use $_REQUEST
 	 */
 	function __construct($set_states=null)
 	{
@@ -542,7 +542,7 @@ 
 	 * @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'
+	 * @param string $session_name 'calendar_list'
 	 * @return 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 +10 added lines, -5 removed lines

@@ -713,6 +713,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)
 	{
@@ -741,6 +743,8 @@ 
 	 *
 	 * @param int &$first timestamp 0h of first day of week containing the first of the current year
 	 * @param int &$last timestamp 23:59:59 of last day of week containg the last day of the current year
+	 * @param integer $first
+	 * @param integer $last
 	 */
 	function _month_align_year(&$first,&$last)
 	{
@@ -1029,7 +1033,7 @@ 
 	 *
 	 * @param array/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 html with a table of open todo's or false if no hook availible
+	 * @return string html with a table of open todo's or false if no hook availible
 	 */
 	function get_todos(&$todo_label)
 	{
@@ -1580,6 +1584,7 @@ 
 	 * @param int $width width of the widget
 	 * @param string $indent string for correct indention
 	 * @param int $owner owner of the eventCol
+	 * @param double $z_index
 	 */
 	function eventColWidget($events,$left,$width,$indent,$owner,$z_index=null)
 	{
@@ -1607,7 +1612,7 @@ 
 	 * The display of the event and it's tooltip is done via the event_widget.tpl template
 	 *
 	 * @param $event array with the data of event to show
-	 * @param $width int width of the widget
+	 * @param integer $width int width of the widget
 	 * @param string $indent string for correct indention
 	 * @param int $owner owner of the calendar the event is in
 	 * @param boolean $return_array = false should an array with keys(tooltip,popup,html) be returned or the complete widget as string
@@ -1921,7 +1926,7 @@ 
 	 * - 'edit_popup' => '400x300' (optional)
 	 *
 	 * @param string $app
-	 * @param int|string $id
+	 * @param string $id
 	 * @return string
 	 */
 	function integration_get_popup($app,$id)
@@ -1963,7 +1968,7 @@ 
 	 * Icons specified in $events['icons'] are always displayed!
 	 *
 	 * @param string $app
-	 * @param int|string $id
+	 * @param string $id
 	 * @param array $event
 	 * @return array
 	 */
@@ -2072,7 +2077,7 @@ 
 	 * @param array $events events to show
 	 * @param mixed $start start-time of the grid
 	 * @param mixed $end end-time of the grid
-	 * @param string|int $by_cat rows by sub-categories of $by_cat (cat_id or 0 for upmost level) or by 'user' or 'month'
+	 * @param integer $by_cat rows by sub-categories of $by_cat (cat_id or 0 for upmost level) or by 'user' or 'month'
 	 * @param string $indent = '' string for correct indention
 	 * @return string with widget
 	 */

calendar/inc/class.soholiday.inc.php

Doc Comments +3 added lines

@@ -78,6 +78,9 @@
 		}
 	}
 
+	/**
+	 * @param ADORecordSet $rs
+	 */
 	function store_to_array(&$holidays,$rs)
 	{
 		foreach($rs as $row)

calendar/setup/tables_update.inc.php

Doc Comments +3 added lines, -1 removed lines

@@ -7,6 +7,8 @@ 
  * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
  * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
  * @version $Id$
+ * @param string $table
+ * @param string $field
  */
 
 function calendar_v0_9_2to0_9_3update_owner($table, $field)
@@ -2304,7 +2306,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()
 {