adamjakab / SuiteCRM

include/SugarFields/Parsers/MetaParser.php

Braces +6 added lines, -3 removed lines

@@ -1,5 +1,7 @@ 
 <?php
-if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
+if(!defined('sugarEntry') || !sugarEntry) {
+    die('Not A Valid Entry Point');
+}
 /*********************************************************************************
  * SugarCRM Community Edition is a customer relationship management program developed by
  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
@@ -456,8 +458,9 @@ 
     while ($file = readdir($handler)) {
         // if $file isn't this directory or its parent,
         // add it to the results array
-        if ($file != '.' && $file != '..')
-            $results[] = $file;
+        if ($file != '.' && $file != '..') {
+                    $results[] = $file;
+        }
     }
 
     // tidy up: close the handler

Doc Comments +23 added lines, -7 removed lines

@@ -96,7 +96,7 @@ 
 /**
  * getFormElementsNames
  * Parses for the name values of input, select, textarea types from string content
- * @param $contents The String contents to parse
+ * @param string $contents The String contents to parse
  * @return $matches Array of name/value pairs
  */
 function getFormElementsNames($contents) {
@@ -108,7 +108,7 @@ 
 /**
  * getTagAttribute
  * Returns the name/value of a tag attribute where name is set to $name
- * @param $name The name of the attribute
+ * @param string $name The name of the attribute
  * @param $contents The contents to parse
  * @param $filter Option regular expression to filter value
  * @return Array of name/value for matching attribute
@@ -163,7 +163,7 @@ 
  * and method call getElementsByType("<td>", $contents) returns
  * "<td>Text <table><tr><td>a</td></tr></table></td>"
  *
- * @param $type The type of element to parse out and return
+ * @param string $type The type of element to parse out and return
  * @return a tag element format Array
  */
 function getElementsByType($type, $contents) {
@@ -208,6 +208,7 @@ 
 /**
  * getElementValue
  *
+ * @param string $type
  */
 function getElementValue($type, $contents, $filter = "(.*?)") {
    $exp = "'<".$type."[^>]*?>".$filter."</".$type."[^>]*?>'si";
@@ -244,7 +245,7 @@ 
  * Returns the highest number of <td>...</td> blocks within a <tr>...</tr> block.
  * @param $contents The table contents to parse
  * @param $filter Optional filter to parse for an attribute within the td block.
- * @return The maximum column count
+ * @return integer maximum column count
  */
 function getMaxColumns($contents, $filter) {
    preg_match_all("'(<tr[^>]*?>)(.*?)(</tr[^>]*?>)'si", $contents, $matches, PREG_SET_ORDER);
@@ -281,6 +282,9 @@ 
  * trimHTML
  * This function removes the \r (return), \n (newline) and \t (tab) markup from string
  */
+/**
+ * @param string $contents
+ */
 function trimHTML($contents) {
    $contents = str_replace(array("\r"), array(""), $contents);
    $contents = str_replace(array("\n"), array(""), $contents);
@@ -342,6 +346,9 @@ 
 
 }
 
+/**
+ * @param string $javascript
+ */
 static function parseDelimiters($javascript) {
 	$newJavascript = '';
 	$scriptLength = strlen($javascript);
@@ -441,7 +448,7 @@ 
  * dirList
  * Utility method to list all the files in a given directory.
  *
- * @param $directory The directory to scan
+ * @param string $directory The directory to scan
  * @return $results The files in the directory that were found
  */
 function dirList ($directory) {
@@ -496,6 +503,9 @@ 
    return null;
 }
 
+/**
+ * @param string $moduleDir
+ */
 function applyPreRules($moduleDir, $panels) {
    if(file_exists("include/SugarFields/Parsers/Rules/".$moduleDir."ParseRule.php")) {
 	  require_once("include/SugarFields/Parsers/Rules/".$moduleDir."ParseRule.php");
@@ -506,6 +516,9 @@ 
    return $panels;
 }
 
+/**
+ * @param string $moduleDir
+ */
 function applyRules($moduleDir, $panels) {
    return $this->applyPostRules($moduleDir, $panels);
 }
@@ -537,6 +550,9 @@ 
    return $panels;
 }
 
+/**
+ * @param string $moduleDir
+ */
 function createFileContents($moduleDir, $panels, $templateMeta=array(), $htmlFilePath) {
 
 $header = "<?php\n\n";
@@ -587,7 +603,7 @@ 
  * mergePanels
  * This function merges the $panels Array against the $masterCopy's meta data definition
  * @param $panels meta data Array to merge
- * @param $moduleDir Directory name of the module
+ * @param string $moduleDir Directory name of the module
  * @param $masterCopy file path to the meta data master copy
  * @return Array of merged $panel definition
  */
@@ -680,7 +696,7 @@ 
  * mergeTemplateMeta
  * This function merges the $templateMeta Array against the $masterCopy's meta data definition
  * @param $templateMeta meta data Array to merge
- * @param $moduleDir Directory name of the module
+ * @param string $moduleDir Directory name of the module
  * @param $masterCopy file path to the meta data master copy
  * @return Array of merged $templateMeta definition
  */

include/SugarFields/SugarFieldHandler.php

Braces +3 added lines, -3 removed lines

@@ -91,10 +91,10 @@ 
         		$file = 'custom/include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php';
                 $type = $field;
 			//else check the fields directory
-			}else if(file_exists('include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php')){
+			} else if(file_exists('include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php')){
            		$file = 'include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php';
                 $type = $field;
-        	}else{
+        	} else{
                 // No direct class, check the directories to see if they are defined
         		if( $returnNullIfBase &&
                     !is_dir('custom/include/SugarFields/Fields/'.$field) &&
@@ -111,7 +111,7 @@ 
 			$customClass = 'Custom' . $class;
         	if(class_exists($customClass)){
         		$sugarFieldObjects[$field] = new $customClass($field);
-        	}else{
+        	} else{
         		$sugarFieldObjects[$field] = new $class($field);
         	}
         }

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
     function SugarFieldHandler() {
     }
 
+    /**
+     * @param string $field
+     */
     static function fixupFieldType($field) {
             switch($field) {
                case 'double':

include/SugarFields/Fields/Assigned_user_name/SugarFieldAssigned_user_name.php

Braces +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 		if(!empty($vardef['function']['returns']) && $vardef['function']['returns']== 'html'){
     	   $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
            return $this->fetch($this->findTemplate('EditViewFunction'));
-    	}else{
+    	} else{
     	   $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
            return $this->fetch($this->findTemplate('SearchView'));
     	}

include/SugarEmailAddress/SugarEmailAddress.php

Braces +39 added lines, -26 removed lines

@@ -1,5 +1,7 @@ 
 <?php
-if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
+if(!defined('sugarEntry') || !sugarEntry) {
+    die('Not A Valid Entry Point');
+}
 /*********************************************************************************
  * SugarCRM Community Edition is a customer relationship management program developed by
  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
@@ -132,8 +134,9 @@ 
         $alternate_found = false;
         $alternate2_found = false;
         foreach($this->addresses as $k=>$address) {
-            if ($primary_found && $alternate_found)
-                break;
+            if ($primary_found && $alternate_found) {
+                            break;
+            }
             if ($address['primary_address'] == 1 && !$primary_found) {
                 $primary_index = $k;
                 $primary_found = true;
@@ -271,8 +274,9 @@ 
         )
     {
         $emailCaps = strtoupper(trim($email));
-        if(empty($emailCaps))
-            return 0;
+        if(empty($emailCaps)) {
+                    return 0;
+        }
 
         $q = "SELECT *
                 FROM email_addr_bean_rel eabl JOIN email_addresses ea
@@ -288,7 +292,9 @@ 
 
         // do it this way to make the count accurate in oracle
         $i = 0;
-        while ($this->db->fetchByAssoc($r)) ++$i;
+        while ($this->db->fetchByAssoc($r)) {
+            ++$i;
+        }
 
         return $i;
     }
@@ -471,8 +477,9 @@ 
                     foreach($_REQUEST as $k => $v) {
                         if(preg_match('/'.$eId.'emailAddressVerifiedValue[0-9]+$/i', $k) && !empty($v)) {
                             $validateFlag = str_replace("Value", "Flag", $k);
-                            if (isset($_REQUEST[$validateFlag]) && $_REQUEST[$validateFlag] == "true")
-                              $new_addrs[$k] = $v;
+                            if (isset($_REQUEST[$validateFlag]) && $_REQUEST[$validateFlag] == "true") {
+                                                          $new_addrs[$k] = $v;
+                            }
                         }
                     }
                 }
@@ -675,8 +682,7 @@ 
         if ($id) {
             $r = $this->db->query("SELECT * FROM email_addresses WHERE id='".$this->db->quote($id)."'");
             $current_email = $this->db->fetchByAssoc($r);
-        }
-        else {
+        } else {
             $current_email = null;
         }
 
@@ -716,8 +722,7 @@ 
                 $upd_r = $this->db->query($upd_q);
             }
             return $duplicate_email['id'];
-        }
-        else {
+        } else {
             // no case-insensitive address match - it's new, or undeleted.
             $guid = '';
             if(!empty($address)){
@@ -783,8 +788,7 @@ 
             // otherwise
             $q .= "
                 ORDER BY ear.reply_to_address DESC";
-        }
-        else
+        } else
         {
             // retrieve reply-to address only
             $q .= "
@@ -835,8 +839,9 @@ 
      */
     function getEmailAddressWidgetEditView($id, $module, $asMetadata=false, $tpl='',$tabindex='0')
     {
-        if ( !($this->smarty instanceOf Sugar_Smarty ) )
-            $this->smarty = new Sugar_Smarty();
+        if ( !($this->smarty instanceOf Sugar_Smarty ) ) {
+                    $this->smarty = new Sugar_Smarty();
+        }
 
         global $app_strings, $dictionary, $beanList;
 
@@ -854,8 +859,9 @@ 
         if(!empty($id)) {
             $prefillDataArr = $this->getAddressesByGUID($id, $module);
             //When coming from convert leads, sometimes module is Contacts while the id is for a lead.
-            if (empty($prefillDataArr) && $module == "Contacts")
-                $prefillDataArr = $this->getAddressesByGUID($id, "Leads");
+            if (empty($prefillDataArr) && $module == "Contacts") {
+                            $prefillDataArr = $this->getAddressesByGUID($id, "Leads");
+            }
         } else if(isset($_REQUEST['full_form']) && !empty($_REQUEST['emailAddressWidget'])){
             $widget_id = isset($_REQUEST[$module . '_email_widget_id']) ? $_REQUEST[$module . '_email_widget_id'] : '0';
             $count = 0;
@@ -880,8 +886,9 @@ 
 
         $required = false;
         $vardefs = $dictionary[$beanList[$passedModule]]['fields'];
-        if (!empty($vardefs['email1']) && isset($vardefs['email1']['required']) && $vardefs['email1']['required'])
-            $required = true;
+        if (!empty($vardefs['email1']) && isset($vardefs['email1']['required']) && $vardefs['email1']['required']) {
+                    $required = true;
+        }
         $this->smarty->assign('required', $required);
 
         $this->smarty->assign('module', $saveModule);
@@ -935,13 +942,16 @@ 
      */
     function getEmailAddressWidgetDetailView($focus, $tpl='')
     {
-        if ( !($this->smarty instanceOf Sugar_Smarty ) )
-            $this->smarty = new Sugar_Smarty();
+        if ( !($this->smarty instanceOf Sugar_Smarty ) ) {
+                    $this->smarty = new Sugar_Smarty();
+        }
 
         global $app_strings;
         global $current_user;
         $assign = array();
-        if(empty($focus->id))return '';
+        if(empty($focus->id)) {
+            return '';
+        }
         $prefillData = $this->getAddressesByGUID($focus->id, $focus->module_dir);
 
         foreach($prefillData as $addressItem) {
@@ -970,8 +980,9 @@ 
      */
     function getEmailAddressWidgetDuplicatesView($focus)
     {
-        if ( !($this->smarty instanceOf Sugar_Smarty ) )
-            $this->smarty = new Sugar_Smarty();
+        if ( !($this->smarty instanceOf Sugar_Smarty ) ) {
+                    $this->smarty = new Sugar_Smarty();
+        }
 
         $count = 0;
         $emails = array();
@@ -1131,7 +1142,9 @@ 
 
         if($view == 'EditView' || $view == 'QuickCreate' || $view == 'ConvertLead') {
             $module = $focus->module_dir;
-            if ($view == 'ConvertLead' && $module == "Contacts")  $module = "Leads";
+            if ($view == 'ConvertLead' && $module == "Contacts") {
+                $module = "Leads";
+            }
 
             return $sea->getEmailAddressWidgetEditView($focus->id, $module, false,'',$tabindex);
         }

Doc Comments +10 added lines, -16 removed lines

@@ -80,8 +80,6 @@ 
 
     /**
      * Legacy email address handling.  This is to allow support for SOAP or customizations
-     * @param string $id
-     * @param string $module
      */
     function handleLegacySave($bean, $prefix = "") {
         if(!isset($_REQUEST) || !isset($_REQUEST['useEmailWidget'])) {
@@ -166,12 +164,6 @@ 
 
     /**
      * Saves email addresses for a parent bean
-     * @param string $id Parent bean ID
-     * @param string $module Parent bean's module
-     * @param array $addresses Override of $_REQUEST vars, used to handle non-standard bean saves
-     * @param string $primary GUID of primary address
-     * @param string $replyTo GUID of reply-to address
-     * @param string $invalid GUID of invalid address
      */
     public function save($check_notify = FALSE) {
         $args = func_get_args();
@@ -369,7 +361,6 @@ 
      * Saves email addresses for a parent bean
      * @param string $id Parent bean ID
      * @param string $module Parent bean's module
-     * @param array $addresses Override of $_REQUEST vars, used to handle non-standard bean saves
      * @param string $primary GUID of primary address
      * @param string $replyTo GUID of reply-to address
      * @param string $invalid GUID of invalid address
@@ -620,7 +611,7 @@ 
 
     /**
      * preps a passed email address for email address storage
-     * @param array $addr Address in focus, must be RFC compliant
+     * @param string $addr Address in focus, must be RFC compliant
      * @return string $id email_addresses ID
      */
     function getEmailGUID($addr) {
@@ -733,7 +724,8 @@ 
  
     /**
      * Returns Primary or newest email address
-     * @param object $focus Object in focus
+     * @param boolean $focus Object in focus
+     * @param string $parent_type
      * @return string email
      */
     function getPrimaryAddress($focus,$parent_id=null,$parent_type=null) {
@@ -804,7 +796,7 @@ 
      * Returns all email addresses by parent's GUID
      * @param string $id Parent's GUID
      * @param string $module Parent's module
-     * @return array
+     * @return string
      */
     function getAddressesByGUID($id, $module) {
         $return = array();
@@ -828,7 +820,6 @@ 
 
     /**
      * Returns the HTML/JS for the EmailAddress widget
-     * @param string $parent_id ID of parent bean, generally $focus
      * @param string $module $focus' module
      * @param bool asMetadata Default false
      * @return string HTML/JS for widget
@@ -965,7 +956,7 @@ 
 
     /**
      * getEmailAddressWidgetDuplicatesView($focus)
-     * @param object $focus Bean in focus
+     * @param Lead $focus Bean in focus
      * @return string HTML that contains hidden input values based off of HTML request
      */
     function getEmailAddressWidgetDuplicatesView($focus)
@@ -1041,6 +1032,7 @@ 
     /**
      * getFormBaseURL
      *
+     * @param SugarBean $focus
      */
     function getFormBaseURL($focus) {
         $get = "";
@@ -1081,13 +1073,15 @@ 
 
     }
 
+    /**
+     * @param string $view
+     */
     function setView($view) {
        $this->view = $view;
     }
 
 /**
  * This function is here so the Employees/Users division can be handled cleanly in one place
- * @param object $focus SugarBean
  * @return string The value for the bean_module column in the email_addr_bean_rel table
  */
     function getCorrectedModule(&$module) {
@@ -1119,7 +1113,7 @@ 
 
 /**
  * Convenience function for MVC (Mystique)
- * @param object $focus SugarBean
+ * @param SugarBean $focus SugarBean
  * @param string $field unused
  * @param string $value unused
  * @param string $view DetailView or EditView

include/SugarOauth.php

Braces +1 added lines, -1 removed lines

@@ -133,7 +133,7 @@
             try{
                 $this->_last = $token = parent::getRequestToken($params);
                 return array('oauth_token' => $token->getToken(), 'oauth_token_secret' => $token->getTokenSecret());
-            }catch(Zend_Oauth_Exception $e){
+            } catch(Zend_Oauth_Exception $e){
                 return array('oauth_token' => '', 'oauth_token_secret' => '');
             }
         }

include/InlineEditing/InlineEditing.php

Braces +28 added lines, -19 removed lines

@@ -75,7 +75,9 @@ 
             $vardef['type'] = 'varchar';
         }
 
-        if (isset($vardef['precision'])) unset($vardef['precision']);
+        if (isset($vardef['precision'])) {
+            unset($vardef['precision']);
+        }
 
         //$vardef['precision'] = $locale->getPrecedentPreference('default_currency_significant_digits', $current_user);
 
@@ -115,8 +117,9 @@ 
         if (isset($vardef['function'])
             && ($vardef['function'] == 'getEmailAddressWidget'
                 || $vardef['function']['name'] == 'getEmailAddressWidget')
-        )
-            unset($vardef['function']);
+        ) {
+                    unset($vardef['function']);
+        }
 
         if (isset($vardef['name']) && ($vardef['name'] == 'date_modified')) {
             $vardef['name'] = 'aow_temp_date';
@@ -149,8 +152,9 @@ 
         }
 
         // hack to disable one of the js calls in this control
-        if (isset($vardef['function']) && ($vardef['function'] == 'getCurrencyDropDown' || $vardef['function']['name'] == 'getCurrencyDropDown'))
-            $contents .= "{literal}<script>function CurrencyConvertAll() { return; }</script>{/literal}";
+        if (isset($vardef['function']) && ($vardef['function'] == 'getCurrencyDropDown' || $vardef['function']['name'] == 'getCurrencyDropDown')) {
+                    $contents .= "{literal}<script>function CurrencyConvertAll() { return; }</script>{/literal}";
+        }
 
 
 
@@ -186,8 +190,9 @@ 
     $ss->assign('CALENDAR_FDOW', $current_user->get_first_day_of_week());
 
     $fieldlist = array();
-    if (!isset($focus) || !($focus instanceof SugarBean))
-        require_once($beanFiles[$beanList[$module]]);
+    if (!isset($focus) || !($focus instanceof SugarBean)) {
+            require_once($beanFiles[$beanList[$module]]);
+    }
     $focus = new $beanList[$module];
     // create the dropdowns for the parent type fields
     $vardefFields[$fieldname] = $focus->field_defs[$fieldname];
@@ -197,14 +202,17 @@ 
     foreach ($vardefFields as $name => $properties) {
         $fieldlist[$name] = $properties;
         // fill in enums
-        if (isset($fieldlist[$name]['options']) && is_string($fieldlist[$name]['options']) && isset($app_list_strings[$fieldlist[$name]['options']]))
-            $fieldlist[$name]['options'] = $app_list_strings[$fieldlist[$name]['options']];
+        if (isset($fieldlist[$name]['options']) && is_string($fieldlist[$name]['options']) && isset($app_list_strings[$fieldlist[$name]['options']])) {
+                    $fieldlist[$name]['options'] = $app_list_strings[$fieldlist[$name]['options']];
+        }
         // Bug 32626: fall back on checking the mod_strings if not in the app_list_strings
-        elseif (isset($fieldlist[$name]['options']) && is_string($fieldlist[$name]['options']) && isset($mod_strings[$fieldlist[$name]['options']]))
-            $fieldlist[$name]['options'] = $mod_strings[$fieldlist[$name]['options']];
+        elseif (isset($fieldlist[$name]['options']) && is_string($fieldlist[$name]['options']) && isset($mod_strings[$fieldlist[$name]['options']])) {
+                    $fieldlist[$name]['options'] = $mod_strings[$fieldlist[$name]['options']];
+        }
         // Bug 22730: make sure all enums have the ability to select blank as the default value.
-        if (!isset($fieldlist[$name]['options']['']))
-            $fieldlist[$name]['options'][''] = '';
+        if (!isset($fieldlist[$name]['options'][''])) {
+                    $fieldlist[$name]['options'][''] = '';
+        }
     }
 
     // fill in function return values
@@ -212,8 +220,9 @@ 
         if (!empty($fieldlist[$fieldname]['function']['returns']) && $fieldlist[$fieldname]['function']['returns'] == 'html') {
             $function = $fieldlist[$fieldname]['function']['name'];
             // include various functions required in the various vardefs
-            if (isset($fieldlist[$fieldname]['function']['include']) && is_file($fieldlist[$fieldname]['function']['include']))
-                require_once($fieldlist[$fieldname]['function']['include']);
+            if (isset($fieldlist[$fieldname]['function']['include']) && is_file($fieldlist[$fieldname]['function']['include'])) {
+                            require_once($fieldlist[$fieldname]['function']['include']);
+            }
             $_REQUEST[$fieldname] = $value;
             $value = $function($focus, $fieldname, $value, $view);
 
@@ -311,14 +320,14 @@ 
 
         if ($bean->field_defs[$field]['type'] == "multienum") {
             $bean->$field = encodeMultienumValue($value);
-        }else if ($bean->field_defs[$field]['type'] == "relate" || $bean->field_defs[$field]['type'] == 'parent'){
+        } else if ($bean->field_defs[$field]['type'] == "relate" || $bean->field_defs[$field]['type'] == 'parent'){
             $save_field = $bean->field_defs[$field]['id_name'];
             $bean->$save_field = $value;
             if ($bean->field_defs[$field]['type'] == 'parent') {
                 $bean->parent_type = $_REQUEST['parent_type'];
                 $bean->fill_in_additional_parent_fields(); // get up to date parent info as need it to display name
             }
-        }else{
+        } else{
             $bean->$field = $value;
         }
 
@@ -449,7 +458,7 @@ 
         if($vardef['ext2']){
             $value .= getFieldValueFromModule($vardef['rname'],$vardef['ext2'],$record) . "</a>";
 
-        }else if(!empty($vardef['rname'])){
+        } else if(!empty($vardef['rname'])){
             $value .= getFieldValueFromModule($vardef['rname'],$vardef['module'],$record) . "</a>";
 
         } else {
@@ -486,7 +495,7 @@ 
 
     if($bean->ACLAccess('EditView')) {
         return true;
-    }else {
+    } else {
         return false;
     }
 }

Doc Comments +9 added lines

@@ -330,6 +330,9 @@ 
 
 }
 
+/**
+ * @param SugarBean $bean
+ */
 function getDisplayValue($bean, $field, $method = "save")
 {
 
@@ -471,6 +474,9 @@ 
 
 }
 
+/**
+ * @return string
+ */
 function convertDateUserToDB($value)
 {
     global $timedate;
@@ -482,6 +488,9 @@ 
     return $value;
 }
 
+/**
+ * @param SugarBean $bean
+ */
 function checkAccess($bean){
 
     if($bean->ACLAccess('EditView')) {

include/formbase.php

Braces +10 added lines, -11 removed lines

@@ -1,5 +1,7 @@ 
 <?php
-if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
+if(!defined('sugarEntry') || !sugarEntry) {
+    die('Not A Valid Entry Point');
+}
 /*********************************************************************************
  * SugarCRM Community Edition is a customer relationship management program developed by
  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
@@ -77,8 +79,9 @@ 
 {
 	global $current_user;
 
-	if(!empty($_REQUEST[$prefix.'record']) && !$skipRetrieve)
-		$focus->retrieve($_REQUEST[$prefix.'record']);
+	if(!empty($_REQUEST[$prefix.'record']) && !$skipRetrieve) {
+			$focus->retrieve($_REQUEST[$prefix.'record']);
+	}
 
 	if(!empty($_POST['assigned_user_id']) && 
 	    ($focus->assigned_user_id != $_POST['assigned_user_id']) && 
@@ -240,8 +243,7 @@ 
     if(isset($_REQUEST['return_module']) && $_REQUEST['return_module'] != "")
 	{
 		$return_module = $_REQUEST['return_module'];
-	}
-	else
+	} else
 	{
 		$return_module = $return_module;
 	}
@@ -275,14 +277,12 @@ 
 			$return_module = $_REQUEST['module'];
 			$return_action = $_REQUEST['return_action']; 
 			// wp: return action needs to be set for one-click close in task list
-		} 
-		else 
+		} else 
 		{
 			// if we "Cancel", we go back to the list view.
 			$return_action = $_REQUEST['return_action'];
 		}
-	}
-	else
+	} else
 	{
 		$return_action = "DetailView";
 	}
@@ -378,8 +378,7 @@ 
     $focus=BeanFactory::getBean('Prospects');
     if(is_array($child_id)){
         $uids = $child_id;
-    }
-    else{
+    } else{
         $uids = array($child_id);
     }
 

Doc Comments +6 added lines

@@ -235,6 +235,9 @@ 
 }
 
 //eggsurplus: abstract to simplify unit testing
+/**
+ * @return string
+ */
 function buildRedirectURL($return_id='', $return_module='') 
 {
     if(isset($_REQUEST['return_module']) && $_REQUEST['return_module'] != "")
@@ -339,6 +342,9 @@ 
     }
 }
 
+/**
+ * @param string $fieldname
+ */
 function getLikeForEachWord($fieldname, $value, $minsize=4)
 {
 	$value = trim($value);

include/utils.php

Braces +343 added lines, -225 removed lines

@@ -448,11 +448,9 @@ 
 
 	if(file_exists("custom/include/language/{$language}.notify_template.html")){
 		$file = "custom/include/language/{$language}.notify_template.html";
-	}
-	else if(file_exists("include/language/{$language}.notify_template.html")){
+	} else if(file_exists("include/language/{$language}.notify_template.html")){
 		$file = "include/language/{$language}.notify_template.html";
-	}
-	else if(file_exists("custom/include/language/en_us.notify_template.html")){
+	} else if(file_exists("custom/include/language/en_us.notify_template.html")){
 		$file = "custom/include/language/en_us.notify_template.html";
 	}
 
@@ -470,8 +468,7 @@ 
 	foreach( $default as $key => $value ){
 		if( !array_key_exists($key, $override) ){
 			$override[$key] = $value;
-		}
-		else if( is_array( $key ) ){
+		} else if( is_array( $key ) ){
 			$override[$key] = sugar_config_union( $value, $override[$key] );
 		}
 	}
@@ -484,8 +481,7 @@ 
 	if( is_file($file) || is_dir($file) ){
 		if( !is_writable($file) ){
 			$ret_val = true;
-		}
-		else {
+		} else {
 			$original_fileperms = fileperms($file);
 
 			// take away writable permissions
@@ -591,8 +587,9 @@ 
 function get_user_name($id) {
 	global $db;
 
-	if(empty($db))
-	$db = DBManagerFactory::getInstance();
+	if(empty($db)) {
+		$db = DBManagerFactory::getInstance();
+	}
 
 	$q = "SELECT user_name FROM users WHERE id='{$id}'";
 	$r = $db->query($q);
@@ -637,8 +634,7 @@ 
 		// Including deleted users for now.
 		if (empty($status)) {
 			$query = "SELECT id, first_name, last_name, user_name from users WHERE 1=1".$portal_filter;
-		}
-		else {
+		} else {
 			$query = "SELECT id, first_name, last_name, user_name from users WHERE status='$status'".$portal_filter;
 		}
         /* BEGIN - SECURITY GROUPS */
@@ -677,7 +673,7 @@ 
                 //its possible for first name to be skipped, check for this
                 if($firstNamePos===false){
                     $order_by_string =  'last_name ASC';
-                }else{
+                } else{
                     $order_by_string =  ($lastNamePos < $firstNamePos) ? "last_name, first_name ASC" : "first_name, last_name ASC";
                 }
             }
@@ -1100,18 +1096,20 @@ 
 	$loaded_mod_strings = LanguageManager::loadModuleLanguage($module, $language,$refresh);
 
 	// cn: bug 6048 - merge en_us with requested language
-	if($language != $sugar_config['default_language'])
-        $loaded_mod_strings = sugarLangArrayMerge(
+	if($language != $sugar_config['default_language']) {
+	        $loaded_mod_strings = sugarLangArrayMerge(
             LanguageManager::loadModuleLanguage($module, $sugar_config['default_language'],$refresh),
                 $loaded_mod_strings
             );
+	}
 
     // Load in en_us strings by default
-    if($language != 'en_us' && $sugar_config['default_language'] != 'en_us')
-        $loaded_mod_strings = sugarLangArrayMerge(
+    if($language != 'en_us' && $sugar_config['default_language'] != 'en_us') {
+            $loaded_mod_strings = sugarLangArrayMerge(
             LanguageManager::loadModuleLanguage($module, 'en_us', $refresh),
                 $loaded_mod_strings
             );
+    }
 
 	// If we are in debug mode for translating, turn on the prefix now!
 	if($sugar_config['translation_string_prefix']) {
@@ -1123,9 +1121,9 @@ 
 	$return_value = $loaded_mod_strings;
 	if(!isset($mod_strings)){
 		$mod_strings = $return_value;
+	} else {
+			$mod_strings = $temp_mod_strings;
 	}
-	else
-		$mod_strings = $temp_mod_strings;
 
     $cache_key = LanguageManager::getLanguageCacheKey($module, $language);
     sugar_cache_put($cache_key, $return_value);
@@ -1164,8 +1162,9 @@ 
 	// cn: bug 6048 - merge en_us with requested language
 	include("modules/$module/language/en_us.lang.php");
 	$en_mod_list_strings = array();
-	if($language_used != $default_language)
-	$en_mod_list_strings = $mod_list_strings;
+	if($language_used != $default_language) {
+		$en_mod_list_strings = $mod_list_strings;
+	}
 
 	if(file_exists("modules/$module/language/$language.lang.php")) {
 		include("modules/$module/language/$language.lang.php");
@@ -1295,8 +1294,9 @@ 
 	$where = "";
 	foreach($where_clauses as $clause)
 	{
-		if($where != "")
-		$where .= " and ";
+		if($where != "") {
+				$where .= " and ";
+		}
 		$where .= $clause;
 	}
 
@@ -1374,8 +1374,7 @@ 
 	if($strlen < $length)
 	{
 		$string = str_pad($string,$length,"0");
-	}
-	else if($strlen > $length)
+	} else if($strlen > $length)
 	{
 		$string = substr($string, 0, $length);
 	}
@@ -1575,7 +1574,9 @@ 
         $replacement .= "/OPTION>\n<OPTION value='__SugarMassUpdateClearField__'><"; // Giving the user the option to unset a drop down list. I.e. none means that it won't get updated
     }
 
-	if (empty($key_list)) $key_list = array();
+	if (empty($key_list)) {
+	    $key_list = array();
+	}
 	//create the type dropdown domain and set the selected value if $opp value already exists
 	foreach ($key_list as $option_key=>$option_value) {
 
@@ -1737,24 +1738,26 @@ 
 		    $current_language = ($_REQUEST['login_language'] == $current_language)? $current_language : $_REQUEST['login_language'];
 		}
 		$mod_strings = return_module_language($current_language, $mod);
-        if ($mod == "")
-        echo "Language is <pre>" . $mod_strings . "</pre>";
+        if ($mod == "") {
+                echo "Language is <pre>" . $mod_strings . "</pre>";
+        }
 
-	}else{
+	} else{
 		global $mod_strings;
 	}
 
 	$returnValue = '';
 	global $app_strings, $app_list_strings;
 
-    if (isset($mod_strings[$string]))
-        $returnValue = $mod_strings[$string];
-    else if (isset($app_strings[$string]))
-        $returnValue = $app_strings[$string];
-    else if (isset($app_list_strings[$string]))
-        $returnValue = $app_list_strings[$string];
-    else if (isset($app_list_strings['moduleList']) && isset($app_list_strings['moduleList'][$string]))
-        $returnValue = $app_list_strings['moduleList'][$string];
+    if (isset($mod_strings[$string])) {
+            $returnValue = $mod_strings[$string];
+    } else if (isset($app_strings[$string])) {
+            $returnValue = $app_strings[$string];
+    } else if (isset($app_list_strings[$string])) {
+            $returnValue = $app_list_strings[$string];
+    } else if (isset($app_list_strings['moduleList']) && isset($app_list_strings['moduleList'][$string])) {
+            $returnValue = $app_list_strings['moduleList'][$string];
+    }
 
 
 	//$test_end = microtime();
@@ -1867,8 +1870,9 @@ 
 function clean_xss($str, $cleanImg=true) {
 	global $sugar_config;
 
-	if(empty($sugar_config['email_xss']))
-	$sugar_config['email_xss'] = getDefaultXssTags();
+	if(empty($sugar_config['email_xss'])) {
+		$sugar_config['email_xss'] = getDefaultXssTags();
+	}
 
 	$xsstags = unserialize(base64_decode($sugar_config['email_xss']));
 
@@ -1987,32 +1991,65 @@ 
 			die("Bad data passed in; <a href=\"{$sugar_config['site_url']}\">Return to Home</a>");
 		}
 		return false;
-	}
-	else {
+	} else {
 		return $str;
 	}
 }
 
 function clean_special_arguments() {
 	if(isset($_SERVER['PHP_SELF'])) {
-		if (!empty($_SERVER['PHP_SELF'])) clean_string($_SERVER['PHP_SELF'], 'SAFED_GET');
-	}
-	if (!empty($_REQUEST) && !empty($_REQUEST['login_theme'])) clean_string($_REQUEST['login_theme'], "STANDARD");
-	if (!empty($_REQUEST) && !empty($_REQUEST['login_module'])) clean_string($_REQUEST['login_module'], "STANDARD");
-	if (!empty($_REQUEST) && !empty($_REQUEST['login_action'])) clean_string($_REQUEST['login_action'], "STANDARD");
-	if (!empty($_REQUEST) && !empty($_REQUEST['ck_login_theme_20'])) clean_string($_REQUEST['ck_login_theme_20'], "STANDARD");
-	if (!empty($_SESSION) && !empty($_SESSION['authenticated_user_theme'])) clean_string($_SESSION['authenticated_user_theme'], "STANDARD");
-	if (!empty($_REQUEST) && !empty($_REQUEST['module_name'])) clean_string($_REQUEST['module_name'], "STANDARD");
-	if (!empty($_REQUEST) && !empty($_REQUEST['module'])) clean_string($_REQUEST['module'], "STANDARD");
-	if (!empty($_POST) && !empty($_POST['parent_type'])) clean_string($_POST['parent_type'], "STANDARD");
-	if (!empty($_REQUEST) && !empty($_REQUEST['mod_lang'])) clean_string($_REQUEST['mod_lang'], "STANDARD");
-	if (!empty($_SESSION) && !empty($_SESSION['authenticated_user_language'])) clean_string($_SESSION['authenticated_user_language'], "STANDARD");
-	if (!empty($_SESSION) && !empty($_SESSION['dyn_layout_file'])) clean_string($_SESSION['dyn_layout_file'], "PATH_NO_URL");
-	if (!empty($_GET) && !empty($_GET['from'])) clean_string($_GET['from']);
-	if (!empty($_GET) && !empty($_GET['gmto'])) clean_string($_GET['gmto'], "NUMBER");
-	if (!empty($_GET) && !empty($_GET['case_number'])) clean_string($_GET['case_number'], "AUTO_INCREMENT");
-	if (!empty($_GET) && !empty($_GET['bug_number'])) clean_string($_GET['bug_number'], "AUTO_INCREMENT");
-	if (!empty($_GET) && !empty($_GET['quote_num'])) clean_string($_GET['quote_num'], "AUTO_INCREMENT");
+		if (!empty($_SERVER['PHP_SELF'])) {
+		    clean_string($_SERVER['PHP_SELF'], 'SAFED_GET');
+		}
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['login_theme'])) {
+	    clean_string($_REQUEST['login_theme'], "STANDARD");
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['login_module'])) {
+	    clean_string($_REQUEST['login_module'], "STANDARD");
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['login_action'])) {
+	    clean_string($_REQUEST['login_action'], "STANDARD");
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['ck_login_theme_20'])) {
+	    clean_string($_REQUEST['ck_login_theme_20'], "STANDARD");
+	}
+	if (!empty($_SESSION) && !empty($_SESSION['authenticated_user_theme'])) {
+	    clean_string($_SESSION['authenticated_user_theme'], "STANDARD");
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['module_name'])) {
+	    clean_string($_REQUEST['module_name'], "STANDARD");
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['module'])) {
+	    clean_string($_REQUEST['module'], "STANDARD");
+	}
+	if (!empty($_POST) && !empty($_POST['parent_type'])) {
+	    clean_string($_POST['parent_type'], "STANDARD");
+	}
+	if (!empty($_REQUEST) && !empty($_REQUEST['mod_lang'])) {
+	    clean_string($_REQUEST['mod_lang'], "STANDARD");
+	}
+	if (!empty($_SESSION) && !empty($_SESSION['authenticated_user_language'])) {
+	    clean_string($_SESSION['authenticated_user_language'], "STANDARD");
+	}
+	if (!empty($_SESSION) && !empty($_SESSION['dyn_layout_file'])) {
+	    clean_string($_SESSION['dyn_layout_file'], "PATH_NO_URL");
+	}
+	if (!empty($_GET) && !empty($_GET['from'])) {
+	    clean_string($_GET['from']);
+	}
+	if (!empty($_GET) && !empty($_GET['gmto'])) {
+	    clean_string($_GET['gmto'], "NUMBER");
+	}
+	if (!empty($_GET) && !empty($_GET['case_number'])) {
+	    clean_string($_GET['case_number'], "AUTO_INCREMENT");
+	}
+	if (!empty($_GET) && !empty($_GET['bug_number'])) {
+	    clean_string($_GET['bug_number'], "AUTO_INCREMENT");
+	}
+	if (!empty($_GET) && !empty($_GET['quote_num'])) {
+	    clean_string($_GET['quote_num'], "AUTO_INCREMENT");
+	}
 	clean_superglobals('stamp', 'ALPHANUM'); // for vcr controls
 	clean_superglobals('offset', 'ALPHANUM');
 	clean_superglobals('return_action');
@@ -2024,10 +2061,16 @@ 
  * cleans the given key in superglobals $_GET, $_POST, $_REQUEST
  */
 function clean_superglobals($key, $filter = 'STANDARD') {
-	if(isset($_GET[$key])) clean_string($_GET[$key], $filter);
-	if(isset($_POST[$key])) clean_string($_POST[$key], $filter);
-	if(isset($_REQUEST[$key])) clean_string($_REQUEST[$key], $filter);
-}
+	if(isset($_GET[$key])) {
+	    clean_string($_GET[$key], $filter);
+	}
+	if(isset($_POST[$key])) {
+	    clean_string($_POST[$key], $filter);
+	}
+	if(isset($_REQUEST[$key])) {
+	    clean_string($_REQUEST[$key], $filter);
+	}
+	}
 
 function set_superglobals($key, $val){
 	$_GET[$key] = $val;
@@ -2068,25 +2111,51 @@ 
         //get translated, so scrub the data but don't die
 	    if(ini_get('mbstring.encoding_translation')==='1'){
             securexsskey($k,false);
-        }else{
+        } else{
 		    securexsskey($k,true);
         }
 
 	}
 	// Any additional variables that need to be cleaned should be added here
-	if (isset($_REQUEST['login_theme'])) clean_string($_REQUEST['login_theme']);
-	if (isset($_REQUEST['login_module'])) clean_string($_REQUEST['login_module']);
-	if (isset($_REQUEST['login_action'])) clean_string($_REQUEST['login_action']);
-	if (isset($_REQUEST['login_language'])) clean_string($_REQUEST['login_language']);
-	if (isset($_REQUEST['action'])) clean_string($_REQUEST['action']);
-	if (isset($_REQUEST['module'])) clean_string($_REQUEST['module']);
-	if (isset($_REQUEST['record'])) clean_string($_REQUEST['record'], 'STANDARDSPACE');
-	if (isset($_SESSION['authenticated_user_theme'])) clean_string($_SESSION['authenticated_user_theme']);
-	if (isset($_SESSION['authenticated_user_language'])) clean_string($_SESSION['authenticated_user_language']);
-	if (isset($_REQUEST['language'])) clean_string($_REQUEST['language']);
-	if (isset($sugar_config['default_theme'])) clean_string($sugar_config['default_theme']);
-	if (isset($_REQUEST['offset'])) clean_string($_REQUEST['offset']);
-	if (isset($_REQUEST['stamp'])) clean_string($_REQUEST['stamp']);
+	if (isset($_REQUEST['login_theme'])) {
+	    clean_string($_REQUEST['login_theme']);
+	}
+	if (isset($_REQUEST['login_module'])) {
+	    clean_string($_REQUEST['login_module']);
+	}
+	if (isset($_REQUEST['login_action'])) {
+	    clean_string($_REQUEST['login_action']);
+	}
+	if (isset($_REQUEST['login_language'])) {
+	    clean_string($_REQUEST['login_language']);
+	}
+	if (isset($_REQUEST['action'])) {
+	    clean_string($_REQUEST['action']);
+	}
+	if (isset($_REQUEST['module'])) {
+	    clean_string($_REQUEST['module']);
+	}
+	if (isset($_REQUEST['record'])) {
+	    clean_string($_REQUEST['record'], 'STANDARDSPACE');
+	}
+	if (isset($_SESSION['authenticated_user_theme'])) {
+	    clean_string($_SESSION['authenticated_user_theme']);
+	}
+	if (isset($_SESSION['authenticated_user_language'])) {
+	    clean_string($_SESSION['authenticated_user_language']);
+	}
+	if (isset($_REQUEST['language'])) {
+	    clean_string($_REQUEST['language']);
+	}
+	if (isset($sugar_config['default_theme'])) {
+	    clean_string($sugar_config['default_theme']);
+	}
+	if (isset($_REQUEST['offset'])) {
+	    clean_string($_REQUEST['offset']);
+	}
+	if (isset($_REQUEST['stamp'])) {
+	    clean_string($_REQUEST['stamp']);
+	}
 
 	if(isset($_REQUEST['lvso'])){
 			set_superglobals('lvso', (strtolower($_REQUEST['lvso']) === 'desc')?'desc':'asc');
@@ -2096,8 +2165,7 @@ 
 		if (str_end($key, "_offset")) {
 			clean_string($_REQUEST[$key], "ALPHANUM"); // keep this ALPHANUM for disable_count_query
 			set_superglobals($key, $_REQUEST[$key]);
-		}
-		elseif (str_end($key, "_ORDER_BY")) {
+		} elseif (str_end($key, "_ORDER_BY")) {
 			clean_string($_REQUEST[$key], "SQL_COLUMN_LIST");
 			set_superglobals($key, $_REQUEST[$key]);
 		}
@@ -2138,7 +2206,7 @@ 
 	if(!empty($matches)){
 		if($die){
 			die("Bad data passed in; <a href=\"{$sugar_config['site_url']}\">Return to Home</a>");
-		}else{
+		} else{
 			unset($_REQUEST[$value]);
 			unset($_POST[$value]);
 			unset($_GET[$value]);
@@ -2153,8 +2221,7 @@ 
 		}
 
 		$value = securexss($value);
-	}
-	else if (is_array($value)){
+	} else if (is_array($value)){
 	    foreach ($value as $key => $element) {
 	        $value[$key] = preprocess_param($element);
 	    }
@@ -2165,7 +2232,9 @@ 
 
 function cleanup_slashes($value)
 {
-    if(is_string($value)) return stripslashes($value);
+    if(is_string($value)) {
+        return stripslashes($value);
+    }
     return $value;
 }
 
@@ -2210,18 +2279,26 @@ 
 
 function getWebPath($relative_path){
 	//if it has  a :// then it isn't a relative path
-	if(substr_count($relative_path, '://') > 0) return $relative_path;
-	if(defined('TEMPLATE_URL'))$relative_path = SugarTemplateUtilities::getWebPath($relative_path);
+	if(substr_count($relative_path, '://') > 0) {
+	    return $relative_path;
+	}
+	if(defined('TEMPLATE_URL')) {
+	    $relative_path = SugarTemplateUtilities::getWebPath($relative_path);
+	}
 	return $relative_path;
 }
 
 function getVersionedPath($path, $additional_attrs='')
 {
-	if(empty($GLOBALS['sugar_config']['js_custom_version'])) $GLOBALS['sugar_config']['js_custom_version'] = 1;
+	if(empty($GLOBALS['sugar_config']['js_custom_version'])) {
+	    $GLOBALS['sugar_config']['js_custom_version'] = 1;
+	}
 	$js_version_key = isset($GLOBALS['js_version_key'])?$GLOBALS['js_version_key']:'';
 	if(inDeveloperMode()) {
 	    static $rand;
-	    if(empty($rand)) $rand = mt_rand();
+	    if(empty($rand)) {
+	        $rand = mt_rand();
+	    }
 	    $dev = $rand;
 	} else {
 	    $dev = '';
@@ -2233,7 +2310,9 @@ 
 	$str = substr(base64_encode(md5("$js_version_key|{$GLOBALS['sugar_config']['js_custom_version']}|$dev|$additional_attrs", true)), 0, -2);
 	// remove / - it confuses some parsers
 	$str = strtr($str, '/+', '-_');
-	if(empty($path)) return $str;
+	if(empty($path)) {
+	    return $str;
+	}
 
 	return $path . "?v=$str";
 }
@@ -2245,7 +2324,9 @@ 
 
 function getJSPath($relative_path, $additional_attrs='')
 {
-	if(defined('TEMPLATE_URL'))$relative_path = SugarTemplateUtilities::getWebPath($relative_path);
+	if(defined('TEMPLATE_URL')) {
+	    $relative_path = SugarTemplateUtilities::getWebPath($relative_path);
+	}
 	return getVersionedPath($relative_path).(!empty($additional_attrs)?"&$additional_attrs":"");
 }
 
@@ -2277,8 +2358,7 @@ 
 			$match[1] = "0".$match[1];
 		}
 		return "{$match[3]}-{$match[1]}-{$match[2]}";
-	}
-	else if (preg_match('/^(\d{1,2})\/(\d{1,2})\/(\d{4})$/',$date_str,$match))
+	} else if (preg_match('/^(\d{1,2})\/(\d{1,2})\/(\d{4})$/',$date_str,$match))
 	{
 		if ( strlen($match[2]) == 1)
 		{
@@ -2289,8 +2369,7 @@ 
 			$match[1] = "0".$match[1];
 		}
 		return "{$match[3]}-{$match[1]}-{$match[2]}";
-	}
-	else
+	} else
 	{
 		return "";
 	}
@@ -2347,10 +2426,12 @@ 
 			}
 			$bean->update_date_modified = false;
             $bean->update_modified_by = false;
-            if(isset($bean->date_modified))
-                $bean->date_modified = $timedate->to_db($bean->date_modified);
-            if(isset($bean->date_entered))
-                $bean->date_entered = $timedate->to_db($bean->date_entered);
+            if(isset($bean->date_modified)) {
+                            $bean->date_modified = $timedate->to_db($bean->date_modified);
+            }
+            if(isset($bean->date_entered)) {
+                            $bean->date_entered = $timedate->to_db($bean->date_entered);
+            }
 			//save
 			$new_id=$bean->save();
 
@@ -2673,7 +2754,7 @@ 
 	//no error notice - lets just display the error to the user
 	if(!isset($error_notice)){
 		echo '<br>'.$msg . '<br>';
-	}else{
+	} else{
 		$error_notice .= $msg . '<br>';
 	}
 }
@@ -2717,10 +2798,9 @@ 
 
 		if(ord(substr($str, $i, 1))==10){
 			$new_str .= '\n';
-		}elseif(ord(substr($str, $i, 1))==13){
+		} elseif(ord(substr($str, $i, 1))==13){
 			$new_str .= '\r';
-		}
-		else {
+		} else {
 			$new_str .= $str{$i};
 		}
 	}
@@ -2735,8 +2815,7 @@ 
 
 	if($keep){
 		$str = javascript_escape($str);
-	}
-	else {
+	} else {
 		$str = str_replace("'", " ", $str);
 		$str = str_replace('"', " ", $str);
 	}
@@ -2931,8 +3010,9 @@ 
 
 	$server_software = $_SERVER["SERVER_SOFTWARE"];
 	$iis_version = '';
-	if(strpos($server_software,'Microsoft-IIS') !== false && preg_match_all("/^.*\/(\d+\.?\d*)$/",  $server_software, $out))
-	    $iis_version = $out[1][0];
+	if(strpos($server_software,'Microsoft-IIS') !== false && preg_match_all("/^.*\/(\d+\.?\d*)$/",  $server_software, $out)) {
+		    $iis_version = $out[1][0];
+	}
 
     $sys_iis_version = empty($sys_iis_version) ? $iis_version : $sys_iis_version;
 
@@ -3008,7 +3088,9 @@ 
 
 function sugar_cleanup($exit = false) {
 	static $called = false;
-	if($called)return;
+	if($called) {
+	    return;
+	}
 	$called = true;
 	set_include_path(realpath(dirname(__FILE__) . '/..') . PATH_SEPARATOR . get_include_path());
 	chdir(realpath(dirname(__FILE__) . '/..'));
@@ -3019,7 +3101,11 @@ 
 
 	//added this check to avoid errors during install.
 	if (empty($sugar_config['dbconfig'])) {
-		if ($exit) exit; else return;
+		if ($exit) {
+		    exit;
+		} else {
+		    return;
+		}
 	}
 
     if (!class_exists('Tracker', true)) {
@@ -3028,8 +3114,9 @@ 
 	Tracker::logPage();
 	// Now write the cached tracker_queries
 	if(!empty($GLOBALS['savePreferencesToDB']) && $GLOBALS['savePreferencesToDB']) {
-	    if ( isset($GLOBALS['current_user']) && $GLOBALS['current_user'] instanceOf User )
-	        $GLOBALS['current_user']->savePreferencesToDB();
+	    if ( isset($GLOBALS['current_user']) && $GLOBALS['current_user'] instanceOf User ) {
+	    	        $GLOBALS['current_user']->savePreferencesToDB();
+	    }
 	}
 
 	//check to see if this is not an `ajax call AND the user preference error flag is set
@@ -3154,8 +3241,9 @@ 
 
 	echo "\n\n display_stack_trace caller, file: " . $stack[0]['file']. ' line#: ' .$stack[0]['line'];
 
-	if(!$textOnly)
-	echo '<br>';
+	if(!$textOnly) {
+		echo '<br>';
+	}
 
 	$first = true;
 	$out = '';
@@ -3166,14 +3254,18 @@ 
 		$line  = '';
 		$function  = '';
 
-		if(isset($item['file']))
-		$file = $item['file'];
-		if(isset($item['class']))
-		$class = $item['class'];
-		if(isset($item['line']))
-		$line = $item['line'];
-		if(isset($item['function']))
-		$function = $item['function'];
+		if(isset($item['file'])) {
+				$file = $item['file'];
+		}
+		if(isset($item['class'])) {
+				$class = $item['class'];
+		}
+		if(isset($item['line'])) {
+				$line = $item['line'];
+		}
+		if(isset($item['function'])) {
+				$function = $item['function'];
+		}
 
 		if(!$first) {
 			if(!$textOnly) {
@@ -3217,9 +3309,9 @@ 
 		    if ( error_reporting() & E_NOTICE ) {
 		        $halt_script = false;
 		        $type = 'Notice';
+		    } else {
+		    		        return;
 		    }
-		    else
-		        return;
 			break;
 		case E_USER_WARNING:
 		case E_COMPILE_WARNING:
@@ -3367,14 +3459,16 @@ 
 	$file = str_replace("/", '\\', $file);
 
 	if(file_exists($file)) {
-		if (!($f = @sugar_fopen($file, 'r+')))
-		return false;
+		if (!($f = @sugar_fopen($file, 'r+'))) {
+				return false;
+		}
 		fclose($f);
 		return true;
 	}
 
-	if(!($f = @sugar_fopen($file, 'w')))
-	return false;
+	if(!($f = @sugar_fopen($file, 'w'))) {
+		return false;
+	}
 	fclose($f);
 	unlink($file);
 	return true;
@@ -3393,7 +3487,9 @@ 
 	global $beanList;
 
 	foreach($module_array as $key => $value){
-		if(!empty($beanList[$value])) $module_array[$key] = $beanList[$value];
+		if(!empty($beanList[$value])) {
+		    $module_array[$key] = $beanList[$value];
+		}
 
 		if($value=="Cases") {
 			$module_array[$key] = "Case";
@@ -3417,8 +3513,7 @@ 
 	global $beanFiles, $beanList;
 	if(array_key_exists($bean_name, $beanList)){
 		return $beanList[$bean_name];
-	}
-	else{
+	} else{
 		return $bean_name;
 	}
 }
@@ -3692,8 +3787,7 @@ 
 		$num=unformat_number($num);
 		if(isset($system_id) && $system_id == 1){
 			return sprintf("%d", $num);
-		}
-		else{
+		} else{
 			return sprintf("%d-%d", $num, $system_id);
 		}
 	}
@@ -3720,8 +3814,7 @@ 
 		{
 			//third index ($split[2]) will be the host
 			$split[2] .= ":".$port;
-		}
-		else // otherwise assumed to start with host name
+		} else // otherwise assumed to start with host name
 		{
 			//first index ($split[0]) will be the host
 			$split[0] .= ":".$port;
@@ -3797,19 +3890,19 @@ 
 				if(is_array($domVal))
                 {
 					$tempArr = array();
-                    foreach ( $domVal as $domArrKey => $domArrVal )
-                        $tempArr[$domArrKey] = $domArrVal;
-                    foreach ( $gimp[$domKey] as $gimpArrKey => $gimpArrVal )
-                        if ( !isset($tempArr[$gimpArrKey]) )
+                    foreach ( $domVal as $domArrKey => $domArrVal ) {
+                                            $tempArr[$domArrKey] = $domArrVal;
+                    }
+                    foreach ( $gimp[$domKey] as $gimpArrKey => $gimpArrVal ) {
+                                            if ( !isset($tempArr[$gimpArrKey]) )
                             $tempArr[$gimpArrKey] = $gimpArrVal;
+                    }
                     $gimp[$domKey] = $tempArr;
-				}
-                else
+				} else
                 {
 					$gimp[$domKey] = $domVal;
 				}
-			}
-            else
+			} else
             {
 				$gimp[$domKey] = $domVal;
 			}
@@ -3843,11 +3936,13 @@ 
 			if(array_key_exists($domKey, $gimp)) {
 				if(is_array($domVal)) {
 					$tempArr = array();
-                    foreach ( $domVal as $domArrKey => $domArrVal )
-                        $tempArr[$domArrKey] = $domArrVal;
-                    foreach ( $gimp[$domKey] as $gimpArrKey => $gimpArrVal )
-                        if ( !array_key_exists($gimpArrKey, $tempArr) )
+                    foreach ( $domVal as $domArrKey => $domArrVal ) {
+                                            $tempArr[$domArrKey] = $domArrVal;
+                    }
+                    foreach ( $gimp[$domKey] as $gimpArrKey => $gimpArrVal ) {
+                                            if ( !array_key_exists($gimpArrKey, $tempArr) )
                             $tempArr[$gimpArrKey] = $gimpArrVal;
+                    }
                     $gimp[$domKey] = $tempArr;
 				} else {
 					$gimp[$domKey] = $domVal;
@@ -3858,8 +3953,9 @@ 
 		}
 	}
     // if the passed value for gimp isn't an array, then return the $dom
-    elseif(is_array($dom))
-        return $dom;
+    elseif(is_array($dom)) {
+            return $dom;
+    }
 
 	return $gimp;
 }
@@ -3886,8 +3982,9 @@ 
 		}
 	}
     // if the passed value for gimp isn't an array, then return the $dom
-    elseif(is_array($dom))
-        return $dom;
+    elseif(is_array($dom)) {
+            return $dom;
+    }
 
 	return $gimp;
 }
@@ -4042,8 +4139,7 @@ 
 
 	if( write_array_to_file( "sugar_config", $sugar_config, "config.php" ) ){
 		return true;
-	}
-	else {
+	} else {
 		return false;
 	}
 }
@@ -4076,8 +4172,9 @@ 
 	if(!empty($_SERVER['HTTP_REFERER'])) {
 		$url = parse_url($_SERVER['HTTP_REFERER']);
 		$replacement_url = $url['scheme']."://".$url['host'];
-		if(!empty($url['port']))
-		$replacement_url .= ':'.$url['port'];
+		if(!empty($url['port'])) {
+				$replacement_url .= ':'.$url['port'];
+		}
 		$site_url = preg_replace('/^http[s]?\:\/\/[^\/]+/',$replacement_url,$sugar_config['site_url']);
 	} else {
 		$site_url = preg_replace('/^http(s)?\:\/\/[^\/]+/',"http$1://".$_SERVER['HTTP_HOST'],$sugar_config['site_url']);
@@ -4102,8 +4199,7 @@ 
 		foreach ($array as $key => $value){
 			$depth_array[] = array_depth($value, $depth_count);
 		}
-	}
-	else{
+	} else{
 		return $depth_count;
 	}
 	foreach ($depth_array as $value){
@@ -4146,17 +4242,20 @@ 
     $iconFound = SugarThemeRegistry::current()->getImageURL($iconName,false);
 
     //First try un-ucfirst-ing the icon name
-    if ( empty($iconFound) )
-		$iconName = "icon_" . strtolower(substr($iconFileName,0,1)).substr($iconFileName,1) . ".gif";
+    if ( empty($iconFound) ) {
+    		$iconName = "icon_" . strtolower(substr($iconFileName,0,1)).substr($iconFileName,1) . ".gif";
+    }
         $iconFound = SugarThemeRegistry::current()->getImageURL($iconName,false);
 
 	//Next try removing the icon prefix
-    if ( empty($iconFound) )
-		$iconName = "{$iconFileName}.gif";
+    if ( empty($iconFound) ) {
+    		$iconName = "{$iconFileName}.gif";
+    }
 		$iconFound = SugarThemeRegistry::current()->getImageURL($iconName,false);
 
-	if ( empty($iconFound) )
-		$iconName = '';
+	if ( empty($iconFound) ) {
+			$iconName = '';
+	}
 
   	return $iconName;
 }
@@ -4222,8 +4321,9 @@ 
     if (!isset($trans_tbl))
     {
         $trans_tbl = array();
-        foreach (get_html_translation_table(HTML_ENTITIES) as $val=>$key)
-            $trans_tbl[$key] = utf8_encode($val);
+        foreach (get_html_translation_table(HTML_ENTITIES) as $val=>$key) {
+                    $trans_tbl[$key] = utf8_encode($val);
+        }
     }
     return strtr($string, $trans_tbl);
 }
@@ -4231,10 +4331,18 @@ 
 // Returns the utf string corresponding to the unicode value
 function code2utf($num)
 {
-    if ($num < 128) return chr($num);
-    if ($num < 2048) return chr(($num >> 6) + 192) . chr(($num & 63) + 128);
-    if ($num < 65536) return chr(($num >> 12) + 224) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
-    if ($num < 2097152) return chr(($num >> 18) + 240) . chr((($num >> 12) & 63) + 128) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
+    if ($num < 128) {
+        return chr($num);
+    }
+    if ($num < 2048) {
+        return chr(($num >> 6) + 192) . chr(($num & 63) + 128);
+    }
+    if ($num < 65536) {
+        return chr(($num >> 12) + 224) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
+    }
+    if ($num < 2097152) {
+        return chr(($num >> 18) + 240) . chr((($num >> 12) & 63) + 128) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
+    }
     return '';
 }
 
@@ -4287,8 +4395,9 @@ 
  */
 function chartColors()
 {
-	if (SugarThemeRegistry::current()->getCSSURL('sugarColors.xml')=='')
-	return SugarThemeRegistry::current()->getImageURL('sugarColors.xml');
+	if (SugarThemeRegistry::current()->getCSSURL('sugarColors.xml')=='') {
+		return SugarThemeRegistry::current()->getImageURL('sugarColors.xml');
+	}
     return SugarThemeRegistry::current()->getCSSURL('sugarColors.xml');
 }
 /* End Chart Dashlet helper functions */
@@ -4319,8 +4428,9 @@ 
     if ( ( substr($path,0,2) == '\\\\' )
             || ( $path[0] == '/' )
             || preg_match('/^[A-z]:/i',$path)
-            || $currentServer )
-        return $path;
+            || $currentServer ) {
+            return $path;
+    }
 
     return getcwd().'/'.$path;
 }
@@ -4367,8 +4477,9 @@ 
  */
 function get_alt_hot_key() {
 	$ua = '';
-    if ( isset($_SERVER['HTTP_USER_AGENT']) )
-        $ua = strtolower($_SERVER['HTTP_USER_AGENT']);
+    if ( isset($_SERVER['HTTP_USER_AGENT']) ) {
+            $ua = strtolower($_SERVER['HTTP_USER_AGENT']);
+    }
 	$isMac = strpos($ua, 'mac') !== false;
 	$isLinux = strpos($ua, 'linux') !== false;
 
@@ -4412,11 +4523,12 @@ 
 {
     if ( !isset($GLOBALS['sugar_config']['allow_pop_inbound']) || ! $GLOBALS['sugar_config']['allow_pop_inbound'] )
     {
-        if( isset($protocol['pop3']) )
-			unset($protocol['pop3']);
+        if( isset($protocol['pop3']) ) {
+        			unset($protocol['pop3']);
+        }
+    } else {
+            $protocol['pop3'] = 'POP3';
     }
-    else
-        $protocol['pop3'] = 'POP3';
 
     return $protocol;
 }
@@ -4460,11 +4572,13 @@ 
 }
 
 function encodeMultienumValue($arr) {
-    if (!is_array($arr))
-        return $arr;
+    if (!is_array($arr)) {
+            return $arr;
+    }
 
-    if (empty($arr))
-        return "";
+    if (empty($arr)) {
+            return "";
+    }
 
 	$string = "^" . implode('^,^', $arr) . "^";
 
@@ -4496,16 +4610,14 @@ 
 			if(empty($join_type))
 			{
 				$params['join_type'] = ' LEFT JOIN ';
-			}
-			else
+			} else
 			{
 				$params['join_type'] = $join_type;
 			}
 			if(isset($data['join_name']))
 			{
 				$params['join_table_alias'] = $field['join_name'];
-			}
-			else
+			} else
 			{
 				$params['join_table_alias']	= 'join_'.$field['name'];
 
@@ -4513,8 +4625,7 @@ 
 			if(isset($data['join_link_name']))
 			{
 				$params['join_table_link_alias'] = $field['join_link_name'];
-			}
-			else
+			} else
 			{
 				$params['join_table_link_alias'] = 'join_link_'.$field['name'];
 			}
@@ -4523,7 +4634,7 @@ 
 			if(isset($field['db_concat_fields'])){
 				$db_field = db_concat($join_table_alias, $field['db_concat_fields']);
 				$where = preg_replace('/'.$field['name'].'/', $db_field, $where);
-			}else{
+			} else{
 				$where = preg_replace('/(^|[\s(])' . $field['name'] . '/', '${1}' . $join_table_alias . '.'.$field['rname'], $where);
 			}
 		}
@@ -4558,8 +4669,7 @@ 
 	$number = preg_match("/{$variable}=([a-zA-Z0-9_-]+)[&]?/", $string, $matches);
 	if($number){
 		return $matches[1];
-	}
-	else{
+	} else{
 		return false;
 	}
 }
@@ -4591,7 +4701,7 @@ 
 function getVersionStatus($version){
 	if(preg_match('/^[\d\.]+?([a-zA-Z]+?)[\d]*?$/si', $version, $matches)) {
 		return strtoupper($matches[1]);
-	}else{
+	} else{
 		return 'GA';
 	}
 }
@@ -4686,7 +4796,9 @@ 
 	} else {
 	    // check image manually
         $fp = fopen($path, "rb");
-        if(!$fp) return false;
+        if(!$fp) {
+            return false;
+        }
         $data = '';
         // read the whole file in chunks
         while(!feof($fp)) {
@@ -4778,8 +4890,9 @@ 
     // add wildcard at the beginning of the search string
     if (isset($GLOBALS['sugar_config']['search_wildcard_infront']) &&
         $GLOBALS['sugar_config']['search_wildcard_infront'] == true) {
-        if (substr($str,0,1) <> $wildcard)
-          $str = $wildcard.$str;
+        if (substr($str,0,1) <> $wildcard) {
+                  $str = $wildcard.$str;
+        }
     }
 
     // add wildcard at the end of search string (default)
@@ -4834,8 +4947,7 @@ 
 {
     if (isset($GLOBALS['app_list_strings'][$optionName])) {
         return $GLOBALS['app_list_strings'][$optionName];
-    }
-    else {
+    } else {
         return array();
     }
 }
@@ -5085,47 +5197,53 @@ 
 
 function suite_strlen($input, $encoding = DEFAULT_UTIL_SUITE_ENCODING)
 {
-	if(function_exists('mb_strlen'))
-		return mb_strlen($input,$encoding);
-	else
-		return strlen($input);
-}
+	if(function_exists('mb_strlen')) {
+			return mb_strlen($input,$encoding);
+	} else {
+			return strlen($input);
+	}
+	}
 
 function suite_substr($input, $start, $length = null,$encoding = DEFAULT_UTIL_SUITE_ENCODING)
 {
-	if(function_exists('mb_substr'))
-		return mb_substr($input,$start,$length,$encoding);
-	else
-		return substr($input,$start,$length);
-}
+	if(function_exists('mb_substr')) {
+			return mb_substr($input,$start,$length,$encoding);
+	} else {
+			return substr($input,$start,$length);
+	}
+	}
 
 function suite_strtoupper($input,$encoding = DEFAULT_UTIL_SUITE_ENCODING)
 {
-	if(function_exists('mb_strtoupper'))
-		return mb_strtoupper($input,$encoding);
-	else
-		return strtoupper($input);
-}
+	if(function_exists('mb_strtoupper')) {
+			return mb_strtoupper($input,$encoding);
+	} else {
+			return strtoupper($input);
+	}
+	}
 function suite_strtolower($input,$encoding = DEFAULT_UTIL_SUITE_ENCODING)
 {
-	if(function_exists('mb_strtolower'))
-		return mb_strtolower($input,$encoding);
-	else
-		return strtolower($input);
-}
+	if(function_exists('mb_strtolower')) {
+			return mb_strtolower($input,$encoding);
+	} else {
+			return strtolower($input);
+	}
+	}
 
 function suite_strpos($haystack,$needle,$offset=0,$encoding = DEFAULT_UTIL_SUITE_ENCODING)
 {
-	if(function_exists('mb_strpos'))
-		return mb_strpos($haystack,$needle,$offset,$encoding);
-	else
-		return strpos($haystack,$needle,$offset);
-}
+	if(function_exists('mb_strpos')) {
+			return mb_strpos($haystack,$needle,$offset,$encoding);
+	} else {
+			return strpos($haystack,$needle,$offset);
+	}
+	}
 
 function suite_strrpos($haystack,$needle,$offset=0,$encoding = DEFAULT_UTIL_SUITE_ENCODING)
 {
-	if(function_exists('mb_strrpos'))
-		return mb_strrpos($haystack,$needle,$offset,$encoding);
-	else
-		return strrpos($haystack,$needle,$offset);
-}
\ No newline at end of file
+	if(function_exists('mb_strrpos')) {
+			return mb_strrpos($haystack,$needle,$offset,$encoding);
+	} else {
+			return strrpos($haystack,$needle,$offset);
+	}
+	}
\ No newline at end of file

