EGroupware / egroupware

emailadmin/inc/class.emailadmin_account.inc.php

Doc Comments +13 added lines, -15 removed lines

@@ -517,11 +517,9 @@ 
 	 *
 	 * Standard identity is always first (as it has account_id=0 and we order account_id ASC).
 	 *
-	 * @param int|array|emailadmin_account $account=null default this account, empty array() to get all identities of current user
-	 * @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
+	 * @param int|array|emailadmin_account $account default this account, empty array() to get all identities of current user
+	 * @param boolean $replace_placeholders should placeholders like {{n_fn}} be replaced
+	 * @return Traversable ident_id => identity_name of identity
 	 */
 	public /*static*/ function identities($account=null, $replace_placeholders=true, $field='name', $user=null)
 	{
@@ -645,7 +643,7 @@ 
 	/**
 	 * Return list of identities/signatures for given account ordered by give email on top and then by identity name
 	 *
-	 * @param int|array|emailadmin_account $account=null default this account, empty array() to get all identities of current user
+	 * @param int|array|emailadmin_account $account default this account, empty array() to get all identities of current user
 	 * @param string $order_email_top email address to order top
 	 * @return array ident_id => ident_name pairs
 	 */
@@ -674,8 +672,8 @@ 
 	 *
 	 * For full list of placeholders see addressbook_merge.
 	 *
-	 * @param array|emailadmin_account $identity=null
-	 * @param int $account_id=null account_id of user, or current user
+	 * @param array|emailadmin_account $identity
+	 * @param int $account_id account_id of user, or current user
 	 * @return array with modified fields
 	 */
 	public /*static*/ function replace_placeholders($identity=null, $account_id=null)
@@ -772,7 +770,7 @@ 
 	 *
 	 * Can be called static, if identity is given as parameter
 	 *
-	 * @param array|emailadmin_account $identity=null default standard identity of current account
+	 * @param array|emailadmin_account $identity default standard identity of current account
 	 * @return int ident_id of new/updated identity
 	 */
 	public /*static*/ function save_identity($identity=null)
@@ -833,7 +831,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)
@@ -857,8 +855,8 @@ 
 	/**
 	 * Give read access to protected parameters in $this->params
 	 *
-	 * @param type $name
-	 * @return mixed
+	 * @param string $name
+	 * @return boolean
 	 */
 	public function __isset($name)
 	{
@@ -931,7 +929,7 @@ 
 	 * Check which rights current user has on mail-account
 	 *
 	 * @param int $rights EGW_ACL_(READ|EDIT|DELETE)
-	 * @param array|emailadmin_account $account=null default use this
+	 * @param array|emailadmin_account $account default use this
 	 * @return boolean
 	 */
 	public /*static*/ function check_access($rights, $account=null)
@@ -1289,10 +1287,10 @@ 
 	 * @param boolean|string $just_name =true true: return self::identity_name, false: return emailadmin_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 emailadmin_account objects
+	 * @return Traversable with acc_id => acc_name or emailadmin_account objects
 	 */
 	public static function search($only_current_user=true, $just_name=true, $order_by=null, $offset=false, $num_rows=0, $replace_placeholders=true)
 	{

emailadmin/inc/class.emailadmin_base.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * Calls hook "imap_server_types" to allow applications to supply own server-types
 	 *
-	 * @param boolean $extended=true
+	 * @param boolean $extended
 	 * @return array classname => label pairs
 	 */
 	static public function getIMAPServerTypes($extended=true)

emailadmin/inc/class.emailadmin_credentials.inc.php

Doc Comments +1 added lines

@@ -322,6 +322,7 @@
 	 * @param int $account_id user-account password is for
 	 * @param int &$pw_enc on return encryption used
 	 * @param ressource $mcrypt =null mcrypt ressource for user, default calling self::init_crypt(true)
+	 * @param integer $pw_enc
 	 * @return string encrypted password
 	 */
 	protected static function encrypt($password, $account_id, &$pw_enc, $mcrypt=null)

emailadmin/inc/class.emailadmin_hooks.inc.php

Doc Comments -9 removed lines

@@ -20,7 +20,6 @@ 
      * Hook called to add action to user
      *
      * @param array $data
-     * @param int $data['account_id'] numerical id
      */
 	static function edit_user($data)
 	{
@@ -81,9 +80,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)
 	{
@@ -97,8 +93,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)
 	{
@@ -109,9 +103,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)
 	{

emailadmin/inc/class.emailadmin_horde_cache.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      *
      * @param string $key  Cache key to expire.
      *
-     * @return boolean  Success or failure.
+     * @return boolean|null  Success or failure.
      */
     public function expire($key)
 	{

emailadmin/inc/class.emailadmin_imap.inc.php

Doc Comments +8 added lines, -7 removed lines

@@ -132,7 +132,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
 	 */
@@ -450,7 +450,7 @@ 
 	/**
 	 * getSpecialUseFolders
 	 *
-	 * @return current mailbox, or if none check on INBOX, and return upon existance
+	 * @return string mailbox, or if none check on INBOX, and return upon existance
 	 */
 	function getCurrentMailbox()
 	{
@@ -568,7 +568,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
@@ -652,7 +652,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
@@ -720,7 +720,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
 	 *
@@ -898,6 +898,7 @@ 
 	 *
 	 * @var array $_nameSpace
 	 * @var string $_folderName
+	 * @param string $_folderName
 	 * @return string the prefix (may be an empty string)
 	 */
 	static function getFolderPrefixFromNamespace($_nameSpace, $_folderName)
@@ -916,7 +917,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)
@@ -1355,7 +1356,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

emailadmin/inc/class.emailadmin_imapbase.inc.php

Doc Comments +15 added lines, -11 removed lines

@@ -410,7 +410,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 emailadmin_imapbase (by reference)
+	 * @return emailadmin_imapbase instance of emailadmin_imapbase (by reference)
 	 */
 	public static function &forceEAProfileLoad($_profile_id)
 	{
@@ -684,7 +684,7 @@ 
 	/**
 	 * Get all identities of given mailaccount
 	 *
-	 * @param int|emailadmin_account $account account-object or acc_id
+	 * @param integer $account account-object or acc_id
 	 * @return array - array(email=>realname)
 	 */
 	function getAccountIdentities($account) {
@@ -1794,6 +1794,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)
@@ -2229,7 +2230,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 egw_exception
 	 */
 	function renameFolder($_oldFolderName, $_parent, $_folderName)
@@ -3073,7 +3074,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)
@@ -3123,7 +3124,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)
@@ -3245,7 +3246,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)
 	{
@@ -3275,7 +3276,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)
 	{
@@ -4104,7 +4105,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
@@ -4754,6 +4755,9 @@ 
 		return $message;
 	}
 
+	/**
+	 * @param integer $cols
+	 */
 	static function wordwrap($str, $cols, $cut, $dontbreaklinesstartingwith=false)
 	{
 		$lines = explode("\n", $str);
@@ -5194,7 +5198,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)
@@ -5773,6 +5776,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 emailadmin_imapbase $mailClass
 	 * @return array/bool with 'mailaddress'=>$mailaddress,
 	 *				'subject'=>$subject,
 	 *				'message'=>$message,
@@ -6226,7 +6230,7 @@ 
 	 *
 	 * @param egw_mailer $_mailObject instance of the egw_mailer/phpmailer 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_bo $mail_bo mail bo object
 	 * @return void
 	 */
 	static function processURL2InlineImages($_mailObject, &$_html2parse, $mail_bo)
@@ -6585,7 +6589,7 @@ 
 	/**
 	 * Parses a message/rfc mail from file to the mailobject
 	 *
-	 * @param object $mailer instance of the SMTP Mailer Object
+	 * @param egw_mailer $mailer instance of the SMTP Mailer Object
 	 * @param string $tmpFileName string that points/leads to the file to be imported
 	 * @throws egw_exception_not_found if $fle is not found
 	 */

emailadmin/inc/class.emailadmin_script.inc.php

Doc Comments +5 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
 	var $debug=false;
 
 	// class constructor
+
+	/**
+	 * @param string $scriptname
+	 */
 	function __construct ($scriptname) {
 		$this->name = $scriptname;
 		$this->script = '';
@@ -69,7 +73,7 @@ 
 	/**
 	 * Retrieve the rules
 	 *
-	 * @param bosieve $connection
+	 * @param emailadmin_sieve $connection
 	 * @return boolean true, if script written successfull
 	 */
 	function retrieveRules ($connection) {

emailadmin/inc/class.emailadmin_sieve.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -116,7 +116,7 @@ 
 	 *
 	 * @param emailadmin_imap $_icServer
 	 * @param string $euser effictive user, if given the Cyrus admin account is used to login on behalf of $euser
-	 * @return mixed 'die' = sieve not enabled, false=connect or login failure, true=success
+	 * @return string|boolean 'die' = sieve not enabled, false=connect or login failure, true=success
 	 */
 	function _connect(emailadmin_imap $_icServer, $euser='')
 	{
@@ -314,6 +314,7 @@ 
 	*
 	* @param string if !=null,check this one first if reported as serverMethod.
 	*                  if so, return as bestauthmethod
+	* @param string $userMethod
 	* @return mixed    Returns a string containing the name of the best
 	*                  supported authentication method or a PEAR_Error object
 	*                  if a failure condition is encountered.
@@ -606,7 +607,7 @@ 
 	 *
 	 * @param array $_emailNotification
 	 * @param string $_scriptName
-	 * @return emailadmin_script
+	 * @return boolean
 	 */
 	function setEmailNotification(array $_emailNotification, $_scriptName=null)
 	{