EGroupware / egroupware

api/src/Link/Storage.php

Doc Comments +6 added lines, -1 removed lines

@@ -176,6 +176,11 @@ 
 		return is_array($id) ? $links : ($links[$id] ? $links[$id] : array());
 	}
 
+	/**
+	 * @param boolean $left
+	 * @param string $only_app
+	 * @param boolean $not_only
+	 */
 	private static function _add2links($row,$left,$only_app,$not_only,array &$links)
 	{
 		$linked_app = $left ? $row['link_app2'] : $row['link_app1'];
@@ -206,7 +211,7 @@ 
 	 * @param string $id ='' id in $app, if no integer link_id given in $app_link_id
 	 * @param string $app2 ='' appname of 2. endpoint of the link, if no integer link_id given in $app_link_id
 	 * @param string $id2 ='' id in $app2, if no integer link_id given in $app_link_id
-	 * @return array with link-data or False
+	 * @return string with link-data or False
 	 */
 	static function get_link($app_link_id,$id='',$app2='',$id2='')
 	{

api/src/Mail.php

Doc Comments +17 added lines, -13 removed lines

@@ -429,7 +429,7 @@ 
 	 * forceEAProfileLoad
 	 * used to force the load of a specific emailadmin profile; we assume administrative use only (as of now)
 	 * @param int $_profile_id
-	 * @return object instance of Mail (by reference)
+	 * @return Mail instance of Mail (by reference)
 	 */
 	public static function &forceEAProfileLoad($_profile_id)
 	{
@@ -704,7 +704,7 @@ 
 	/**
 	 * Get all identities of given mailaccount
 	 *
-	 * @param int|Mail\Account $account account-object or acc_id
+	 * @param integer $account account-object or acc_id
 	 * @return array - array(email=>realname)
 	 */
 	function getAccountIdentities($account)
@@ -1289,7 +1289,7 @@ 
 	 * @param array $_filter filter to apply to getSortedList
 	 * @param mixed $_thisUIDOnly = null, if given fetch the headers of this uid only (either one, or array of uids)
 	 * @param boolean $_cacheResult = true try touse the cache of getSortedList
-	 * @param mixed $_fetchPreviews = false (boolean/int) fetch part of the body of the messages requested (if integer the number is assumed to be the number of chars to be returned for preview; if set to true 300 chars are returned (when available))
+	 * @param boolean $_fetchPreviews = false (boolean/int) fetch part of the body of the messages requested (if integer the number is assumed to be the number of chars to be returned for preview; if set to true 300 chars are returned (when available))
 	 * @return array result as array(header=>array,total=>int,first=>int,last=>int)
 	 */
 	function getHeaders($_folderName, $_startMessage, $_numberOfMessages, $_sort, $_reverse, $_filter, $_thisUIDOnly=null, $_cacheResult=true, $_fetchPreviews=false)
@@ -1866,6 +1866,7 @@ 
 	 *
 	 * @param mixed _sort the integer sort order / or a valid and handeled SORTSTRING (right now: UID/ARRIVAL/INTERNALDATE (->ARRIVAL))
 	 * @param bool _reverse wether to add REVERSE to the Sort String or not
+	 * @param integer $_sort
 	 * @return the sort sequence for horde search
 	 */
 	function _getSortString($_sort, $_reverse=false)
@@ -2375,7 +2376,7 @@ 
 	 * @param string _parent the parent foldername
 	 * @param string _folderName the new foldername
 	 *
-	 * @return mixed name of the newly created folder or false on error
+	 * @return string name of the newly created folder or false on error
 	 * @throws Exception
 	 */
 	function renameFolder($_oldFolderName, $_parent, $_folderName)
@@ -3247,7 +3248,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)
@@ -3297,7 +3298,7 @@ 
 	 * abstraction layer for getDraftFolder, getTemplateFolder, getTrashFolder and getSentFolder
 	 * @param string $_type the type to fetch (Drafts|Template|Trash|Sent)
 	 * @param boolean $_checkexistance trigger check for existance
-	 * @param boolean& $created =null on return true: if folder was just created, false if not
+	 * @param boolean $created =null on return true: if folder was just created, false if not
 	 * @return mixed string or false
 	 */
 	function _getSpecialUseFolder($_type, $_checkexistance=TRUE, &$created=null)
@@ -3429,7 +3430,7 @@ 
 	/**
 	 * getTemplateFolder wrapper for _getSpecialUseFolder Type Template
 	 * @param boolean $_checkexistance trigger check for existance
-	 * @return mixed string or false
+	 * @return string string or false
 	 */
 	function getTemplateFolder($_checkexistance=TRUE)
 	{
@@ -3459,7 +3460,7 @@ 
 	/**
 	 * getOutboxFolder wrapper for _getSpecialUseFolder Type Outbox
 	 * @param boolean $_checkexistance trigger check for existance
-	 * @return mixed string or false
+	 * @return string string or false
 	 */
 	function getOutboxFolder($_checkexistance=TRUE)
 	{
@@ -4298,7 +4299,7 @@ 
 	/**
 	 * get part of the message, if its stucture is indicating its of multipart alternative style
 	 * a wrapper for multipartmixed
-	 * @param string/int $_uid the messageuid,
+	 * @param integer $_uid the messageuid,
 	 * @param Horde_Mime_Part $_structure structure for parsing
 	 * @param string $_htmlMode how to display a message, html, plain text, ...
 	 * @param boolean $_preserveSeen flag to preserve the seenflag by using body.peek
@@ -4948,6 +4949,9 @@ 
 		return $message;
 	}
 
+	/**
+	 * @param integer $cols
+	 */
 	static function wordwrap($str, $cols, $cut, $dontbreaklinesstartingwith=false)
 	{
 		$lines = explode("\n", $str);
@@ -5396,7 +5400,6 @@ 
 	 * @param string $_partID = null
 	 * @param string $_folder = null
 	 * @param boolean $_preserveSeen = false flag to preserve the seenflag by using body.peek
-	 * @param Horde_Imap_Client_Fetch_Query $fquery=null default query just structure
 	 * @return Horde_Mime_Part
 	 */
 	function getStructure($_uid, $_partID=null, $_folder=null, $_preserveSeen=false)
@@ -5987,6 +5990,7 @@ 
 	 * @param preserveHTML flag to pass through to getdisplayableBody
 	 * @param addHeaderSection flag to be able to supress headersection
 	 * @param includeAttachments flag to be able to supress possible attachments
+	 * @param Mail $mailClass
 	 * @return array/bool with 'mailaddress'=>$mailaddress,
 	 *				'subject'=>$subject,
 	 *				'message'=>$message,
@@ -6440,7 +6444,7 @@ 
 	 *
 	 * @param Mailer $_mailObject instance of the Mailer Object to be used
 	 * @param string $_html2parse the html to parse and to be altered, if conditions meet
-	 * @param $mail_bo mail bo object
+	 * @param Mail $mail_bo mail bo object
 	 * @return void
 	 */
 	static function processURL2InlineImages(Mailer $_mailObject, &$_html2parse, $mail_bo)
@@ -6556,7 +6560,7 @@ 
 	 * @param Storage\Merge Storage\Merge bo_merge object
 	 * @param string $document the full filename
 	 * @param array $SendAndMergeTocontacts array of contact ids
-	 * @param string& $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if
+	 * @param string|null $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if
 	 *					folder is modified
 	 * @param string& $importID ID for the imported message, used by attachments to identify them unambiguously
 	 * @return mixed array of messages with success and failed messages or exception
@@ -6800,7 +6804,7 @@ 
 	/**
 	 * Parses a message/rfc mail from file to the mailobject
 	 *
-	 * @param object $mailer instance of the SMTP Mailer Object
+	 * @param Mailer $mailer instance of the SMTP Mailer Object
 	 * @param string $tmpFileName string that points/leads to the file to be imported
 	 * @throws Exception\NotFound if $fle is not found
 	 */

api/src/Mail/Account.php

Doc Comments +6 added lines, -6 removed lines

@@ -486,7 +486,7 @@ 
 	 * @param boolean $replace_placeholders =false should placeholders like {{n_fn}} be replaced
 	 * @param string $field ='name' what to return as value: "ident_(realname|org|email|signature)" or default "name"=result from identity_name
 	 * @param int $user =null account_id to use if not current user
-	 * @return Iterator ident_id => identity_name of identity
+	 * @return Api\Db\CallbackIterator ident_id => identity_name of identity
 	 */
 	public static function identities($account, $replace_placeholders=true, $field='name', $user=null)
 	{
@@ -795,7 +795,7 @@ 
 	 *
 	 * To get $this->params you need to call getUserData before! It is never automatically loaded.
 	 *
-	 * @param type $name
+	 * @param string $name
 	 * @return mixed
 	 */
 	public function __get($name)
@@ -819,8 +819,8 @@ 
 	/**
 	 * Give read access to protected parameters in $this->params
 	 *
-	 * @param type $name
-	 * @return mixed
+	 * @param string $name
+	 * @return boolean
 	 */
 	public function __isset($name)
 	{
@@ -1340,10 +1340,10 @@ 
 	 * @param boolean|string $just_name =true true: return self::identity_name, false: return Account objects,
 	 *	string with attribute-name: return that attribute, eg. acc_imap_host or 'params' to return all attributes as array
 	 * @param string $order_by ='acc_name ASC'
-	 * @param int|boolean $offset =false offset or false to return all
+	 * @param boolean $offset =false offset or false to return all
 	 * @param int $num_rows =0 number of rows to return, 0=default from prefs (if $offset !== false)
 	 * @param boolean $replace_placeholders =true should placeholders like {{n_fn}} be replaced
-	 * @return Iterator with acc_id => acc_name or Account objects
+	 * @return Api\Db\CallbackIterator with acc_id => acc_name or Account objects
 	 */
 	public static function search($only_current_user=true, $just_name=true, $order_by=null, $offset=false, $num_rows=0, $replace_placeholders=true)
 	{

api/src/Mail/Hooks.php

Doc Comments -8 removed lines

@@ -36,9 +36,6 @@ 
      * Hook called before an account get deleted
      *
      * @param array $data
-     * @param int $data['account_id'] numerical id
-     * @param string $data['account_lid'] account-name
-     * @param int $data['new_owner'] account-id of new owner, or false if data should get deleted
      */
 	static function deleteaccount(array $data)
 	{
@@ -52,8 +49,6 @@ 
      * Hook called before a group get deleted
      *
      * @param array $data
-     * @param int $data['account_id'] numerical id
-     * @param string $data['account_name'] account-name
      */
 	static function deletegroup(array $data)
 	{
@@ -64,9 +59,6 @@ 
      * Hook called when an account get added or edited
      *
      * @param array $data
-     * @param int $data['account_id'] numerical id
-     * @param string $data['account_lid'] account-name
-     * @param string $data['account_email'] email
 	 */
 	static function addaccount(array $data)
 	{

api/src/Mail/Html.php

Doc Comments +1 added lines, -1 removed lines

@@ -227,7 +227,7 @@
 	 * @param string $displayCharset : charset to use; should be a valid charset
 	 * @param bool $stripcrl :  flag to indicate for the removal of all crlf \r\n
 	 * @param bool $stripalltags : flag to indicate wether or not to strip $_html from all remaining tags
-	 * @return text $_html : the modified text.
+	 * @return string $_html : the modified text.
 	 */
 	static function convertHTMLToText($_html,$displayCharset=false,$stripcrl=false,$stripalltags=true)
 	{

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")