EGroupware / egroupware

api/src/Preferences.php

Doc Comments +1 added lines, -1 removed lines

@@ -961,7 +961,7 @@
 	 *
 	 * This method uses the language and nationalty set in the users common prefs.
 	 *
-	 * @param $category =LC_MESSAGES category to set, see setlocal function
+	 * @param integer $category =LC_MESSAGES category to set, see setlocal function
 	 * @param $charset =null default system charset
 	 * @return string the local (or best estimate) set
 	 */

api/src/Auth/Sql.php

Doc Comments -1 removed lines

@@ -241,7 +241,6 @@
 	 * changes password in sql datababse
 	 *
 	 * @param string $encrypted_passwd
-	 * @param string $new_passwd cleartext
 	 * @param int $account_id account id of user whose passwd should be changed
 	 * @param boolean $admin =false called by admin, if not update password in the session
 	 * @param boolean $update_lastpw_change =true

api/src/Accounts/Ads.php

Doc Comments +8 added lines, -8 removed lines

@@ -129,7 +129,7 @@ 
 	/**
 	 * Factory method and singelton to get adLDAP object for given configuration or default server config
 	 *
-	 * @param array $config=null values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection'
+	 * @param array $config values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection'
 	 * @return adLDAP
 	 * @throws adLDAPException
 	 */
@@ -308,7 +308,7 @@ 
 	 * Convert binary GUID to string
 	 *
 	 * @param string $objectguid
