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/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/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) {

include/SubPanel/SubPanelDefinitions.php

Braces +60 added lines, -39 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.
@@ -85,7 +87,9 @@ 
 
 		$this->_instance_properties = $instance_properties ;
 
-		if(isset($instance_properties['collection_list' ])) $this->base_collection_list = $instance_properties['collection_list' ];
+		if(isset($instance_properties['collection_list' ])) {
+		    $this->base_collection_list = $instance_properties['collection_list' ];
+		}
 
 		if(!empty($collections) && isset($instance_properties['collection_list' ])){
 			foreach($instance_properties['collection_list' ] as $cname => $value){
@@ -277,7 +281,9 @@ 
 				}
 			}
 			// if it's empty just dump out as there is nothing to process.
-			if(empty($this->sub_subpanels)) return false;
+			if(empty($this->sub_subpanels)) {
+			    return false;
+			}
 			//Sync displayed list fields across the subpanels
 			$display_fields = $this->getDisplayFieldsFromCollection($this->sub_subpanels);
 			$query_fields = array();
@@ -291,10 +297,11 @@ 
 					if (isset($def['vname']) && isset($def['width']))
 					{
 						$index++;
-						if(!empty($def['alias']))
-							$listFieldMap[$key][$def['alias']] = $field;
-						else
-							$listFieldMap[$key][$field] = $field;
+						if(!empty($def['alias'])) {
+													$listFieldMap[$key][$def['alias']] = $field;
+						} else {
+													$listFieldMap[$key][$field] = $field;
+						}
 						if (!isset($display_fields[$def['vname']]))
 						{
 							if(sizeof($display_fields) > $index)
@@ -332,13 +339,11 @@ 
 					if (isset($subpanel->panel_definition['list_fields'][$field]))
 					{
 						$list_fields[$field] = $subpanel->panel_definition['list_fields'][$field];
-					}
-					else if ($list_key != $field && isset($subpanel->panel_definition['list_fields'][$list_key]))
+					} else if ($list_key != $field && isset($subpanel->panel_definition['list_fields'][$list_key]))
 					{
 						$list_fields[$list_key] = $subpanel->panel_definition['list_fields'][$list_key];
 
-					}
-					else {
+					} else {
 						$list_fields[$field] = $display_fields[$vname];
 					}
 				}
@@ -347,8 +352,7 @@ 
 					if (isset($subpanel->panel_definition['list_fields'][$field]))
 					{
 						$list_fields[$field] = $subpanel->panel_definition['list_fields'][$field];
-					}
-					else {
+					} else {
 						$list_fields[$field] = $def;
 					}
 				}
@@ -624,18 +628,22 @@ 
 		global $modListHeader ;
 		global $modules_exempt_from_availability_check ;
 
-		if (isset ( $this->_visible_tabs_array ))
-			return $this->_visible_tabs_array ;
+		if (isset ( $this->_visible_tabs_array )) {
+					return $this->_visible_tabs_array ;
+		}
 
-		if (empty($modListHeader))
-		    $modListHeader = query_module_access_list($GLOBALS['current_user']);
+		if (empty($modListHeader)) {
+				    $modListHeader = query_module_access_list($GLOBALS['current_user']);
+		}
 
 		$this->_visible_tabs_array = array ( ) ; // bug 16820 - make sure this is an array for the later ksort
 
