EGroupware / egroupware

api/src/Mail/Imap.php

Doc Comments +7 added lines, -6 removed lines

@@ -140,7 +140,7 @@ 
 	 * Construtor
 	 *
 	 * @param array
-	 * @param bool|int|string $_adminConnection create admin connection if true or account_id or imap username
+	 * @param boolean|string $_adminConnection create admin connection if true or account_id or imap username
 	 * @param int $_timeout =null timeout in secs, if none given fmail pref or default of 20 is used
 	 * @return void
 	 */
@@ -564,7 +564,7 @@ 
 	 * Returns an array containing the names of the selected mailboxes
 	 *
 	 * @param   string  $reference          base mailbox to start the search (default is current mailbox)
-	 * @param   string  $restriction_search false or 0 means return all mailboxes
+	 * @param   integer  $restriction_search false or 0 means return all mailboxes
 	 *                                      true or 1 return only the mailbox that contains that exact name
 	 *                                      2 return all mailboxes in that hierarchy level
 	 * @param   string  $returnAttributes   true means return an assoc array containing mailbox names and mailbox attributes
@@ -648,7 +648,7 @@ 
 	 * Returns an array containing the names of the subscribed selected mailboxes
 	 *
 	 * @param   string  $reference          base mailbox to start the search
-	 * @param   string  $restriction_search false or 0 means return all mailboxes
+	 * @param   integer  $restriction_search false or 0 means return all mailboxes
 	 *                                      true or 1 return only the mailbox that contains that exact name
 	 *                                      2 return all mailboxes in that hierarchy level
 	 * @param   string  $returnAttributes   true means return an assoc array containing mailbox names and mailbox attributes
@@ -716,7 +716,7 @@ 
 	 * Returns an array containing the names of the selected unsubscribed mailboxes
 	 *
 	 * @param   string  $reference          base mailbox to start the search
-	 * @param   string  $restriction_search false or 0 means return all mailboxes
+	 * @param   integer  $restriction_search false or 0 means return all mailboxes
 	 *                                      true or 1 return only the mailbox that contains that exact name
 	 *                                      2 return all mailboxes in that hierarchy level
 	 *
@@ -894,6 +894,7 @@ 
 	 *
 	 * @var array $_nameSpace
 	 * @var string $_folderName
+	 * @param string $_folderName
 	 * @return string the prefix (may be an empty string)
 	 */
 	static function getFolderPrefixFromNamespace($_nameSpace, $_folderName)
@@ -912,7 +913,7 @@ 
 	 * @param string $_mailbox
 	 * @param string $delimiter
 	 * @param string $prefix
-	 * @param string $reclevel = 0, counter to keep track of the current recursionlevel
+	 * @param integer $reclevel = 0, counter to keep track of the current recursionlevel
 	 * @return array of mailboxes
 	 */
 	function getMailBoxesRecursive($_mailbox, $delimiter, $prefix, $reclevel=0)
@@ -1344,7 +1345,7 @@ 
 	/**
 	 * Get vacation message for given user
 	 *
-	 * @param int|string $_euser nummeric account_id or imap username
+	 * @param string|null $_euser nummeric account_id or imap username
 	 * @param string $_scriptName =null
 	 * @throws Exception on connection error or authentication failure
 	 * @return array

api/src/Mail/Imap/Iface.php

Doc Comments +1 added lines

@@ -121,6 +121,7 @@
 	 * @param bool $_adminConnection create admin connection if true
 	 * @param int $_timeout =null timeout in secs, if none given fmail pref or default of 20 is used
 	 * @throws Exception on error
+	 * @return void
 	 */
 	function openConnection($_adminConnection=false, $_timeout=null);
 

api/src/Mail/Sieve.php

Doc Comments +2 added lines, -2 removed lines

