adamjakab / SuiteCRM

modules/AOP_Case_Updates/AOP_Case_Updates.php

Doc Comments +3 added lines

@@ -113,6 +113,9 @@
         return $ret;
     }
 
+    /**
+     * @param SugarBean $template
+     */
     public function sendEmail($emails, $template, $signature = array(), $caseId = null, $addDelimiter = true, $contactId = null){
         $GLOBALS['log']->info("AOPCaseUpdates: sendEmail called");
         require_once("include/SugarPHPMailer.php");

modules/AOS_Products_Quotes/Line_Items.php

Doc Comments +3 added lines

@@ -230,6 +230,9 @@
 //field was 0.
 //The approach below will strip off the fractional part if it is only zeroes (and in this case the decimal separator
 //will also be stripped off) The custom decimal separator is passed in to the function from the locale settings
+/**
+ * @param string $inputString
+ */
 function stripDecimalPointsAndTrailingZeroes($inputString,$decimalSeparator)
 {
     return preg_replace('/'.preg_quote($decimalSeparator).'[0]+$/','',$inputString);

modules/Campaigns/DotListWizardMenu.php

Doc Comments +6 added lines

@@ -21,6 +21,9 @@ 
 
     }
 
+    /**
+     * @param integer $i
+     */
     private function getWizardMenuItemHTML($i, $label, $link = false)
     {
         if($i>=4) {
@@ -38,6 +41,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $innerHTML
+     */
     private function getWizardMenuHTML($innerHTML)
     {
         $imgdir =  'themes/SuiteR/images/wizmenu/';

modules/Campaigns/WebToLeadFormBuilder.php

Doc Comments +29 added lines

@@ -42,6 +42,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $booleanFields
+     */
     private static function getFormFooterHTML($webFormFooter, $webFormSubmitLabel, $webFormCampaign, $webRedirectURL, $webAssignedUser, $booleanFields, $moduleDir) {
         $webFormCampaignInput = $webFormCampaign ? "<input type='hidden' id='campaign_id' name='campaign_id' value='$webFormCampaign'>" : '';
         $webRedirectURLInput = $webRedirectURL ? "<input type='hidden' id='redirect_url' name='redirect_url' value='$webRedirectURL'>" : '';
@@ -130,6 +133,9 @@ 
 
     // enums
 
+    /**
+     * @param string $fieldLabel
+     */
     private static function getFieldEnumHTML($lead, $fieldName, $appListStringsFieldOptions, $fieldRequired, $fieldLabel, $webRequiredSymbol, $colsField) {
         $html = '';
 
@@ -147,6 +153,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $leadOptions
+     */
     private static function getFieldEnumMultiSelectHTML($fieldName, $leadOptions, $fieldRequired) {
         $_required = $fieldRequired ? ' required' : '';
         $html = "<select id=\"$fieldName\" multiple=\"true\" name=\"{$fieldName}[]\" tabindex=\"1\"$_required>$leadOptions</select>";
@@ -172,6 +181,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $leadOptions
+     */
     private static function getFieldEnumSelectHTML($fieldName, $leadOptions, $fieldRequired) {
         $_required = $fieldRequired ? ' required' : '';
         $html = "<select id=\"$fieldName\" name=\"$fieldName\" tabindex=\"1\"$_required>$leadOptions</select>";
@@ -180,6 +192,9 @@ 
 
     // bool
 
+    /**
+     * @param string $fieldLabel
+     */
     private static function getFieldBoolHTML($fieldName, $fieldRequired, $fieldLabel, $webRequiredSymbol, $fieldRequired) {
         $_required = $fieldRequired ? ' required' : '';
         $html = self::getFieldLabelHTML($fieldLabel, $fieldRequired, $webRequiredSymbol);
@@ -189,6 +204,9 @@ 
 
     // date
 
+    /**
+     * @param string $fieldLabel
+     */
     private static function getFieldDateHTML($fieldName, $fieldRequired, $fieldLabel, $webRequiredSymbol) {
         $_required = $fieldRequired ? ' required' : '';
         $html = self::getFieldLabelHTML($fieldLabel, $fieldRequired, $webRequiredSymbol);
@@ -198,6 +216,9 @@ 
 
     // char strings
 
+    /**
+     * @param string $fieldLabel
+     */
     private static function getFieldCharsHTML($fieldName, $fieldLabel, $fieldRequired, $webRequiredSymbol) {
         $isRequired = $fieldName=='last_name' || $fieldRequired;
         $_required = $isRequired ? ' required' : '';
@@ -209,6 +230,10 @@ 
 
     // text
 
+    /**
+     * @param string $fieldLabel
+     * @param boolean $fieldRequired
+     */
     private static function getFieldTextHTML($fieldName, $fieldLabel, $fieldRequired, $webRequiredSymbol) {
         $_required = $fieldRequired ? ' required' : '';
         $html  = self::getFieldLabelHTML($fieldLabel, $fieldRequired, $webRequiredSymbol);
@@ -218,6 +243,10 @@ 
 
     // relate
 
+    /**
+     * @param string $fieldLabel
+     * @param boolean $fieldRequired
+     */
     private static function getFieldRelateHTML($fieldName, $fieldLabel, $fieldRequired, $webRequiredSymbol) {
         $_required = $fieldRequired ? ' required' : '';
         $html  = self::getFieldLabelHTML($fieldLabel, $fieldRequired, $webRequiredSymbol);

modules/Currencies/Currency.php

Doc Comments +7 added lines, -1 removed lines

@@ -103,7 +103,7 @@ 
      *
      * @param $amount The currency amount in US Dollars
      * @param $precision The rounding precision scale
-     * @return currency value from US Dollar conversion
+     * @return double value from US Dollar conversion
      */
 	function convertFromDollar($amount, $precision = 6){
 		return round(($amount * $this->conversion_rate), $precision);
@@ -174,6 +174,9 @@ 
 		return $list_form;
 	}
 
+	/**
+	 * @return integer
+	 */
 	function retrieve_id_by_name($name) {
 	 	$query = "select id from currencies where name='$name' and deleted=0;";
 	 	$result = $this->db->query($query);
@@ -405,6 +408,9 @@ 
 
 
 
+/**
+ * @param boolean $symbol_space
+ */
 function format_place_symbol($amount, $symbol, $symbol_space) {
 	if($symbol != '') {
 		if($symbol_space == true) {

modules/EmailTemplates/EmailTemplate.php

Doc Comments +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 
     /**
      * Generates the extended field_defs for creating macros
-     * @return array
+     * @return string
      */
     function generateFieldDefsJS()
     {
@@ -365,7 +365,7 @@ 
     /**
      *
      * Method for replace "preg_match_all" in method "parse_tracker_urls"
-     * @param $text string String in which we need to search all string that match the pattern {.}
+     * @param string $text string String in which we need to search all string that match the pattern {.}
      * @return array result of search
      */
     private function _preg_match_tracker_url($text)

modules/EmailTemplates/EmailTemplateFormBase.php

Doc Comments +4 added lines

@@ -165,6 +165,10 @@
 		$this->handleAttachmentsProcessImages($focus, $redirect, $useSiteURL, $entryPoint, $useUploadFolder);
 	}
 
+	/**
+	 * @param SugarBean $focus
+	 * @param boolean $redirect
+	 */
 	public function handleAttachmentsProcessImages($focus, $redirect, $useSiteURL = false, $entryPoint = 'download', $useUploadFolder = false) {
 		global $sugar_config;
 		$preProcessedImages = array();

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 SugarBean|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) {
@@ -1728,7 +1731,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;
@@ -2546,31 +2548,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;
@@ -2729,6 +2765,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) {
@@ -2763,6 +2800,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");
@@ -3004,7 +3044,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,'.')) {
@@ -3030,6 +3071,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)
@@ -3098,6 +3140,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 = "") {
@@ -3256,7 +3299,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') {
@@ -3579,6 +3622,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
@@ -3622,7 +3667,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) {
@@ -3668,6 +3713,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) {
@@ -4197,6 +4243,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) {
@@ -4243,6 +4291,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;
@@ -4525,6 +4575,9 @@ 
         return false;
     }
 
+	/**
+	 * @param string $option_name
+	 */
 	function get_stored_options($option_name,$default_value=null,$stored_options=null) {
 		if (empty($stored_options)) {
 			$stored_options=$this->stored_options;
@@ -4547,6 +4600,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));
@@ -4792,7 +4846,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)
     {
@@ -5377,6 +5431,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) {
@@ -5409,6 +5464,7 @@ 
 	 * Get the users default IE account id
 	 *
 	 * @param User $user
+	 * @param string $oe_id
 	 */
 	function setUsersDefaultOutboundServerId($user,$oe_id)
 	{
@@ -5515,6 +5571,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;
@@ -5591,6 +5649,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");
@@ -5793,7 +5852,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.
 	 */
@@ -5903,6 +5962,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;
@@ -6244,7 +6304,6 @@ 
 
 	/**
 	 * sorts the folders in a mailbox in a multi-dimensional array
-	 * @param string $MBOX
 	 * @param array $ret
 	 * @return array
 	 */

modules/Reminders/Reminder.php

Doc Comments +10 added lines

@@ -101,6 +101,10 @@ 
         }
     }
 
+    /**
+     * @param string $eventModule
+     * @param string $eventModuleId
+     */
     private static function saveRemindersData($eventModule, $eventModuleId, $remindersData)
     {
         $savedReminderIds = array();
@@ -426,6 +430,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $person_table
+     */
     private function upgradeEventPersonQuery(SugarBean $event, $person_table)
     {
         $eventIdField = strtolower($event->object_name) . '_id';
@@ -634,6 +641,9 @@ 
         self::removeOldReminder($eventModule, $eventModuleId);
     }
 
+    /**
+     * @param string $reminderId
+     */
     private static function migrateReminderInvitees($reminderId, $invitees)
     {
         $ret = array();