-		if (isset ( $this->layout_defs [ 'subpanel_setup' ] )) // bug 17434 - belts-and-braces - check that we have some subpanels first
+		if (isset ( $this->layout_defs [ 'subpanel_setup' ] )) {
+		    // bug 17434 - belts-and-braces - check that we have some subpanels first
 		{
 			//retrieve list of hidden subpanels
 			$hidden_panels = $this->get_hidden_subpanels();
+		}
 
 			//activities is a special use case in that if it is hidden,
 			//then the history tab should be hidden too.
@@ -648,8 +656,9 @@ 
 			{
 				//exclude if this subpanel is hidden from admin screens
                 $module = $key;
-                if ( isset($values_array['module']) )
-                    $module = strtolower($values_array['module']);
+                if ( isset($values_array['module']) ) {
+                                    $module = strtolower($values_array['module']);
+                }
 				 if ($hidden_panels && is_array($hidden_panels) && (in_array($module, $hidden_panels) || array_key_exists($module, $hidden_panels)) ){
 				 	//this panel is hidden, skip it
 				 	continue;
@@ -696,8 +705,9 @@ 
 	 */
 	function load_subpanel ( $name , $reload = false , $original_only = false, $search_query = '', $collections = array() )
 	{
-		if (!is_dir('modules/' . $this->layout_defs [ 'subpanel_setup' ][ strtolower ( $name ) ] [ 'module' ]))
-			return false;
+		if (!is_dir('modules/' . $this->layout_defs [ 'subpanel_setup' ][ strtolower ( $name ) ] [ 'module' ])) {
+					return false;
+		}
 
 		$subpanel = new aSubPanel ( $name, $this->layout_defs [ 'subpanel_setup' ] [ strtolower ( $name ) ], $this->_focus, $reload, $original_only, $search_query, $collections ) ;
 
@@ -720,16 +730,19 @@ 
 
 		if (empty ( $this->layout_defs ) || $reload || (! empty ( $layout_def_key ) && ! isset ( $layout_defs [ $layout_def_key ] )))
 		{
-			if (file_exists ( 'modules/' . $this->_focus->module_dir . '/metadata/subpaneldefs.php' ))
-				require ('modules/' . $this->_focus->module_dir . '/metadata/subpaneldefs.php') ;
+			if (file_exists ( 'modules/' . $this->_focus->module_dir . '/metadata/subpaneldefs.php' )) {
+							require ('modules/' . $this->_focus->module_dir . '/metadata/subpaneldefs.php') ;
+			}
 
-			if (! $original_only && file_exists ( 'custom/modules/' . $this->_focus->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php' ))
-				require ('custom/modules/' . $this->_focus->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php') ;
+			if (! $original_only && file_exists ( 'custom/modules/' . $this->_focus->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php' )) {
+							require ('custom/modules/' . $this->_focus->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php') ;
+			}
 
-			if (! empty ( $layout_def_key ))
-				$this->layout_defs = $layout_defs [ $layout_def_key ] ;
-			else
-				$this->layout_defs = $layout_defs [ $this->_focus->module_dir ] ;
+			if (! empty ( $layout_def_key )) {
+							$this->layout_defs = $layout_defs [ $layout_def_key ] ;
+			} else {
+							$this->layout_defs = $layout_defs [ $this->_focus->module_dir ] ;
+			}
 
 		}
 
@@ -785,11 +798,15 @@ 
 		foreach($modules_to_check as $mod_name){
 
 			//skip if module name is not in bean list, otherwise get the bean class name
-			if(!isset($beanList[$mod_name])) continue;
+			if(!isset($beanList[$mod_name])) {
+			    continue;
+			}
 			$class = $beanList[$mod_name];
 
 			//skip if class name is not in file list, otherwise require the bean file and create new class
-			if(!isset($beanFiles[$class]) || !file_exists($beanFiles[$class])) continue;
+			if(!isset($beanFiles[$class]) || !file_exists($beanFiles[$class])) {
+			    continue;
+			}
 
 			//retrieve subpanels for this bean
 			require_once($beanFiles[$class]);
@@ -803,15 +820,20 @@ 
 			foreach( $sub_tabs as $panel_key){
 				$panel_key = strtolower($panel_key);
                 $panel_module = $panel_key;
-                if ( isset($spd->layout_defs['subpanel_setup'][$panel_key]['module']) )
-                    $panel_module = strtolower($spd->layout_defs['subpanel_setup'][$panel_key]['module']);
+                if ( isset($spd->layout_defs['subpanel_setup'][$panel_key]['module']) ) {
+                                    $panel_module = strtolower($spd->layout_defs['subpanel_setup'][$panel_key]['module']);
+                }
                 //if module_only flag is set, only if it is also in module array
-				if($return_tab_modules_only && !array_key_exists($panel_module, $modules_to_check)) continue;
+				if($return_tab_modules_only && !array_key_exists($panel_module, $modules_to_check)) {
+				    continue;
+				}
 				$panel_key_name = $panel_module;
 
 				//group_by_key_name is set to true, then array will hold an entry for each
 				//subpanel, with the module name prepended in the key
-				if($group_by_module) $panel_key_name = $class.'_'.$panel_key_name;
+				if($group_by_module) {
+				    $panel_key_name = $class.'_'.$panel_key_name;
+				}
 				//add panel name to subpanel array
 				$spd_arr[$panel_key_name] = $panel_module;
 			}
@@ -864,12 +886,11 @@ 
 					}
 
 
-				}else{
+				} else{
 					//no settings found, return empty
 					return $hidden_subpanels;
 				}
-			}
-			else
+			} else
 			{	//no settings found, return empty
 				return $hidden_subpanels;
 			}

Doc Comments +8 added lines

@@ -417,11 +417,19 @@
 	}
 
 	//get value of a property defined at the panel instance level.
+
+	/**
+	 * @param string $name
+	 */
 	function get_inst_prop_value ( $name )
 	{
 		return isset($this->_instance_properties[$name]) ? $this->_instance_properties [ $name ] : null;
 	}
 	//get value of a property defined at the panel definition level.
+
+	/**
+	 * @param string $name
+	 */
 	function get_def_prop_value ( $name )
 	{
 		if (isset ( $this->panel_definition [ $name ] ))

include/SubPanel/SubPanel.php

Braces +20 added lines, -12 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.
@@ -141,8 +143,7 @@ 
 			if(empty($widget_data['widget_class']))
 			{
 				$widget_contents .= "widget_class not defined for top subpanel buttons";
-			}
-			else
+			} else
 			{
 				$widget_contents .= $layout_manager->widgetDisplay($widget_data);
 			}
@@ -163,7 +164,7 @@ 
 
 		if(isset($this->listview)){
 			$ListView =& $this->listview;
-		}else{
+		} else{
 			$ListView = new ListView();
 		}
 		$ListView->initNewXTemplate($xTemplatePath,$this->subpanel_defs->mod_strings);
@@ -178,7 +179,9 @@ 
 		$ListView->xTemplateAssign("SUBPANEL_ID", $this->subpanel_id);
 		$ListView->xTemplateAssign("SUBPANEL_SEARCH", $this->getSearchForm());
 		$display_sps = '';
-		if($this->search_query == '' && empty($this->collections)) $display_sps = 'display:none';
+		if($this->search_query == '' && empty($this->collections)) {
+		    $display_sps = 'display:none';
+		}
 		$ListView->xTemplateAssign("DISPLAY_SPS",$display_sps);
 
 		if(is_admin($current_user) && $_REQUEST['module'] != 'DynamicLayout' && !empty($_SESSION['editinplace']))
@@ -311,10 +314,12 @@ 
   		$moduleInstaller = new ModuleInstaller();
   		$moduleInstaller->silent = true; // make sure that the ModuleInstaller->log() function doesn't echo while rebuilding the layoutdefs
   		$moduleInstaller->rebuild_layoutdefs();
-  		if (file_exists('modules/'.  $panel->parent_bean->module_dir . '/layout_defs.php'))
-  			include('modules/'.  $panel->parent_bean->module_dir . '/layout_defs.php');
-  		if (file_exists('custom/modules/'.  $panel->parent_bean->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php'))
-  			include('custom/modules/'.  $panel->parent_bean->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php');
+  		if (file_exists('modules/'.  $panel->parent_bean->module_dir . '/layout_defs.php')) {
+  		  			include('modules/'.  $panel->parent_bean->module_dir . '/layout_defs.php');
+  		}
+  		if (file_exists('custom/modules/'.  $panel->parent_bean->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php')) {
+  		  			include('custom/modules/'.  $panel->parent_bean->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php');
+  		}
   }
 
 	function get_subpanel_setup($module)
@@ -400,7 +405,9 @@ 
 
 		$where_clauses = $searchForm->generateSearchWhere(true, $seed->module_dir);
 
-		if (count($where_clauses) > 0 )$this->search_query = '('. implode(' ) AND ( ', $where_clauses) . ')';
+		if (count($where_clauses) > 0 ) {
+		    $this->search_query = '('. implode(' ) AND ( ', $where_clauses) . ')';
+		}
 		$GLOBALS['log']->info("Subpanel Where Clause: $this->search_query");
 
 		return print_r($where_clauses,true);
@@ -436,8 +443,9 @@ 
 
 			$searchForm->setup($subpanel_searchMetaData, $searchMetaData['searchFields'], 'SubpanelSearchFormGeneric.tpl', 'basic_search');
 
-			if(!empty($this->collections))
-				$searchForm->searchFields['collection'] = array();
+			if(!empty($this->collections)) {
+							$searchForm->searchFields['collection'] = array();
+			}
 
 			$searchForm->populateFromRequest();
 

Doc Comments +10 added lines

@@ -102,6 +102,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $template_file
+	 */
 	function setTemplateFile($template_file)
 	{
 		$this->template_file = $template_file;
@@ -271,6 +274,10 @@ 
   }
 
   //saves overrides for defs
+
+  /**
+   * @param string $subsection
+   */
   function saveSubPanelDefOverride( $panel, $subsection, $override){
   		global $layout_defs, $beanList;
 
@@ -406,6 +413,9 @@ 
 		return print_r($where_clauses,true);
 	}
 
+	/**
+	 * @param string $module
+	 */
 	function get_searchdefs($module)
 	{
 		$thisPanel =& $this->subpanel_defs;