-	 * @return int
+	 * @return string
 	 */
 	public function objectguid2str($objectguid)
 	{
@@ -319,7 +319,7 @@ 
 	 * Convert a string GUID to hex string used in filter
 	 *
 	 * @param string $strGUID
-	 * @return int
+	 * @return string
 	 */
 	public function objectguid2hex($strGUID)
 	{
@@ -378,7 +378,7 @@ 
 	 * Delete one account, deletes also all acl-entries for that account
 	 *
 	 * @param int $account_id numeric account_id
-	 * @return boolean true on success, false otherwise
+	 * @return string|boolean true on success, false otherwise
 	 */
 	function delete($account_id)
 	{
@@ -1138,7 +1138,7 @@ 
 	 *
 	 * @param int $_account_id
 	 * @param string $ip
-	 * @return int lastlogin time
+	 * @return boolean lastlogin time
 	 */
 	function update_lastlogin($_account_id, $ip)
 	{
@@ -1335,7 +1335,7 @@ 
 	 * - activate user
 	 *
 	 * @param array $attributes The attributes to set to the user account
-	 * @return bool
+	 * @return string|boolean
 	 */
 	public function create($attributes)
 	{
@@ -1525,7 +1525,7 @@ 
     * @param string $username The username to query
     * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function modify($username, $attributes, $isGUID = false)
     {
@@ -1590,7 +1590,7 @@ 
 	 * Extended to allow to specify $attribute["container"] as string, because array hardcodes "OU=", while Samba4 and win2008r2 uses "CN=Users"
 	 *
 	 * @param array $attributes Default attributes of the group
-	 * @return bool
+	 * @return string|boolean
 	 */
 	public function create($attributes)
 	{

api/src/CalDAV.php

Doc Comments +9 added lines, -7 removed lines

@@ -311,6 +311,8 @@ 
 	 * @param string $path
 	 * @param array &$dav
 	 * @param array &$allow
+	 * @param integer[] $dav
+	 * @param boolean $allow
 	 */
 	function OPTIONS($path, &$dav, &$allow)
 	{
@@ -1380,7 +1382,7 @@ 
 	 * @param int|string $id
 	 * @param array $attach array of array with values for keys 'name', 'params', 'value'
 	 * @param boolean $delete_via_put
-	 * @return boolean false on error, eg. invalid managed id, for false an xml-error body has been send
+	 * @return null|false false on error, eg. invalid managed id, for false an xml-error body has been send
 	 */
 	public static function handle_attach($app, $id, $attach, $delete_via_put=false)
 	{
@@ -1584,7 +1586,7 @@ 
 	 * @param string $managed_id
 	 * @param string $app =null app-name to check against path
 	 * @param string|int $id =null id to check agains path
-	 * @return string|boolean "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id
+	 * @return false|string "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id
 	 */
 	static public function managed_id2path($managed_id, $app=null, $id=null)
 	{
@@ -1783,7 +1785,7 @@ 
 	 * MKCOL method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MKCOL($options)
 	{
@@ -1796,7 +1798,7 @@ 
 	 * MOVE method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MOVE($options)
 	{
@@ -1809,7 +1811,7 @@ 
 	 * COPY method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function COPY($options, $del=false)
 	{
@@ -1822,7 +1824,7 @@ 
 	 * LOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string|boolean   true on success
 	 */
 	function LOCK(&$options)
 	{
@@ -1856,7 +1858,7 @@ 
 	 * UNLOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function UNLOCK(&$options)
 	{

api/src/Contacts.php

Doc Comments +7 added lines, -5 removed lines

@@ -484,7 +484,6 @@ 
 	/**
 	 * get selectbox options for the customfields
 	 *
-	 * @param array $field =null
 	 * @return array with options:
 	 */
 	public static function cf_options()
@@ -536,7 +535,7 @@ 
 	 * @param string $fileas_type '' or type of $this->fileas_types
 	 * @param int $all =false update all contacts or only ones with empty values
 	 * @param int &$errors=null on return number of errors
-	 * @return int|boolean number of contacts updated, false for wrong fileas type
+	 * @return string|null number of contacts updated, false for wrong fileas type
 	 */
 	function set_all_fileas($fileas_type,$all=false,&$errors=null,$ignore_acl=false)
 	{
@@ -597,7 +596,7 @@ 
 	 * remove unneeded carriage returns or set empty fields to NULL
 	 *
 	 * @param int &$errors=null on return number of errors
-	 * @return int|boolean number of contacts updated
+	 * @return string|null number of contacts updated
 	 */
 	function set_all_cleanup(&$errors=null,$ignore_acl=false)
 	{
@@ -1122,7 +1121,7 @@ 
 	 * @param mixed $contact contact as array or the contact-id
 	 * @param boolean $deny_account_delete =false if true never allow to delete accounts
 	 * @param int $user =null for which user to check, default current user
-	 * @return boolean true permission granted, false for permission denied, null for contact does not exist
+	 * @return null|boolean true permission granted, false for permission denied, null for contact does not exist
 	 */
 	function check_perms($needed,$contact,$deny_account_delete=false,$user=null)
 	{
@@ -1179,7 +1178,7 @@ 
 	 * @param int $check Acl::READ for read and Acl::EDIT for write or delete access
 	 * @param string $rel_path =null currently not used in InfoLog
 	 * @param int $user =null for which user to check, default current user
-	 * @return boolean true if access is granted or false otherwise
+	 * @return null|boolean true if access is granted or false otherwise
 	 */
 	function file_access($id,$check,$rel_path=null,$user=null)
 	{
@@ -2094,6 +2093,9 @@ 
 		return $cat_id_list;
 	}
 
+	/**
+	 * @param string $cat_id_list
+	 */
 	function get_categories($cat_id_list)
 	{
 		if (!is_object($this->categories))

calendar/inc/class.calendar_bo.inc.php

Doc Comments +7 added lines, -12 removed lines

@@ -632,8 +632,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)
 	{
@@ -762,7 +762,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)
 	{
@@ -982,10 +982,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)
 	{
@@ -1139,7 +1138,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
@@ -1312,8 +1311,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)
 	{
@@ -1378,7 +1375,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
@@ -1847,7 +1844,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)
@@ -2036,6 +2032,7 @@ 
 	 *
 	 * @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!)
+	 * @param string $schedule_tag
 	 * @return string|boolean string with etag or false
 	 */
 	function get_etag($entry, &$schedule_tag=null)
@@ -2076,7 +2073,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)
@@ -2128,7 +2124,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_groupdav.inc.php

Doc Comments +9 added lines, -9 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)
 	{
@@ -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_zpush.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -282,7 +282,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)
@@ -900,7 +900,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)
 	{
@@ -1596,6 +1596,7 @@ 
 	 * Unpack timezone info from Sync
 	 *
 	 * copied from backend/ics.php
+	 * @param string $data
 	 */
 	static public function _getTZFromSyncBlob($data)
 	{

api/src/Mail/Credentials.php

Doc Comments +2 added lines, -3 removed lines

@@ -363,7 +363,7 @@ 
 	 *
 	 * @param string $password cleartext password
 	 * @param int $account_id user-account password is for
-	 * @param int& $pw_enc on return encryption used
+	 * @param integer $pw_enc on return encryption used
 	 * @return string encrypted password
 	 */
 	protected static function encrypt($password, $account_id, &$pw_enc)
@@ -436,7 +436,7 @@ 
 	 * With a 12 byte binary (16 byte base64) salt we can store 39 byte password in our varchar(80) column.
 	 *
 	 * @param string $password
-	 * @param string& $salt binary salt to use or null to generate one, on return used salt
+	 * @param string|null $salt binary salt to use or null to generate one, on return used salt
 	 * @param int $iterations =2048 iterations of passsword
 	 * @param int $length =16 length of binary aes key
 	 * @param string $hash ='sha256'
@@ -614,7 +614,6 @@ 
 	 *
 	 * @param array $row database row
 	 * @param string $key =null password to use
-	 * @param string $salt_len =16 len of base64 encoded salt (binary is 3/4)
 	 * @return string cleartext password
 	 * @throws Api\Exception\WrongParameter
 	 * @throws Api\Exception\AssertionFailed if OpenSSL extension not available