adamjakab / SuiteCRM

modules/Import/ImportFieldSanitize.php

Doc Comments +1 added lines, -1 removed lines

@@ -253,7 +253,7 @@
      *
      * @param  $value  string
      * @param  $format string
-     * @return string sanitized and validated value on success, bool false on failure
+     * @return boolean sanitized and validated value on success, bool false on failure
      */
     public function isValidTimeDate(
         $value,

modules/Import/maps/ImportMap.php

Doc Comments -8 removed lines

@@ -192,13 +192,6 @@ 
     /**
      * Save
      *
-     * @param  string $owner_id
-     * @param  string $name
-     * @param  string $module
-     * @param  string $source
-     * @param  string $has_header
-     * @param  string $delimiter
-     * @param  string $enclosure
      * @return bool
      */
     public function save($check_notify = FALSE) {
@@ -362,7 +355,6 @@ 
     /**
      * set and get field elements in request field to and from user preferences
      *
-     * @param  array $fields_array
      * @return array $obj_arr
      */
     public function set_get_import_wizard_fields($ForceValsArr = '')

modules/Import/sources/ImportDataSource.php

Doc Comments -1 removed lines

@@ -107,7 +107,6 @@
      * external field name and the rvalue equal to the actual value.  
      *
      * @abstract
-     * @param  int $startIndex
      * @param  int $maxResults
      * @return void
      */

modules/Import/sources/ImportFile.php

Doc Comments +3 added lines

@@ -393,6 +393,9 @@
         return $this->_time_format;
     }
 
+    /**
+     * @param boolean $hasHeader
+     */
     public function setHeaderRow($hasHeader)
     {
         $this->_hasHeader = $hasHeader;

modules/Import/views/ImportListView.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
      * Create a list view object that can display a data source which implements the Paginatable interface.
      *
      * @throws Exception
-     * @param  Paginatable $dataSource
+     * @param  ImportFile $dataSource
      * @param  array $params
      * @param string $tableIdentifier
      */

modules/Import/views/view.confirm.php

Doc Comments +10 added lines

@@ -227,6 +227,9 @@ 
         return get_select_options_with_id($GLOBALS['app_list_strings']['import_delimeter_options'], $selctedDelim);
     }
 
+    /**
+     * @param string $enclosure
+     */
     private function getEnclosureOptions($enclosure)
     {
         $results = array();
@@ -392,6 +395,9 @@ 
         $this->ss->assign('TIMEZONEOPTIONS', TimeDate::getTimezoneList());
     }
 
+    /**
+     * @param ImportFile $importFile
+     */
     private function setImportFileCharacterSet($importFile, $field_map = array())
     {
         global $locale;
@@ -431,6 +437,9 @@ 
         return $maxColumns;
     }
 
+    /**
+     * @param ImportFile $importFile
+     */
     public function getSampleSet($importFile)
     {
         $rows = array();
@@ -456,6 +465,7 @@ 
 
     /**
      * Returns JS used in this view
+     * @param boolean $maxRecordsExceeded
      */
     private function _getJS($maxRecordsExceeded, $maxRecordsWarningMessg, $importMappingJS, $importFileMap)
     {

modules/Import/views/view.last.php

Doc Comments +5 added lines

@@ -186,6 +186,10 @@ 
 
     }
 
+    /**
+     * @param string $fileName
+     * @param string $tableName
+     */
     protected function getListViewTableFromFile($fileName, $tableName)
     {
         $has_header = $_REQUEST['has_header'] == 'on' ? TRUE : FALSE;
@@ -197,6 +201,7 @@ 
 
     /**
      * Returns JS used in this view
+     * @param integer $activeTab
      */
     private function _getJS($activeTab)
     {

modules/InboundEmail/AOPInboundEmail.php

Doc Comments +4 added lines, -1 removed lines

@@ -28,7 +28,7 @@ 
 
     /**
      * Replaces embedded image links with links to the appropriate note in the CRM.
-     * @param $string
+     * @param string $string
      * @param $noteIds A whitelist of note ids to replace
      * @return mixed
      */
@@ -53,6 +53,9 @@ 
     }
 
 
+    /**
+     * @param Email $email
+     */
     function handleCreateCase($email, $userId) {
         global $current_user, $mod_strings, $current_language;
         $mod_strings = return_module_language($current_language, "Emails");

modules/InboundEmail/InboundEmail.php

Doc Comments +67 added lines, -8 removed lines

@@ -190,7 +190,7 @@ 
 	/**
 	 * retrieves I-E bean
 	 * @param string id
-	 * @return object Bean
+	 * @return InboundEmail|null Bean
 	 */
 	function retrieve($id = -1, $encode=true, $deleted=true) {
 		$ret = parent::retrieve($id,$encode,$deleted);
@@ -453,6 +453,7 @@ 
 	/**
 	 * sets the cache timestamp
 	 * @param string mbox
+	 * @param string $mbox
 	 */
 	function setCacheTimestamp($mbox) {
 		$key = $this->db->quote("{$this->id}_{$mbox}");
@@ -486,6 +487,7 @@ 
 	/**
 	 * Returns total number of emails for a mailbox
 	 * @param string mbox
+	 * @param string $mbox
 	 * @return int
 	 */
 	function getCacheCount($mbox) {
@@ -541,6 +543,7 @@ 
 
 	/**
 	 * Retrieves cached headers
+	 * @param string|null $mbox
 	 * @return array
 	 */
 	function getCacheValueForUIDs($mbox, $UIDs) {
@@ -1726,7 +1729,6 @@ 
 	 * Deletes cached messages when moving from folder to folder
 	 * @param string $uids
 	 * @param string $fromFolder
-	 * @param string $toFolder
 	 */
 	function deleteCachedMessages($uids, $fromFolder) {
 		global $sugar_config;
@@ -2544,31 +2546,65 @@ 
 		}
 	}
 
+	/**
+	 * @param string $server_url
+	 * @param string $email_user
+	 * @param string $port
+	 */
 	function getSessionConnectionString($server_url, $email_user, $port, $protocol) {
 		$sessionConnectionString = $server_url . $email_user . $port . $protocol;
 		return (isset($_SESSION[$sessionConnectionString]) ? $_SESSION[$sessionConnectionString] : "");
 	}
 
+	/**
+	 * @param string $server_url
+	 * @param string $email_user
+	 * @param string $port
+	 * @param string $protocol
+	 */
 	function setSessionConnectionString($server_url, $email_user, $port, $protocol, $goodStr) {
 		$sessionConnectionString = $server_url . $email_user . $port . $protocol;
 		$_SESSION[$sessionConnectionString] = $goodStr;
 	}
 
+	/**
+	 * @param string $server_url
+	 * @param string $email_user
+	 * @param string $port
+	 */
 	function getSessionInboundDelimiterString($server_url, $email_user, $port, $protocol) {
 		$sessionInboundDelimiterString = $server_url . $email_user . $port . $protocol . "delimiter";
 		return (isset($_SESSION[$sessionInboundDelimiterString]) ? $_SESSION[$sessionInboundDelimiterString] : "");
 	}
 
+	/**
+	 * @param string $server_url
+	 * @param string $email_user
+	 * @param string $port
+	 * @param string $protocol
+	 */
 	function setSessionInboundDelimiterString($server_url, $email_user, $port, $protocol, $delimiter) {
 		$sessionInboundDelimiterString = $server_url . $email_user . $port . $protocol . "delimiter";
 		$_SESSION[$sessionInboundDelimiterString] = $delimiter;
 	}
 
+	/**
+	 * @param string $server_url
+	 * @param string $email_user
+	 * @param string $port
+	 * @param string $protocol
+	 */
 	function getSessionInboundFoldersString($server_url, $email_user, $port, $protocol) {
 		$sessionInboundFoldersListString = $server_url . $email_user . $port . $protocol . "foldersList";
 		return (isset($_SESSION[$sessionInboundFoldersListString]) ? $_SESSION[$sessionInboundFoldersListString] : "");
 	}
 
+	/**
+	 * @param string $server_url
+	 * @param string $email_user
+	 * @param string $port
+	 * @param string $protocol
+	 */
 	function setSessionInboundFoldersString($server_url, $email_user, $port, $protocol, $foldersList) {
 		$sessionInboundFoldersListString = $server_url . $email_user . $port . $protocol . "foldersList";
 		$_SESSION[$sessionInboundFoldersListString] = $foldersList;
@@ -2727,6 +2763,7 @@ 
 	 *
 	 * @param object email Email object passed as a reference
 	 * @param object header Header object generated by imap_headerinfo();
+	 * @param Email $email
 	 */
 	function handleMailboxType(&$email, &$header) {
 		switch($this->mailbox_type) {
@@ -2761,6 +2798,9 @@ 
 		return ($this->mailbox_type == 'createcase' && !empty($this->groupfolder_id));
 	} // fn
 
+	/**
+	 * @param Email $email
+	 */
 	function handleCreateCase($email, $userId) {
 		global $current_user, $mod_strings, $current_language;
 		$mod_strings = return_module_language($current_language, "Emails");
@@ -3002,7 +3042,8 @@ 
 	 * takes a breadcrumb and returns the encoding at that level
 	 * @param	string bc the breadcrumb string in format (1.1.1)
 	 * @param	array parts the root level parts array
-	 * @return	int retInt Int key to transfer encoding (see handleTranserEncoding())
+	 * @param string $bc
+	 * @return	string retInt Int key to transfer encoding (see handleTranserEncoding())
 	 */
 	function getEncodingFromBreadCrumb($bc, $parts) {
 		if(strstr($bc,'.')) {
@@ -3028,6 +3069,7 @@ 
 	 *
 	 * @param string bc target part of the message in format (1.1.1)
 	 * @param array parts 1 level above ROOT array of Objects representing a multipart body
+	 * @param string $bc
 	 * @return string charset name
 	 */
 	function getCharsetFromBreadCrumb($bc, $parts)
@@ -3096,6 +3138,7 @@ 
 	 *
 	 * @param int msgNo the relative message number for the monitored mailbox
 	 * @param string $type the type of text processed, either 'PLAIN' or 'HTML'
+	 * @param string $fullHeader
 	 * @return string UTF-8 encoded version of the requested message text
 	 */
 	function getMessageText($msgNo, $type, $structure, $fullHeader,$clean_email=true, $bcOffset = "") {
@@ -3254,7 +3297,7 @@ 
 	 * Builds up the "breadcrumb" trail that imap_fetchbody() uses to return
 	 * parts of an email message, including attachments and inline images
 	 * @param	$parts	array of objects
-	 * @param	$subtype	what type of trail to return? HTML? Plain? binaries?
+	 * @param	string $subtype	what type of trail to return? HTML? Plain? binaries?
 	 * @param	$breadcrumb	text trail to build up
 	 */
 	function buildBreadCrumbs($parts, $subtype, $breadcrumb = '0') {
@@ -3577,6 +3620,8 @@ 
 	 * @param string thisBc Breadcrumb to navigate email structure to find the content
 	 * @param object part IMAP standard object that contains the "parts" of this section of email
 	 * @param bool $forDisplay
+	 * @param null|Note $attach
+	 * @param integer $msgNo
 	 */
 	function saveAttachmentBinaries($attach, $msgNo, $thisBc, $part, $forDisplay) {
 		// decide where to place the file temporarily
@@ -3620,7 +3665,7 @@ 
 	/**
 	 * decodes a string based on its associated encoding
 	 * if nothing is passed, we default to no-encoding type
-	 * @param	$str	encoded string
+	 * @param	string $str	encoded string
 	 * @param	$enc	detected encoding
 	 */
 	function handleTranserEncoding($str, $enc=0) {
@@ -3666,6 +3711,7 @@ 
 	 * @param int message number (mailserver's key) of email
 	 * @param object header object generated by imap_headerinfo()
 	 * @param string textHeader Headers in normal text format
+	 * @param string $textHeader
 	 * @return bool
 	 */
 	function importDupeCheck($message_id, $header, $textHeader) {
@@ -4195,6 +4241,8 @@ 
 	 * handles UU Encoded emails - a legacy from pre-RFC 822 which must still be supported (?)
 	 * @param string raw The raw email body
 	 * @param string id Parent email ID
+	 * @param string $raw
+	 * @param string $id
 	 * @return string The filtered email body, stripped of attachments
 	 */
 	function handleUUEncodedEmailBody($raw, $id) {
@@ -4241,6 +4289,8 @@ 
 	 * wrapper for UUDecode
 	 * @param string id Id of the email
 	 * @param string UUEncode Encode US-ASCII
+	 * @param string $fileName
+	 * @param string $UUEncode
 	 */
 	function handleUUDecode($id, $fileName, $UUEncode) {
 		global $sugar_config;
@@ -4523,6 +4573,9 @@ 
         return false;
     }
 
+	/**
+	 * @param string $option_name
+	 */
 	function get_stored_options($option_name,$default_value=null,$stored_options=null) {
 		if (empty($stored_options) && isset($this)) {
 			$stored_options=$this->stored_options;
@@ -4541,6 +4594,7 @@ 
 	 * This function returns a contact or user ID if a matching email is found
 	 * @param	$email		the email address to match
 	 * @param	$table		which table to query
+	 * @param string $module
 	 */
 	function getRelatedId($email, $module) {
 		$email = trim(strtoupper($email));
@@ -4786,7 +4840,7 @@ 
      * @param  string  $password The password associated with the username
      * @param  integer $options  Bitmask for options parameter to the imap_open function
      *
-     * @return resource|boolean  Connection resource on success, FALSE on failure
+     * @return resource|null  Connection resource on success, FALSE on failure
      */
     protected function getImapConnection($mailbox, $username, $password, $options = 0)
     {
@@ -5371,6 +5425,7 @@ 
 	/**
 	 * Gets the UIDL from database for the corresponding msgno
 	 * @param int messageNo of a message
+	 * @param integer $msgNo
 	 * @return UIDL for the message
 	 */
 	function getUIDLForMessage($msgNo) {
@@ -5403,6 +5458,7 @@ 
 	 * Get the users default IE account id
 	 *
 	 * @param User $user
+	 * @param string $oe_id
 	 */
 	function setUsersDefaultOutboundServerId($user,$oe_id)
 	{
@@ -5509,6 +5565,8 @@ 
 
 	/**
 	 * Sets status for a particular attribute on the mailserver and the local cache file
+	 * @param string $field
+	 * @param integer $value
 	 */
 	function setStatuses($uid, $field, $value) {
 		global $sugar_config;
@@ -5585,6 +5643,7 @@ 
 	 * @param int uid UID of email to display
 	 * @param string mbox Mailbox to look in for the message
 	 * @param bool isMsgNo Flag to assume $uid is a MessageNo, not UniqueID, default false
+	 * @param string|null $mbox
 	 */
 	function displayOneEmail($uid, $mbox, $isMsgNo=false) {
 		require_once("include/JSON.php");
@@ -5787,7 +5846,7 @@ 
 	/**
 	 * Sorts IMAP's imap_fetch_overview() results
 	 * @param array $arr Array of standard objects
-	 * @param string $sort Column to sort by
+	 * @param integer $sort Column to sort by
 	 * @param string direction Direction to sort by (asc/desc)
 	 * @return array Sorted array of obj.
 	 */
@@ -5897,6 +5956,7 @@ 
 	 * Returns a list of emails in a mailbox.
 	 * @param string mbox Name of mailbox using dot notation paths to display
 	 * @param string $forceRefresh Flag to use cache or not
+	 * @param string $mbox
 	 */
 	function displayFolderContents($mbox, $forceRefresh='false', $page) {
 		global $current_user;
@@ -6238,7 +6298,6 @@ 
 
 	/**
 	 * sorts the folders in a mailbox in a multi-dimensional array
-	 * @param string $MBOX
 	 * @param array $ret
 	 * @return array
 	 */