@@ -82,7 +82,7 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param array|Imap $params =array()
+	 * @param Imap $params =array()
 	 */
 	function __construct($params=array())
 	{
@@ -165,7 +165,7 @@ 
 	 *
 	 * @param array $_emailNotification
 	 * @param string $_scriptName
-	 * @return Script
+	 * @return boolean
 	 */
 	function setEmailNotification(array $_emailNotification, $_scriptName=null)
 	{

api/src/Mail/Smtp.php

Doc Comments +1 added lines, -1 removed lines

@@ -156,7 +156,7 @@
 	/**
 	 * Get the data of a given user
 	 *
-	 * @param int|string $user numerical account-id, account-name or email address
+	 * @param integer $user numerical account-id, account-name or email address
 	 * @param boolean $match_uid_at_domain =true true: uid@domain matches, false only an email or alias address matches
 	 * @return array with values for keys 'mailLocalAddress', 'mailAlternateAddress' (array), 'mailForwardingAddress' (array),
 	 * 	'accountStatus' ("active"), 'quotaLimit' and 'deliveryMode' ("forwardOnly")

api/src/Mail/Smtp/Ldap.php

Doc Comments +1 added lines, -1 removed lines

@@ -628,7 +628,7 @@
 	 * @param int $_accountID
 	 * @param string $_forwardingAddress
 	 * @param string $_keepLocalCopy 'yes'
-	 * @return boolean true on success, false on error writing to ldap
+	 * @return boolean|null true on success, false on error writing to ldap
 	 */
 	function saveSMTPForwarding($_accountID, $_forwardingAddress, $_keepLocalCopy)
 	{

api/src/Session.php

Doc Comments +3 added lines, -2 removed lines

@@ -311,6 +311,7 @@ 
 	 * Encrypt the variables in the session
 	 *
 	 * Is called by self::__destruct().
+	 * @param string $kp3
 	 */
 	static function encrypt($kp3)
 	{
@@ -439,7 +440,7 @@ 
 	 * @param boolean $no_session =false dont create a real session, eg. for GroupDAV clients using only basic auth, no cookie support
 	 * @param boolean $auth_check =true if false, the user is loged in without checking his password (eg. for single sign on), default = true
 	 * @param boolean $fail_on_forced_password_change =false true: do NOT create session, if password change requested
-	 * @return string|boolean session id or false if session was not created, $this->(cd_)reason contains cause
+	 * @return false|string session id or false if session was not created, $this->(cd_)reason contains cause
 	 */
 	function create($login,$passwd = '',$passwd_type = '',$no_session=false,$auth_check=true,$fail_on_forced_password_change=false)
 	{
@@ -1021,7 +1022,7 @@ 
 	/**
 	 * Terminate a session
 	 *
-	 * @param int|string $sessionid nummeric or php session id of session to be terminated
+	 * @param string $sessionid nummeric or php session id of session to be terminated
 	 * @param string $kp3
 	 * @return boolean true on success, false on error
 	 */

api/src/Storage.php

Doc Comments +2 added lines, -2 removed lines

@@ -366,7 +366,7 @@ 
 	 * @param string $join ='' sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
 	 *	"LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join!
 	 * @param boolean $need_full_no_count =false If true an unlimited query is run to determine the total number of rows, default false
-	 * @param mixed $only_keys =false, see search
+	 * @param boolean $only_keys =false, see search
 	 * @param string|array $extra_cols =array()
 	 * @return int total number of rows
 	 */
@@ -734,7 +734,7 @@ 
 	 * Check if cf is stored as 1:N relation in DB and array in memory
 	 *
 	 * @param string $name
-	 * @return string
+	 * @return boolean
 	 */
 	function is_multiple($name)
 	{

api/src/Storage/History.php

Doc Comments +2 added lines

@@ -112,6 +112,8 @@
 
 	/**
 	 * Static function to add a history record
+	 * @param string $field_code
+	 * @param string $new_value
 	 */
 	public static function static_add($appname, $id, $user, $field_code, $new_value, $old_value = '')
 	{

api/src/Storage/Tracking.php

Doc Comments +1 added lines, -2 removed lines

@@ -528,7 +528,7 @@ 
 	 * @param array $data current entry
 	 * @param array $old = null old/last state of the entry or null for a new entry
 	 * @param boolean $deleted = null can be set to true to let the tracking know the item got deleted or undelted
-	 * @param array $email_notified=null if present will return the emails notified, if given emails in that list will not be notified
+	 * @param array $email_notified if present will return the emails notified, if given emails in that list will not be notified
 	 * @return boolean true on success, false on error (error messages are in $this->errors)
 	 */
 	public function do_notifications($data,$old,$deleted=null,&$email_notified=null)
@@ -824,7 +824,6 @@ 
 	 * The default implementation prefers depending on the prefer_user_as_sender class-var the user over
 	 * what is returned by get_config('sender').
 	 *
-	 * @param int $user account_lid of user
 	 * @param array $data
 	 * @param array $old
 	 * @param bool $prefer_id returns the userid rather than email