Doc Comments +73 added lines, -7 removed lines

@@ -829,6 +829,7 @@ 
  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  * All Rights Reserved.
  * Contributor(s): ______________________________________..
+ * @param boolean $always_copy
  */
 function safe_map_named($request_var, & $focus, $member_var, $always_copy)
 {
@@ -1248,6 +1249,7 @@ 
  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  * All Rights Reserved.
  * Contributor(s): ______________________________________..
+ * @param string $varname
  */
 function return_session_value_or_default($varname, $default)
 {
@@ -1358,6 +1360,9 @@ 
 
 }
 
+/**
+ * @param integer $characters
+ */
 function create_guid_section($characters)
 {
 	$return = "";
@@ -1368,6 +1373,10 @@ 
 	return $return;
 }
 
+/**
+ * @param string $string
+ * @param integer $length
+ */
 function ensure_length(&$string, $length)
 {
 	$strlen = strlen($string);
@@ -1475,6 +1484,9 @@ 
 
 
 // Check if user is admin for a specific module.
+/**
+ * @param string $module
+ */
 function is_admin_for_module($user,$module) {
     if (!isset($user)) {
         return false;
@@ -1535,6 +1547,7 @@ 
  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  * All Rights Reserved.
  * Contributor(s): ______________________________________..
+ * @param string $selected
  */
 function get_select_options ($option_list, $selected) {
 	return get_select_options_with_id($option_list, $selected);
@@ -1822,7 +1835,7 @@ 
 
 /**
  * returns a default array of XSS tags to clean
- * @return array
+ * @return string
  */
 function getDefaultXssTags() {
 	$tmp = array(
@@ -1849,6 +1862,7 @@ 
 /**
  * Remove potential xss vectors from strings
  * @param string str String to search for XSS attack vectors
+ * @param string $str
  * @deprecated
  * @return string
  */
@@ -1862,6 +1876,7 @@ 
  * @deprecated
  * @param string str String to search for XSS attack vectors
  * @param bool cleanImg Flag to allow <img> tags to survive - only used by InboundEmail for inline images.
+ * @param string $str
  * @return array Array of matches, empty on clean string
  */
 function clean_xss($str, $cleanImg=true) {
@@ -1938,6 +1953,7 @@ 
  * Helper function used by clean_xss() to parse for known-bad vectors
  * @param string pattern Regex pattern to use
  * @param string str String to parse for badness
+ * @param string $pattern
  * @return array
  */
 function xss_check_pattern($pattern, $str) {
@@ -2022,6 +2038,7 @@ 
 
 /**
  * cleans the given key in superglobals $_GET, $_POST, $_REQUEST
+ * @param string $key
  */
 function clean_superglobals($key, $filter = 'STANDARD') {
 	if(isset($_GET[$key])) clean_string($_GET[$key], $filter);
@@ -2029,6 +2046,9 @@ 
 	if(isset($_REQUEST[$key])) clean_string($_REQUEST[$key], $filter);
 }
 
+/**
+ * @param string $key
+ */
 function set_superglobals($key, $val){
 	$_GET[$key] = $val;
 	$_POST[$key] = $val;
@@ -2108,11 +2128,18 @@ 
 }
 
 // Returns TRUE if $str begins with $begin
+/**
+ * @param string $begin
+ */
 function str_begin($str, $begin) {
 	return (substr($str, 0, strlen($begin)) == $begin);
 }
 
 // Returns TRUE if $str ends with $end
+/**
+ * @param string $str
+ * @param string $end
+ */
 function str_end($str, $end) {
 	return (substr($str, strlen($str) - strlen($end)) == $end);
 }
@@ -2170,14 +2197,24 @@ 
 }
 
 
+/**
+ * @param string $category
+ */
 function set_register_value($category, $name, $value){
     return sugar_cache_put("{$category}:{$name}", $value);
 }
 
+/**
+ * @param string $category
+ */
 function get_register_value($category,$name){
     return sugar_cache_retrieve("{$category}:{$name}");
 }
 
+/**
+ * @param string $category
+ * @param string $name
+ */
 function clear_register_value($category,$name){
     return sugar_cache_clear("{$category}:{$name}");
 }
@@ -2379,6 +2416,11 @@ 
 	return $new_array;
 }
 
+/**
+ * @param DBManager $db
+ * @param string $from_column
+ * @param string $to_id
+ */
 function clone_relationship(&$db, $tables = array(), $from_column, $from_id, $to_id)
 {
 	foreach($tables as $table)
@@ -2556,6 +2598,10 @@ 
 	return empty($value) && $value != '0';
 }
 
+/**
+ * @param string $bean_name
+ * @param string $display_columns
+ */
 function get_bean_select_array($add_blank=true, $bean_name, $display_columns, $where='', $order_by='', $blank_is_none=false)
 {
 	global $beanFiles;
@@ -2746,6 +2792,11 @@ 
 	//end function js_escape
 }
 
+/**
+ * @param string $str
+ *
+ * @return string
+ */
 function br2nl($str) {
 	$regex = "#<[^>]+br.+?>#i";
 	preg_match_all($regex, $str, $matches);
@@ -3265,6 +3316,9 @@ 
 
 	set_error_handler('StackTraceErrorHandler');
 }
+/**
+ * @param string $name
+ */
 function get_sub_cookies($name){
 	$cookies = array();
 	if(isset($_COOKIE[$name])){
@@ -3306,6 +3360,7 @@ 
 
 /**
  * For translating the php.ini memory values into bytes.  e.g. input value of '8M' will return 8388608.
+ * @param string $val
  */
 function return_bytes($val)
 {
@@ -3413,6 +3468,9 @@ 
  * Given the bean_name which may be plural or singular return the singular
  * bean_name. This is important when you need to include files.
  */
+/**
+ * @return string
+ */
 function get_singular_bean_name($bean_name){
 	global $beanFiles, $beanList;
 	if(array_key_exists($bean_name, $beanList)){
@@ -3457,6 +3515,9 @@ 
     return $singular;
 }
 
+/**
+ * @return string
+ */
 function get_label($label_tag, $temp_module_strings){
 	global $app_strings;
 	if(!empty($temp_module_strings[$label_tag])){
@@ -3562,7 +3623,7 @@ 
 /**
  * In order to have one place to obtain the proper object name. aCase for example causes issues throughout the application.
  *
- * @param string $moduleName
+ * @param string $module_name
  */
 function get_valid_bean_name($module_name){
 	global $beanList;
@@ -4139,6 +4200,9 @@ 
  * @return string Relative pathname of the located icon, or '' if not found
  */
 
+/**
+ * @param string $iconFileName
+ */
 function _getIcon($iconFileName)
 {
 
@@ -4163,7 +4227,7 @@ 
 /**
  * Function to grab the correct icon image for Studio
  * @param string $iconFileName Name of the icon file
- * @param string $altfilename Name of a fallback icon file (displayed if the imagefilename doesn't exist)
+ * @param string $altFileName Name of a fallback icon file (displayed if the imagefilename doesn't exist)
  * @param string $width Width of image
  * @param string $height Height of image
  * @param string $align Alignment of image
@@ -4188,7 +4252,6 @@ 
 
 /**
  * Function to grab the correct icon image for Dashlets Dialog
- * @param string $filename Location of the icon file
  * @param string $module Name of the module to fall back onto if file does not exist
  * @param string $width Width of image
  * @param string $height Height of image
@@ -4601,7 +4664,7 @@ 
  * 5.5.1RC1 then return 5.5.1
  *
  * @param string $version
- * @return version
+ * @return string
  */
 function getMajorMinorVersion($version){
 	if(preg_match('/^([\d\.]+).*$/si', $version, $matches2)){
@@ -4751,6 +4814,9 @@ 
     }
 }
 
+/**
+ * @param string $field_name
+ */
 function order_beans($beans, $field_name)
 {
     //Since php 5.2 doesn't include closures, we must use a global to pass the order field to cmp_beans.
@@ -4885,7 +4951,7 @@ 
  * otherwise it return $file
  *
  * @param $file String of filename to check
- * @return $file String of filename including custom directory if found
+ * @return string String of filename including custom directory if found
  */
 function get_custom_file_if_exists($file)
 {
@@ -5037,7 +5103,7 @@ 
 /**
  * Gets the list of "*type_display*".
  * 
- * @return array
+ * @return string[]
  */
 function getTypeDisplayList()
 {

include/Popups/PopupSmarty.php

Braces +45 added lines, -25 removed lines

@@ -1,5 +1,7 @@ 
 <?php
-if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
+if(!defined('sugarEntry') || !sugarEntry) {
+    die('Not A Valid Entry Point');
+}
 /*********************************************************************************
  * SugarCRM Community Edition is a customer relationship management program developed by
  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
@@ -128,8 +130,9 @@ 
         foreach($this->displayColumns as $name => $params) {
             $this->displayColumns[$name]['width'] = round($this->displayColumns[$name]['width'] / $adjustment, 2);
             // figure out which contextMenu objectsTypes are required
-            if(!empty($params['contextMenu']['objectType']))
-                $contextMenuObjectsTypes[$params['contextMenu']['objectType']] = true;
+            if(!empty($params['contextMenu']['objectType'])) {
+                            $contextMenuObjectsTypes[$params['contextMenu']['objectType']] = true;
+            }
         }
 		$this->th->ss->assign('displayColumns', $this->displayColumns);
 
@@ -147,10 +150,17 @@ 
 		$this->th->ss->assign('searchForm', $this->searchForm->display(false));
         //rrs
 
-		if($this->export) $this->th->ss->assign('exportLink', $this->buildExportLink());
+		if($this->export) {
+		    $this->th->ss->assign('exportLink', $this->buildExportLink());
+		}
 		$this->th->ss->assign('quickViewLinks', $this->quickViewLinks);
-		if($this->mailMerge) $this->th->ss->assign('mergeLink', $this->buildMergeLink()); // still check for mailmerge access
-		if($this->mergeduplicates) $this->th->ss->assign('mergedupLink', $this->buildMergeDuplicatesLink());
+		if($this->mailMerge) {
+		    $this->th->ss->assign('mergeLink', $this->buildMergeLink());
+		}
+		// still check for mailmerge access
+		if($this->mergeduplicates) {
+		    $this->th->ss->assign('mergedupLink', $this->buildMergeDuplicatesLink());
+		}
 
 
 		if (!empty($_REQUEST['mode']) && strtoupper($_REQUEST['mode']) == 'MULTISELECT') {
@@ -301,7 +311,7 @@ 
 
 		if(file_exists('custom/modules/'.$this->module.'/metadata/metafiles.php')){
 			require('custom/modules/'.$this->module.'/metadata/metafiles.php');
-		}elseif(file_exists('modules/'.$this->module.'/metadata/metafiles.php')){
+		} elseif(file_exists('modules/'.$this->module.'/metadata/metafiles.php')){
 			require('modules/'.$this->module.'/metadata/metafiles.php');
 		}
 
@@ -321,21 +331,24 @@ 
 		$displayColumns = array();
 		if(!empty($_REQUEST['displayColumns'])) {
 		    foreach(explode('|', $_REQUEST['displayColumns']) as $num => $col) {
-		        if(!empty($listViewDefs[$this->module][$col]))
-		            $displayColumns[$col] = $this->listviewdefs[$this->module][$col];
+		        if(!empty($listViewDefs[$this->module][$col])) {
+		        		            $displayColumns[$col] = $this->listviewdefs[$this->module][$col];
+		        }
 		    }
-		}
-		else {
+		} else {
 		    foreach($this->listviewdefs[$this->module] as $col => $para) {
-		        if(!empty($para['default']) && $para['default'])
-		            $displayColumns[$col] = $para;
+		        if(!empty($para['default']) && $para['default']) {
+		        		            $displayColumns[$col] = $para;
+		        }
 		    }
 		}
 		$params['massupdate'] = true;
 		if(!empty($_REQUEST['orderBy'])) {
 		    $params['orderBy'] = $_REQUEST['orderBy'];
 		    $params['overrideOrder'] = true;
-		    if(!empty($_REQUEST['sortOrder'])) $params['sortOrder'] = $_REQUEST['sortOrder'];
+		    if(!empty($_REQUEST['sortOrder'])) {
+		        $params['sortOrder'] = $_REQUEST['sortOrder'];
+		    }
 		}
 
 		$lv->displayColumns = $displayColumns;
@@ -453,7 +466,9 @@ 
 
         // Need to include the default whereStatement
 		if(!empty($this->_popupMeta['whereStatement'])){
-            if(!empty($where))$where .= ' AND ';
+            if(!empty($where)) {
+                $where .= ' AND ';
+            }
             $where .= $this->_popupMeta['whereStatement'];
 		}
 
@@ -472,11 +487,13 @@ 
 				$this->formData[] = array('field' => $data);
 				$value = '';
 				$this->customFieldDefs[$data['name']]= $data;
-				if(!empty($_REQUEST[$data['name']]))
-	            	$value = $_REQUEST[$data['name']];
+				if(!empty($_REQUEST[$data['name']])) {
+					            	$value = $_REQUEST[$data['name']];
+				}
 	            $this->customFieldDefs[$data['name']]['value'] = $value;
-			}else
-				$this->formData[] = array('field' => array('name'=>$data));
+			} else {
+							$this->formData[] = array('field' => array('name'=>$data));
+			}
 		}
 		$this->fieldDefs = array();
 		if($this->seed){
@@ -487,13 +504,15 @@ 
 	            //if we have a relate type then reset to name so that we end up with a textbox
 	            //rather than a select button
 	            $this->fieldDefs[$name]['name'] = $this->fieldDefs[$name]['name'];
-	            if($this->fieldDefs[$name]['type'] == 'relate')
-	            	$this->fieldDefs[$name]['type'] = 'name';
+	            if($this->fieldDefs[$name]['type'] == 'relate') {
+	            	            	$this->fieldDefs[$name]['type'] = 'name';
+	            }
 	            if(isset($this->fieldDefs[$name]['options']) && isset($GLOBALS['app_list_strings'][$this->fieldDefs[$name]['options']])) {
 	                $this->fieldDefs[$name]['options'] = $GLOBALS['app_list_strings'][$this->fieldDefs[$name]['options']]; // fill in enums
 	            }
-	            if(!empty($_REQUEST[$name]))
-	            	$value = $_REQUEST[$name];
+	            if(!empty($_REQUEST[$name])) {
+	            	            	$value = $_REQUEST[$name];
+	            }
 	            $this->fieldDefs[$name]['value'] = $value;
 	        }
 		}
@@ -540,8 +559,9 @@ 
 EOQ;
 		// if metadata contains custom inputs for the quickcreate
 		if(!empty($this->_popupMeta['customInput']) && is_array($this->_popupMeta['customInput'])) {
-			foreach($this->_popupMeta['customInput'] as $key => $value)
-				$formSave .= '<input type="hidden" name="' . $key . '" value="'. $value .'">\n';
+			foreach($this->_popupMeta['customInput'] as $key => $value) {
+							$formSave .= '<input type="hidden" name="' . $key . '" value="'. $value .'">\n';
+			}
 		}
 
 

Doc Comments +4 added lines

@@ -70,6 +70,9 @@ 
     var $module;
     var $massUpdateData = '';
 
+	/**
+	 * @param string $module
+	 */
 	function PopupSmarty($seed, $module){
 		parent::ListViewSmarty();
 		$this->th = new TemplateHandler();
@@ -108,6 +111,7 @@ 
      * @param file file Template file to use
      * @param data array from ListViewData
      * @param html_var string the corresponding html var in xtpl per row
+     * @param string $htmlVar
      *
      */
 	function process($file, $data, $htmlVar) {