adamjakab / SuiteCRM

modules/ModuleBuilder/parsers/parser.modifylistview.php

Indentation +262 added lines, -262 removed lines

@@ -43,144 +43,144 @@ 
 require_once ('modules/ModuleBuilder/parsers/ModuleBuilderParser.php') ;
 class ParserModifyListView extends ModuleBuilderParser
 {
-	var $listViewDefs = false ;
-	var $defaults = array ( ) ;
-	var $additional = array ( ) ;
-	var $available = array ( ) ;
-	var $reserved = array(); // fields marked by 'studio'=>false in the listviewdefs; need to be preserved
-	//	var $language_module = '';
-	var $columns = array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' ) ;
-	function init ( $module_name , $submodule = '' )
-	{
-		global $app_list_strings ;
-		$this->module_name = $module_name ;
-		$mod_strings = return_module_language ( $GLOBALS [ 'current_language' ], $this->module_name ) ; // needed solely so that listviewdefs that reference this can be included without error
-		$class = $GLOBALS [ 'beanList' ] [ $this->module_name ] ;
-		require_once ($GLOBALS [ 'beanFiles' ] [ $class ]) ;
-		$this->module = new $class ( ) ;
+    var $listViewDefs = false ;
+    var $defaults = array ( ) ;
+    var $additional = array ( ) ;
+    var $available = array ( ) ;
+    var $reserved = array(); // fields marked by 'studio'=>false in the listviewdefs; need to be preserved
+    //	var $language_module = '';
+    var $columns = array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' ) ;
+    function init ( $module_name , $submodule = '' )
+    {
+        global $app_list_strings ;
+        $this->module_name = $module_name ;
+        $mod_strings = return_module_language ( $GLOBALS [ 'current_language' ], $this->module_name ) ; // needed solely so that listviewdefs that reference this can be included without error
+        $class = $GLOBALS [ 'beanList' ] [ $this->module_name ] ;
+        require_once ($GLOBALS [ 'beanFiles' ] [ $class ]) ;
+        $this->module = new $class ( ) ;
 
-		$loaded = $this->_loadFromFile('ListView','modules/' . $this->module_name . '/metadata/listviewdefs.php',$this->module_name);
-		$this->originalListViewDefs = $loaded['viewdefs'] [ $this->module_name ] ;
-		$this->_variables = $loaded['variables'];
-		//		_pp($loaded);
-		$this->customFile = 'custom/modules/' . $this->module_name . '/metadata/listviewdefs.php' ;
-		if (file_exists ( $this->customFile ))
-		{
-			$loaded = $this->_loadFromFile('ListView',$this->customFile,$this->module_name);
-			$this->listViewDefs = $loaded['viewdefs'] [ $this->module_name ] ;
-			$this->_variables = $loaded['variables'];
-		} else
-		{
-			$this->listViewDefs = & $this->originalListViewDefs ;
-		}
+        $loaded = $this->_loadFromFile('ListView','modules/' . $this->module_name . '/metadata/listviewdefs.php',$this->module_name);
+        $this->originalListViewDefs = $loaded['viewdefs'] [ $this->module_name ] ;
+        $this->_variables = $loaded['variables'];
+        //		_pp($loaded);
+        $this->customFile = 'custom/modules/' . $this->module_name . '/metadata/listviewdefs.php' ;
+        if (file_exists ( $this->customFile ))
+        {
+            $loaded = $this->_loadFromFile('ListView',$this->customFile,$this->module_name);
+            $this->listViewDefs = $loaded['viewdefs'] [ $this->module_name ] ;
+            $this->_variables = $loaded['variables'];
+        } else
+        {
+            $this->listViewDefs = & $this->originalListViewDefs ;
+        }
 
-		$this->fixKeys ( $this->originalListViewDefs ) ;
-		$this->fixKeys ( $this->listViewDefs ) ;
-		$this->language_module = $this->module_name ;
-	}
+        $this->fixKeys ( $this->originalListViewDefs ) ;
+        $this->fixKeys ( $this->listViewDefs ) ;
+        $this->language_module = $this->module_name ;
+    }
 	
-	function getLanguage()
-	{
-	    return $this->language_module;
-	}
-	// re-key array so that every entry has a key=name and all keys are lowercase - makes it easier in handleSave() later...
-	function fixKeys ( &$defs )
-	{
-		$temp = array ( ) ;
-		foreach ( $defs as $key => $value )
-		{
-			if (! is_array ( $value ))
-			{
-				$key = $value ;
-				$def = array ( ) ;
-				$def [ 'name' ] = (isset ( $this->module->field_defs [ $key ] )) ? $this->module->field_defs [ $key ] [ 'name' ] : $key ;
-				$value = $def ;
-			}
-			if (isset ( $value [ 'name' ] ))
-			{
-				$key = $value [ 'name' ] ; // override key with name, needed when the entry lacks a key
-			}
-			$temp [ strtolower ( $key ) ] = $value ;
-		}
-		$defs = $temp ;
-	}
+    function getLanguage()
+    {
+        return $this->language_module;
+    }
+    // re-key array so that every entry has a key=name and all keys are lowercase - makes it easier in handleSave() later...
+    function fixKeys ( &$defs )
+    {
+        $temp = array ( ) ;
+        foreach ( $defs as $key => $value )
+        {
+            if (! is_array ( $value ))
+            {
+                $key = $value ;
+                $def = array ( ) ;
+                $def [ 'name' ] = (isset ( $this->module->field_defs [ $key ] )) ? $this->module->field_defs [ $key ] [ 'name' ] : $key ;
+                $value = $def ;
+            }
+            if (isset ( $value [ 'name' ] ))
+            {
+                $key = $value [ 'name' ] ; // override key with name, needed when the entry lacks a key
+            }
+            $temp [ strtolower ( $key ) ] = $value ;
+        }
+        $defs = $temp ;
+    }
 	
-	/**
-	 * returns the default fields for a listview
-	 * Called only when displaying the listview for editing; not called when saving
-	 */
-	function getDefaultFields ()
-	{
-		$this->defaults = array ( ) ;
-		foreach ( $this->listViewDefs as $key => $def )
-		{
-		    // add in the default fields from the listviewdefs, stripping out any field with 'studio' set to a value other than true
-		    // Important: the 'studio' fields must be added back into the layout on save, as they're not editable rather than hidden
-			if (! empty ( $def [ 'default' ] ))
-			{
-			    if (! isset($def['studio']) || $def['studio'] === true)
-			    {
-			        $this->defaults [ $key ] = $def ;
-			    }
-			    else
-			    // anything which doesn't go into the defaults is a reserved field - this makes sure we don't miss anything
-			    {
-			        $this->reserved [ $key ] = $def;
-			    }
-			}
-		}
-		return $this->defaults ;
-	}
-	/**
-	 * returns additional fields available for users to create fields
-	 */
-	function getAdditionalFields ()
-	{
-		$this->additional = array ( ) ;
-		foreach ( $this->listViewDefs as $key => $def )
-		{
-			if (empty ( $def [ 'default' ] ))
-			{
-				$key = strtolower ( $key ) ;
-				$this->additional [ $key ] = $def ;
-			}
-		}
-		return $this->additional ;
-	}
-	/**
-	 * returns unused fields that are available for using in either default or additional list views
-	 */
-	function getAvailableFields ()
-	{
-		$this->availableFields = array ( ) ;
-		$lowerFieldList = array_change_key_case ( $this->listViewDefs ) ;
-		foreach ( $this->originalListViewDefs as $key => $def )
-		{
-			$key = strtolower ( $key ) ;
-			if (! isset ( $lowerFieldList [ $key ] ))
-			{
-				$this->availableFields [ $key ] = $def ;
-			}
-		}
-		$GLOBALS['log']->debug('parser.modifylistview.php->getAvailableFields(): field_defs='.print_r($this->availableFields,true));
-		$modFields = !empty($this->module->field_name_map) ? $this->module->field_name_map : $this->module->field_defs;
-		foreach ( $modFields as $key => $def )
-		{
-			$fieldName = strtolower ( $key ) ;
+    /**
+     * returns the default fields for a listview
+     * Called only when displaying the listview for editing; not called when saving
+     */
+    function getDefaultFields ()
+    {
+        $this->defaults = array ( ) ;
+        foreach ( $this->listViewDefs as $key => $def )
+        {
+            // add in the default fields from the listviewdefs, stripping out any field with 'studio' set to a value other than true
+            // Important: the 'studio' fields must be added back into the layout on save, as they're not editable rather than hidden
+            if (! empty ( $def [ 'default' ] ))
+            {
+                if (! isset($def['studio']) || $def['studio'] === true)
+                {
+                    $this->defaults [ $key ] = $def ;
+                }
+                else
+                // anything which doesn't go into the defaults is a reserved field - this makes sure we don't miss anything
+                {
+                    $this->reserved [ $key ] = $def;
+                }
+            }
+        }
+        return $this->defaults ;
+    }
+    /**
+     * returns additional fields available for users to create fields
+     */
+    function getAdditionalFields ()
+    {
+        $this->additional = array ( ) ;
+        foreach ( $this->listViewDefs as $key => $def )
+        {
+            if (empty ( $def [ 'default' ] ))
+            {
+                $key = strtolower ( $key ) ;
+                $this->additional [ $key ] = $def ;
+            }
+        }
+        return $this->additional ;
+    }
+    /**
+     * returns unused fields that are available for using in either default or additional list views
+     */
+    function getAvailableFields ()
+    {
+        $this->availableFields = array ( ) ;
+        $lowerFieldList = array_change_key_case ( $this->listViewDefs ) ;
+        foreach ( $this->originalListViewDefs as $key => $def )
+        {
+            $key = strtolower ( $key ) ;
+            if (! isset ( $lowerFieldList [ $key ] ))
+            {
+                $this->availableFields [ $key ] = $def ;
+            }
+        }
+        $GLOBALS['log']->debug('parser.modifylistview.php->getAvailableFields(): field_defs='.print_r($this->availableFields,true));
+        $modFields = !empty($this->module->field_name_map) ? $this->module->field_name_map : $this->module->field_defs;
+        foreach ( $modFields as $key => $def )
+        {
+            $fieldName = strtolower ( $key ) ;
             if ($fieldName == 'currency_id')
                 continue;
-			if (!isset ( $lowerFieldList [ $fieldName ] )) // bug 16728 - check this first, so that other conditions (e.g., studio == visible) can't override and add duplicate entries
-			{
+            if (!isset ( $lowerFieldList [ $fieldName ] )) // bug 16728 - check this first, so that other conditions (e.g., studio == visible) can't override and add duplicate entries
+            {
             // bug 19656: this test changed after 5.0.0b - we now remove all ID type fields - whether set as type, or dbtype, from the fielddefs
             if ($this->isValidField($key, $def)){
-					$label = (isset ( $def [ 'vname' ] )) ? $def [ 'vname' ] : (isset($def [ 'label' ]) ? $def['label'] : $def['name']) ;
-					$this->availableFields [ $fieldName ] = array ( 'width' => '10' , 'label' => $label ) ;
-				}
-			}
-		}
+                    $label = (isset ( $def [ 'vname' ] )) ? $def [ 'vname' ] : (isset($def [ 'label' ]) ? $def['label'] : $def['name']) ;
+                    $this->availableFields [ $fieldName ] = array ( 'width' => '10' , 'label' => $label ) ;
+                }
+            }
+        }
 
-		return $this->availableFields ;
-	}
+        return $this->availableFields ;
+    }
 
     function getFieldDefs()
     {
@@ -188,146 +188,146 @@ 
     }
 
 	
-	function isValidField($key, $def) {
-	    //Allow fields that are studio visible  
-		if (! empty ( $def [ 'studio' ] ) && $def [ 'studio' ] == 'visible')
-		  return true;
+    function isValidField($key, $def) {
+        //Allow fields that are studio visible  
+        if (! empty ( $def [ 'studio' ] ) && $def [ 'studio' ] == 'visible')
+            return true;
 		  
-		//No ID fields
-		if  ((!empty ( $def [ 'dbType' ] ) && $def [ 'dbType' ] == 'id') || (!empty ( $def [ 'type' ] ) && $def [ 'type' ] == 'id'))
-		  return false;
+        //No ID fields
+        if  ((!empty ( $def [ 'dbType' ] ) && $def [ 'dbType' ] == 'id') || (!empty ( $def [ 'type' ] ) && $def [ 'type' ] == 'id'))
+            return false;
 		  
-		//only allow DB and custom fields (if a source is specified)
-	    if (!empty($def [ 'source' ]) && $def [ 'source' ] != 'db' && $def [ 'source' ] != 'custom_fields')
-		  return false;
+        //only allow DB and custom fields (if a source is specified)
+        if (!empty($def [ 'source' ]) && $def [ 'source' ] != 'db' && $def [ 'source' ] != 'custom_fields')
+            return false;
 
-		//Dont ever show the "deleted" fields or "_name" fields
-		if (strcmp ( $key, 'deleted' ) == 0 || (isset ( $def [ 'name' ] ) && strpos ( $def [ 'name' ], "_name" ) !== false))
-	       return false;
+        //Dont ever show the "deleted" fields or "_name" fields
+        if (strcmp ( $key, 'deleted' ) == 0 || (isset ( $def [ 'name' ] ) && strpos ( $def [ 'name' ], "_name" ) !== false))
+            return false;
 
-	    //If none of the "ifs" are true, the field is valid
-	    return true;
-	}
+        //If none of the "ifs" are true, the field is valid
+        return true;
+    }
 	
 	
-	function getField ( $fieldName )
-	{
-		$fieldName = strtolower ( $fieldName ) ;
-		foreach ( $this->listViewDefs as $key => $def )
-		{
-			$key = strtolower ( $key ) ;
-			if ($key == $fieldName)
-			{
-				return $def ;
-			}
-		}
-		foreach ( $this->module->field_defs as $key => $def )
-		{
-			$key = strtolower ( $key ) ;
-			if ($key == $fieldName)
-			{
-				return $def ;
-			}
-		}
-		return array ( ) ;
-	}
-	function addRelateData($fieldname, $listfielddef) {
-		$modFieldDef = $this->module->field_defs [ strtolower ( $fieldname ) ];
-		if (!empty($modFieldDef['module']) && !empty($modFieldDef['id_name'])) {
-			$listfielddef['module'] = $modFieldDef['module'];
-			$listfielddef['id'] = strtoupper($modFieldDef['id_name']);
-			$listfielddef['link'] = true;
-			$listfielddef['related_fields'] = array (strtolower($modFieldDef['id_name']));
-		}
-		return $listfielddef;
-	}
-	function _loadLayoutFromRequest ()
-	{
-	    $GLOBALS['log']->debug("ParserModifyListView->_loadLayoutFromRequest()");
-		$fields = array ( ) ;
-		$rejectTypes = array ( 'html' , 'enum' , 'text' ) ;
-		for ( $i = 0 ; isset ( $_POST [ 'group_' . $i ] ) && $i < 2 ; $i ++ )
-		{
-			//echo "\n***group-$i Size:".sizeof($_POST['group_' . $i])."\n";
-			foreach ( $_POST [ 'group_' . $i ] as $field )
-			{
-				$fieldname = strtoupper ( $field ) ;
-				//originalListViewDefs are all lower case
-				$lowerFieldName = strtolower ( $field ) ;
-				if (isset ( $this->originalListViewDefs [ $lowerFieldName ] ))
-				{
-					$fields [ $fieldname ] = $this->originalListViewDefs [ $lowerFieldName ] ;
-				} else
-				{
-					//check if we have the case wrong for custom fields
-					if (! isset ( $this->module->field_defs [ $fieldname ] ))
-					{
-						foreach ( $this->module->field_defs as $key => $value )
-						{
-							if (strtoupper ( $key ) == $fieldname)
-							{
-								$fields [ $fieldname ] = array ( 'width' => 10 , 'label' => $this->module->field_defs [ $key ] [ 'vname' ] ) ;
-								break ;
-							}
-						}
-					} else
-					{
-						$fields [ $fieldname ] = array ( 'width' => 10 , 'label' => $this->module->field_defs [ $fieldname ] [ 'vname' ] ) ;
-					}
-					// sorting fields of certain types will cause a database engine problems
-					// we only check this for custom fields, as we assume that OOB fields have been independently confirmed as ok
-					if (isset ( $this->module->field_defs [ strtolower ( $fieldname ) ] ) && (in_array ( $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ], $rejectTypes ) || isset($this->module->field_defs [ strtolower ( $fieldname ) ]['custom_module'])))
-					{
-						$fields [ $fieldname ] [ 'sortable' ] = false ;
-					}
-					// Bug 23728 - Make adding a currency type field default to setting the 'currency_format' to true
-					if (isset ( $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type ' ] ) && $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ] == 'currency') 
-					{
-						$fields [ $fieldname ] [ 'currency_format' ] = true;
-					}
-				}
-				if (isset ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ] ))
-				{
-					$width = substr ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ], 6, 3 ) ;
-					if (strpos ( $width, "%" ) !== false)
-					{
-						$width = substr ( $width, 0, 2 ) ;
-					}
-					if ($width < 101 && $width > 0)
-					{
-						$fields [ $fieldname ] [ 'width' ] = $width ;
-					}
-				} else if (isset ( $this->listViewDefs [ $fieldname ] [ 'width' ] ))
-				{
-					$fields [ $fieldname ] [ 'width' ] = $this->listViewDefs [ $fieldname ] [ 'width' ] ;
-				}
-				//Get additional Data for relate fields
-				if (isset($this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ]) && $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ] == 'relate') {
-					$fields [ $fieldname ] = $this->addRelateData($field, $fields [ $fieldname ]);
-				}
-				$fields [ $fieldname ] [ 'default' ] = ($i == 0) ;
-			}
-		}
-		// Add the reserved fields back in to the end of the default fields in the layout
-		// ASSUMPTION: reserved fields go back at the end
-		// First, load the reserved fields - we cannot assume that getDefaultFields has been called earlier when saving
-		$this->getDefaultFields();
-		foreach ( $this->reserved as $key => $def)
-		{
-		    $fields[ $key ] = $def;
-		}
+    function getField ( $fieldName )
+    {
+        $fieldName = strtolower ( $fieldName ) ;
+        foreach ( $this->listViewDefs as $key => $def )
+        {
+            $key = strtolower ( $key ) ;
+            if ($key == $fieldName)
+            {
+                return $def ;
+            }
+        }
+        foreach ( $this->module->field_defs as $key => $def )
+        {
+            $key = strtolower ( $key ) ;
+            if ($key == $fieldName)
+            {
+                return $def ;
+            }
+        }
+        return array ( ) ;
+    }
+    function addRelateData($fieldname, $listfielddef) {
+        $modFieldDef = $this->module->field_defs [ strtolower ( $fieldname ) ];
+        if (!empty($modFieldDef['module']) && !empty($modFieldDef['id_name'])) {
+            $listfielddef['module'] = $modFieldDef['module'];
+            $listfielddef['id'] = strtoupper($modFieldDef['id_name']);
+            $listfielddef['link'] = true;
+            $listfielddef['related_fields'] = array (strtolower($modFieldDef['id_name']));
+        }
+        return $listfielddef;
+    }
+    function _loadLayoutFromRequest ()
+    {
+        $GLOBALS['log']->debug("ParserModifyListView->_loadLayoutFromRequest()");
+        $fields = array ( ) ;
+        $rejectTypes = array ( 'html' , 'enum' , 'text' ) ;
+        for ( $i = 0 ; isset ( $_POST [ 'group_' . $i ] ) && $i < 2 ; $i ++ )
+        {
+            //echo "\n***group-$i Size:".sizeof($_POST['group_' . $i])."\n";
+            foreach ( $_POST [ 'group_' . $i ] as $field )
+            {
+                $fieldname = strtoupper ( $field ) ;
+                //originalListViewDefs are all lower case
+                $lowerFieldName = strtolower ( $field ) ;
+                if (isset ( $this->originalListViewDefs [ $lowerFieldName ] ))
+                {
+                    $fields [ $fieldname ] = $this->originalListViewDefs [ $lowerFieldName ] ;
+                } else
+                {
+                    //check if we have the case wrong for custom fields
+                    if (! isset ( $this->module->field_defs [ $fieldname ] ))
+                    {
+                        foreach ( $this->module->field_defs as $key => $value )
+                        {
+                            if (strtoupper ( $key ) == $fieldname)
+                            {
+                                $fields [ $fieldname ] = array ( 'width' => 10 , 'label' => $this->module->field_defs [ $key ] [ 'vname' ] ) ;
+                                break ;
+                            }
+                        }
+                    } else
+                    {
+                        $fields [ $fieldname ] = array ( 'width' => 10 , 'label' => $this->module->field_defs [ $fieldname ] [ 'vname' ] ) ;
+                    }
+                    // sorting fields of certain types will cause a database engine problems
+                    // we only check this for custom fields, as we assume that OOB fields have been independently confirmed as ok
+                    if (isset ( $this->module->field_defs [ strtolower ( $fieldname ) ] ) && (in_array ( $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ], $rejectTypes ) || isset($this->module->field_defs [ strtolower ( $fieldname ) ]['custom_module'])))
+                    {
+                        $fields [ $fieldname ] [ 'sortable' ] = false ;
+                    }
+                    // Bug 23728 - Make adding a currency type field default to setting the 'currency_format' to true
+                    if (isset ( $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type ' ] ) && $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ] == 'currency') 
+                    {
+                        $fields [ $fieldname ] [ 'currency_format' ] = true;
+                    }
+                }
+                if (isset ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ] ))
+                {
+                    $width = substr ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ], 6, 3 ) ;
+                    if (strpos ( $width, "%" ) !== false)
+                    {
+                        $width = substr ( $width, 0, 2 ) ;
+                    }
+                    if ($width < 101 && $width > 0)
+                    {
+                        $fields [ $fieldname ] [ 'width' ] = $width ;
+                    }
+                } else if (isset ( $this->listViewDefs [ $fieldname ] [ 'width' ] ))
+                {
+                    $fields [ $fieldname ] [ 'width' ] = $this->listViewDefs [ $fieldname ] [ 'width' ] ;
+                }
+                //Get additional Data for relate fields
+                if (isset($this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ]) && $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ] == 'relate') {
+                    $fields [ $fieldname ] = $this->addRelateData($field, $fields [ $fieldname ]);
+                }
+                $fields [ $fieldname ] [ 'default' ] = ($i == 0) ;
+            }
+        }
+        // Add the reserved fields back in to the end of the default fields in the layout
+        // ASSUMPTION: reserved fields go back at the end
+        // First, load the reserved fields - we cannot assume that getDefaultFields has been called earlier when saving
+        $this->getDefaultFields();
+        foreach ( $this->reserved as $key => $def)
+        {
+            $fields[ $key ] = $def;
+        }
 		
-		return $fields ;
-	}
-	function handleSave ()
-	{
-		$fields = $this->_loadLayoutFromRequest();
-		$this->_writeToFile($this->customFile,'ListView',$this->module_name,$fields,$this->_variables);
+        return $fields ;
+    }
+    function handleSave ()
+    {
+        $fields = $this->_loadLayoutFromRequest();
+        $this->_writeToFile($this->customFile,'ListView',$this->module_name,$fields,$this->_variables);
 
-		$GLOBALS [ "listViewDefs" ] [ $this->module_name ] = $fields ;
-		// now clear the cache so that the results are immediately visible
-		include_once ('include/TemplateHandler/TemplateHandler.php') ;
-		TemplateHandler::clearCache ( $this->module_name, "ListView.tpl" ) ; // not currently cached, but here for the future
-	}
+        $GLOBALS [ "listViewDefs" ] [ $this->module_name ] = $fields ;
+        // now clear the cache so that the results are immediately visible
+        include_once ('include/TemplateHandler/TemplateHandler.php') ;
+        TemplateHandler::clearCache ( $this->module_name, "ListView.tpl" ) ; // not currently cached, but here for the future
+    }
 }
 ?>

Spacing +119 added lines, -119 removed lines

@@ -1,6 +1,6 @@ 
 <?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.
@@ -40,43 +40,43 @@ 
  ********************************************************************************/
 
 
-require_once ('modules/ModuleBuilder/parsers/ModuleBuilderParser.php') ;
+require_once ('modules/ModuleBuilder/parsers/ModuleBuilderParser.php');
 class ParserModifyListView extends ModuleBuilderParser
 {
-	var $listViewDefs = false ;
-	var $defaults = array ( ) ;
-	var $additional = array ( ) ;
-	var $available = array ( ) ;
+	var $listViewDefs = false;
+	var $defaults = array( );
+	var $additional = array( );
+	var $available = array( );
 	var $reserved = array(); // fields marked by 'studio'=>false in the listviewdefs; need to be preserved
 	//	var $language_module = '';
-	var $columns = array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' ) ;
-	function init ( $module_name , $submodule = '' )
+	var $columns = array('LBL_DEFAULT' => 'getDefaultFields', 'LBL_AVAILABLE' => 'getAdditionalFields', 'LBL_HIDDEN' => 'getAvailableFields');
+	function init($module_name, $submodule = '')
 	{
-		global $app_list_strings ;
-		$this->module_name = $module_name ;
-		$mod_strings = return_module_language ( $GLOBALS [ 'current_language' ], $this->module_name ) ; // needed solely so that listviewdefs that reference this can be included without error
-		$class = $GLOBALS [ 'beanList' ] [ $this->module_name ] ;
-		require_once ($GLOBALS [ 'beanFiles' ] [ $class ]) ;
-		$this->module = new $class ( ) ;
+		global $app_list_strings;
+		$this->module_name = $module_name;
+		$mod_strings = return_module_language($GLOBALS ['current_language'], $this->module_name); // needed solely so that listviewdefs that reference this can be included without error
+		$class = $GLOBALS ['beanList'] [$this->module_name];
+		require_once ($GLOBALS ['beanFiles'] [$class]);
+		$this->module = new $class( );
 
-		$loaded = $this->_loadFromFile('ListView','modules/' . $this->module_name . '/metadata/listviewdefs.php',$this->module_name);
-		$this->originalListViewDefs = $loaded['viewdefs'] [ $this->module_name ] ;
+		$loaded = $this->_loadFromFile('ListView', 'modules/'.$this->module_name.'/metadata/listviewdefs.php', $this->module_name);
+		$this->originalListViewDefs = $loaded['viewdefs'] [$this->module_name];
 		$this->_variables = $loaded['variables'];
 		//		_pp($loaded);
-		$this->customFile = 'custom/modules/' . $this->module_name . '/metadata/listviewdefs.php' ;
-		if (file_exists ( $this->customFile ))
+		$this->customFile = 'custom/modules/'.$this->module_name.'/metadata/listviewdefs.php';
+		if (file_exists($this->customFile))
 		{
-			$loaded = $this->_loadFromFile('ListView',$this->customFile,$this->module_name);
-			$this->listViewDefs = $loaded['viewdefs'] [ $this->module_name ] ;
+			$loaded = $this->_loadFromFile('ListView', $this->customFile, $this->module_name);
+			$this->listViewDefs = $loaded['viewdefs'] [$this->module_name];
 			$this->_variables = $loaded['variables'];
 		} else
 		{
-			$this->listViewDefs = & $this->originalListViewDefs ;
+			$this->listViewDefs = & $this->originalListViewDefs;
 		}
 
-		$this->fixKeys ( $this->originalListViewDefs ) ;
-		$this->fixKeys ( $this->listViewDefs ) ;
-		$this->language_module = $this->module_name ;
+		$this->fixKeys($this->originalListViewDefs);
+		$this->fixKeys($this->listViewDefs);
+		$this->language_module = $this->module_name;
 	}
 	
 	function getLanguage()
@@ -84,102 +84,102 @@ 
 	    return $this->language_module;
 	}
 	// re-key array so that every entry has a key=name and all keys are lowercase - makes it easier in handleSave() later...
-	function fixKeys ( &$defs )
+	function fixKeys(&$defs)
 	{
-		$temp = array ( ) ;
-		foreach ( $defs as $key => $value )
+		$temp = array( );
+		foreach ($defs as $key => $value)
 		{
-			if (! is_array ( $value ))
+			if (!is_array($value))
 			{
-				$key = $value ;
-				$def = array ( ) ;
-				$def [ 'name' ] = (isset ( $this->module->field_defs [ $key ] )) ? $this->module->field_defs [ $key ] [ 'name' ] : $key ;
-				$value = $def ;
+				$key = $value;
+				$def = array( );
+				$def ['name'] = (isset ($this->module->field_defs [$key])) ? $this->module->field_defs [$key] ['name'] : $key;
+				$value = $def;
 			}
-			if (isset ( $value [ 'name' ] ))
+			if (isset ($value ['name']))
 			{
-				$key = $value [ 'name' ] ; // override key with name, needed when the entry lacks a key
+				$key = $value ['name']; // override key with name, needed when the entry lacks a key
 			}
-			$temp [ strtolower ( $key ) ] = $value ;
+			$temp [strtolower($key)] = $value;
 		}
-		$defs = $temp ;
+		$defs = $temp;
 	}
 	
 	/**
 	 * returns the default fields for a listview
 	 * Called only when displaying the listview for editing; not called when saving
 	 */
-	function getDefaultFields ()
+	function getDefaultFields()
 	{
-		$this->defaults = array ( ) ;
-		foreach ( $this->listViewDefs as $key => $def )
+		$this->defaults = array( );
+		foreach ($this->listViewDefs as $key => $def)
 		{
 		    // add in the default fields from the listviewdefs, stripping out any field with 'studio' set to a value other than true
 		    // Important: the 'studio' fields must be added back into the layout on save, as they're not editable rather than hidden
-			if (! empty ( $def [ 'default' ] ))
+			if (!empty ($def ['default']))
 			{
-			    if (! isset($def['studio']) || $def['studio'] === true)
+			    if (!isset($def['studio']) || $def['studio'] === true)
 			    {
-			        $this->defaults [ $key ] = $def ;
+			        $this->defaults [$key] = $def;
 			    }
 			    else
 			    // anything which doesn't go into the defaults is a reserved field - this makes sure we don't miss anything
 			    {
-			        $this->reserved [ $key ] = $def;
+			        $this->reserved [$key] = $def;
 			    }
 			}
 		}
-		return $this->defaults ;
+		return $this->defaults;
 	}
 	/**
 	 * returns additional fields available for users to create fields
 	 */
-	function getAdditionalFields ()
+	function getAdditionalFields()
 	{
-		$this->additional = array ( ) ;
-		foreach ( $this->listViewDefs as $key => $def )
+		$this->additional = array( );
+		foreach ($this->listViewDefs as $key => $def)
 		{
-			if (empty ( $def [ 'default' ] ))
+			if (empty ($def ['default']))
 			{
-				$key = strtolower ( $key ) ;
-				$this->additional [ $key ] = $def ;
+				$key = strtolower($key);
+				$this->additional [$key] = $def;
 			}
 		}
-		return $this->additional ;
+		return $this->additional;
 	}
 	/**
 	 * returns unused fields that are available for using in either default or additional list views
 	 */
-	function getAvailableFields ()
+	function getAvailableFields()
 	{
-		$this->availableFields = array ( ) ;
-		$lowerFieldList = array_change_key_case ( $this->listViewDefs ) ;
-		foreach ( $this->originalListViewDefs as $key => $def )
+		$this->availableFields = array( );
+		$lowerFieldList = array_change_key_case($this->listViewDefs);
+		foreach ($this->originalListViewDefs as $key => $def)
 		{
-			$key = strtolower ( $key ) ;
-			if (! isset ( $lowerFieldList [ $key ] ))
+			$key = strtolower($key);
+			if (!isset ($lowerFieldList [$key]))
 			{
-				$this->availableFields [ $key ] = $def ;
+				$this->availableFields [$key] = $def;
 			}
 		}
-		$GLOBALS['log']->debug('parser.modifylistview.php->getAvailableFields(): field_defs='.print_r($this->availableFields,true));
+		$GLOBALS['log']->debug('parser.modifylistview.php->getAvailableFields(): field_defs='.print_r($this->availableFields, true));
 		$modFields = !empty($this->module->field_name_map) ? $this->module->field_name_map : $this->module->field_defs;
-		foreach ( $modFields as $key => $def )
+		foreach ($modFields as $key => $def)
 		{
-			$fieldName = strtolower ( $key ) ;
+			$fieldName = strtolower($key);
             if ($fieldName == 'currency_id')
                 continue;
-			if (!isset ( $lowerFieldList [ $fieldName ] )) // bug 16728 - check this first, so that other conditions (e.g., studio == visible) can't override and add duplicate entries
+			if (!isset ($lowerFieldList [$fieldName])) // bug 16728 - check this first, so that other conditions (e.g., studio == visible) can't override and add duplicate entries
 			{
             // bug 19656: this test changed after 5.0.0b - we now remove all ID type fields - whether set as type, or dbtype, from the fielddefs
-            if ($this->isValidField($key, $def)){
-					$label = (isset ( $def [ 'vname' ] )) ? $def [ 'vname' ] : (isset($def [ 'label' ]) ? $def['label'] : $def['name']) ;
-					$this->availableFields [ $fieldName ] = array ( 'width' => '10' , 'label' => $label ) ;
+            if ($this->isValidField($key, $def)) {
+					$label = (isset ($def ['vname'])) ? $def ['vname'] : (isset($def ['label']) ? $def['label'] : $def['name']);
+					$this->availableFields [$fieldName] = array('width' => '10', 'label' => $label);
 				}
 			}
 		}
 
-		return $this->availableFields ;
+		return $this->availableFields;
 	}
 
     function getFieldDefs()
@@ -190,19 +190,19 @@ 
 	
 	function isValidField($key, $def) {
 	    //Allow fields that are studio visible  
-		if (! empty ( $def [ 'studio' ] ) && $def [ 'studio' ] == 'visible')
+		if (!empty ($def ['studio']) && $def ['studio'] == 'visible')
 		  return true;
 		  
 		//No ID fields
-		if  ((!empty ( $def [ 'dbType' ] ) && $def [ 'dbType' ] == 'id') || (!empty ( $def [ 'type' ] ) && $def [ 'type' ] == 'id'))
+		if ((!empty ($def ['dbType']) && $def ['dbType'] == 'id') || (!empty ($def ['type']) && $def ['type'] == 'id'))
 		  return false;
 		  
 		//only allow DB and custom fields (if a source is specified)
-	    if (!empty($def [ 'source' ]) && $def [ 'source' ] != 'db' && $def [ 'source' ] != 'custom_fields')
+	    if (!empty($def ['source']) && $def ['source'] != 'db' && $def ['source'] != 'custom_fields')
 		  return false;
 
 		//Dont ever show the "deleted" fields or "_name" fields
-		if (strcmp ( $key, 'deleted' ) == 0 || (isset ( $def [ 'name' ] ) && strpos ( $def [ 'name' ], "_name" ) !== false))
+		if (strcmp($key, 'deleted') == 0 || (isset ($def ['name']) && strpos($def ['name'], "_name") !== false))
 	       return false;
 
 	    //If none of the "ifs" are true, the field is valid
@@ -210,124 +210,124 @@ 
 	}
 	
 	
-	function getField ( $fieldName )
+	function getField($fieldName)
 	{
-		$fieldName = strtolower ( $fieldName ) ;
-		foreach ( $this->listViewDefs as $key => $def )
+		$fieldName = strtolower($fieldName);
+		foreach ($this->listViewDefs as $key => $def)
 		{
-			$key = strtolower ( $key ) ;
+			$key = strtolower($key);
 			if ($key == $fieldName)
 			{
-				return $def ;
+				return $def;
 			}
 		}
-		foreach ( $this->module->field_defs as $key => $def )
+		foreach ($this->module->field_defs as $key => $def)
 		{
-			$key = strtolower ( $key ) ;
+			$key = strtolower($key);
 			if ($key == $fieldName)
 			{
-				return $def ;
+				return $def;
 			}
 		}
-		return array ( ) ;
+		return array( );
 	}
 	function addRelateData($fieldname, $listfielddef) {
-		$modFieldDef = $this->module->field_defs [ strtolower ( $fieldname ) ];
+		$modFieldDef = $this->module->field_defs [strtolower($fieldname)];
 		if (!empty($modFieldDef['module']) && !empty($modFieldDef['id_name'])) {
 			$listfielddef['module'] = $modFieldDef['module'];
 			$listfielddef['id'] = strtoupper($modFieldDef['id_name']);
 			$listfielddef['link'] = true;
-			$listfielddef['related_fields'] = array (strtolower($modFieldDef['id_name']));
+			$listfielddef['related_fields'] = array(strtolower($modFieldDef['id_name']));
 		}
 		return $listfielddef;
 	}
-	function _loadLayoutFromRequest ()
+	function _loadLayoutFromRequest()
 	{
 	    $GLOBALS['log']->debug("ParserModifyListView->_loadLayoutFromRequest()");
-		$fields = array ( ) ;
-		$rejectTypes = array ( 'html' , 'enum' , 'text' ) ;
-		for ( $i = 0 ; isset ( $_POST [ 'group_' . $i ] ) && $i < 2 ; $i ++ )
+		$fields = array( );
+		$rejectTypes = array('html', 'enum', 'text');
+		for ($i = 0; isset ($_POST ['group_'.$i]) && $i < 2; $i++)
 		{
 			//echo "\n***group-$i Size:".sizeof($_POST['group_' . $i])."\n";
-			foreach ( $_POST [ 'group_' . $i ] as $field )
+			foreach ($_POST ['group_'.$i] as $field)
 			{
-				$fieldname = strtoupper ( $field ) ;
+				$fieldname = strtoupper($field);
 				//originalListViewDefs are all lower case
-				$lowerFieldName = strtolower ( $field ) ;
-				if (isset ( $this->originalListViewDefs [ $lowerFieldName ] ))
+				$lowerFieldName = strtolower($field);
+				if (isset ($this->originalListViewDefs [$lowerFieldName]))
 				{
-					$fields [ $fieldname ] = $this->originalListViewDefs [ $lowerFieldName ] ;
+					$fields [$fieldname] = $this->originalListViewDefs [$lowerFieldName];
 				} else
 				{
 					//check if we have the case wrong for custom fields
-					if (! isset ( $this->module->field_defs [ $fieldname ] ))
+					if (!isset ($this->module->field_defs [$fieldname]))
 					{
-						foreach ( $this->module->field_defs as $key => $value )
+						foreach ($this->module->field_defs as $key => $value)
 						{
-							if (strtoupper ( $key ) == $fieldname)
+							if (strtoupper($key) == $fieldname)
 							{
-								$fields [ $fieldname ] = array ( 'width' => 10 , 'label' => $this->module->field_defs [ $key ] [ 'vname' ] ) ;
-								break ;
+								$fields [$fieldname] = array('width' => 10, 'label' => $this->module->field_defs [$key] ['vname']);
+								break;
 							}
 						}
 					} else
 					{
-						$fields [ $fieldname ] = array ( 'width' => 10 , 'label' => $this->module->field_defs [ $fieldname ] [ 'vname' ] ) ;
+						$fields [$fieldname] = array('width' => 10, 'label' => $this->module->field_defs [$fieldname] ['vname']);
 					}
 					// sorting fields of certain types will cause a database engine problems
 					// we only check this for custom fields, as we assume that OOB fields have been independently confirmed as ok
-					if (isset ( $this->module->field_defs [ strtolower ( $fieldname ) ] ) && (in_array ( $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ], $rejectTypes ) || isset($this->module->field_defs [ strtolower ( $fieldname ) ]['custom_module'])))
+					if (isset ($this->module->field_defs [strtolower($fieldname)]) && (in_array($this->module->field_defs [strtolower($fieldname)] ['type'], $rejectTypes) || isset($this->module->field_defs [strtolower($fieldname)]['custom_module'])))
 					{
-						$fields [ $fieldname ] [ 'sortable' ] = false ;
+						$fields [$fieldname] ['sortable'] = false;
 					}
 					// Bug 23728 - Make adding a currency type field default to setting the 'currency_format' to true
-					if (isset ( $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type ' ] ) && $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ] == 'currency') 
+					if (isset ($this->module->field_defs [strtolower($fieldname)] ['type ']) && $this->module->field_defs [strtolower($fieldname)] ['type'] == 'currency') 
 					{
-						$fields [ $fieldname ] [ 'currency_format' ] = true;
+						$fields [$fieldname] ['currency_format'] = true;
 					}
 				}
-				if (isset ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ] ))
+				if (isset ($_REQUEST [strtolower($fieldname).'width']))
 				{
-					$width = substr ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ], 6, 3 ) ;
-					if (strpos ( $width, "%" ) !== false)
+					$width = substr($_REQUEST [strtolower($fieldname).'width'], 6, 3);
+					if (strpos($width, "%") !== false)
 					{
-						$width = substr ( $width, 0, 2 ) ;
+						$width = substr($width, 0, 2);
 					}
 					if ($width < 101 && $width > 0)
 					{
-						$fields [ $fieldname ] [ 'width' ] = $width ;
+						$fields [$fieldname] ['width'] = $width;
 					}
-				} else if (isset ( $this->listViewDefs [ $fieldname ] [ 'width' ] ))
+				} else if (isset ($this->listViewDefs [$fieldname] ['width']))
 				{
-					$fields [ $fieldname ] [ 'width' ] = $this->listViewDefs [ $fieldname ] [ 'width' ] ;
+					$fields [$fieldname] ['width'] = $this->listViewDefs [$fieldname] ['width'];
 				}
 				//Get additional Data for relate fields
-				if (isset($this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ]) && $this->module->field_defs [ strtolower ( $fieldname ) ] [ 'type' ] == 'relate') {
-					$fields [ $fieldname ] = $this->addRelateData($field, $fields [ $fieldname ]);
+				if (isset($this->module->field_defs [strtolower($fieldname)] ['type']) && $this->module->field_defs [strtolower($fieldname)] ['type'] == 'relate') {
+					$fields [$fieldname] = $this->addRelateData($field, $fields [$fieldname]);
 				}
-				$fields [ $fieldname ] [ 'default' ] = ($i == 0) ;
+				$fields [$fieldname] ['default'] = ($i == 0);
 			}
 		}
 		// Add the reserved fields back in to the end of the default fields in the layout
 		// ASSUMPTION: reserved fields go back at the end
 		// First, load the reserved fields - we cannot assume that getDefaultFields has been called earlier when saving
 		$this->getDefaultFields();
-		foreach ( $this->reserved as $key => $def)
+		foreach ($this->reserved as $key => $def)
 		{
-		    $fields[ $key ] = $def;
+		    $fields[$key] = $def;
 		}
 		
-		return $fields ;
+		return $fields;
 	}
-	function handleSave ()
+	function handleSave()
 	{
 		$fields = $this->_loadLayoutFromRequest();
-		$this->_writeToFile($this->customFile,'ListView',$this->module_name,$fields,$this->_variables);
+		$this->_writeToFile($this->customFile, 'ListView', $this->module_name, $fields, $this->_variables);
 
-		$GLOBALS [ "listViewDefs" ] [ $this->module_name ] = $fields ;
+		$GLOBALS ["listViewDefs"] [$this->module_name] = $fields;
 		// now clear the cache so that the results are immediately visible
-		include_once ('include/TemplateHandler/TemplateHandler.php') ;
-		TemplateHandler::clearCache ( $this->module_name, "ListView.tpl" ) ; // not currently cached, but here for the future
+		include_once ('include/TemplateHandler/TemplateHandler.php');
+		TemplateHandler::clearCache($this->module_name, "ListView.tpl"); // not currently cached, but here for the future
 	}
 }
 ?>

Braces +22 added lines, -15 removed lines

@@ -1,6 +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.
@@ -121,8 +122,7 @@ 
 			    if (! isset($def['studio']) || $def['studio'] === true)
 			    {
 			        $this->defaults [ $key ] = $def ;
-			    }
-			    else
+			    } else
 			    // anything which doesn't go into the defaults is a reserved field - this makes sure we don't miss anything
 			    {
 			        $this->reserved [ $key ] = $def;
@@ -167,13 +167,16 @@ 
 		foreach ( $modFields as $key => $def )
 		{
 			$fieldName = strtolower ( $key ) ;
-            if ($fieldName == 'currency_id')
-                continue;
-			if (!isset ( $lowerFieldList [ $fieldName ] )) // bug 16728 - check this first, so that other conditions (e.g., studio == visible) can't override and add duplicate entries
+            if ($fieldName == 'currency_id') {
+                            continue;
+            }
+			if (!isset ( $lowerFieldList [ $fieldName ] )) {
+			    // bug 16728 - check this first, so that other conditions (e.g., studio == visible) can't override and add duplicate entries
 			{
             // bug 19656: this test changed after 5.0.0b - we now remove all ID type fields - whether set as type, or dbtype, from the fielddefs
             if ($this->isValidField($key, $def)){
 					$label = (isset ( $def [ 'vname' ] )) ? $def [ 'vname' ] : (isset($def [ 'label' ]) ? $def['label'] : $def['name']) ;
+			}
 					$this->availableFields [ $fieldName ] = array ( 'width' => '10' , 'label' => $label ) ;
 				}
 			}
@@ -190,20 +193,24 @@ 
 	
 	function isValidField($key, $def) {
 	    //Allow fields that are studio visible  
-		if (! empty ( $def [ 'studio' ] ) && $def [ 'studio' ] == 'visible')
-		  return true;
+		if (! empty ( $def [ 'studio' ] ) && $def [ 'studio' ] == 'visible') {
+				  return true;
+		}
 		  
 		//No ID fields
-		if  ((!empty ( $def [ 'dbType' ] ) && $def [ 'dbType' ] == 'id') || (!empty ( $def [ 'type' ] ) && $def [ 'type' ] == 'id'))
-		  return false;
+		if  ((!empty ( $def [ 'dbType' ] ) && $def [ 'dbType' ] == 'id') || (!empty ( $def [ 'type' ] ) && $def [ 'type' ] == 'id')) {
+				  return false;
+		}
 		  
 		//only allow DB and custom fields (if a source is specified)
-	    if (!empty($def [ 'source' ]) && $def [ 'source' ] != 'db' && $def [ 'source' ] != 'custom_fields')
-		  return false;
+	    if (!empty($def [ 'source' ]) && $def [ 'source' ] != 'db' && $def [ 'source' ] != 'custom_fields') {
+	    		  return false;
+	    }
 
 		//Dont ever show the "deleted" fields or "_name" fields
-		if (strcmp ( $key, 'deleted' ) == 0 || (isset ( $def [ 'name' ] ) && strpos ( $def [ 'name' ], "_name" ) !== false))
-	       return false;
+		if (strcmp ( $key, 'deleted' ) == 0 || (isset ( $def [ 'name' ] ) && strpos ( $def [ 'name' ], "_name" ) !== false)) {
+			       return false;
+		}
 
 	    //If none of the "ifs" are true, the field is valid
 	    return true;

modules/AOR_Fields/vardefs.php

Indentation +27 added lines, -27 removed lines

@@ -1,32 +1,32 @@ 
 <?php
 /**
- * Advanced OpenReports, SugarCRM Reporting.
- * @package Advanced OpenReports for SugarCRM
- * @copyright SalesAgility Ltd http://www.salesagility.com
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
- * along with this program; if not, see http://www.gnu.org/licenses
- * or write to the Free Software Foundation,Inc., 51 Franklin Street,
- * Fifth Floor, Boston, MA 02110-1301  USA
- *
- * @author SalesAgility <info@salesagility.com>
- */
+     * Advanced OpenReports, SugarCRM Reporting.
+     * @package Advanced OpenReports for SugarCRM
+     * @copyright SalesAgility Ltd http://www.salesagility.com
+     *
+     * This program is free software; you can redistribute it and/or modify
+     * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+     * the Free Software Foundation; either version 3 of the License, or
+     * (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+     * along with this program; if not, see http://www.gnu.org/licenses
+     * or write to the Free Software Foundation,Inc., 51 Franklin Street,
+     * Fifth Floor, Boston, MA 02110-1301  USA
+     *
+     * @author SalesAgility <info@salesagility.com>
+     */
 
 $dictionary['AOR_Field'] = array(
-	'table'=>'aor_fields',
-	'audited'=>false,
-	'duplicate_merge'=>true,
-	'fields'=>array (
+    'table'=>'aor_fields',
+    'audited'=>false,
+    'duplicate_merge'=>true,
+    'fields'=>array (
         'aor_report_id' =>
         array (
             'required' => false,
@@ -338,8 +338,8 @@ 
             'fields' => array('aor_report_id'),
         ),
     ),
-	'optimistic_locking'=>true,
-		'unified_search'=>true,
+    'optimistic_locking'=>true,
+        'unified_search'=>true,
 );
 if (!class_exists('VardefManager')){
         require_once('include/SugarObjects/VardefManager.php');

Spacing +20 added lines, -20 removed lines

@@ -26,9 +26,9 @@ 
 	'table'=>'aor_fields',
 	'audited'=>false,
 	'duplicate_merge'=>true,
-	'fields'=>array (
+	'fields'=>array(
         'aor_report_id' =>
-        array (
+        array(
             'required' => false,
             'name' => 'aor_report_id',
             'vname' => 'LBL_AOR_REPORT_ID',
@@ -47,7 +47,7 @@ 
             'size' => '20',
         ),
         'field_order' =>
-        array (
+        array(
             'required' => false,
             'name' => 'field_order',
             'vname' => 'LBL_ORDER',
@@ -68,14 +68,14 @@ 
             'disable_num_format' => '',
         ),
         'module_path' =>
-        array (
+        array(
             'name' => 'module_path',
             'type' => 'longtext',
             'vname' => 'LBL_MODULE_PATH',
             'isnull' => true,
         ),
         'field' =>
-        array (
+        array(
             'required' => false,
             'name' => 'field',
             'vname' => 'LBL_FIELD',
@@ -97,7 +97,7 @@ 
             'dependency' => false,
         ),
         'display' =>
-        array (
+        array(
             'required' => false,
             'name' => 'display',
             'vname' => 'LBL_DISPLAY',
@@ -115,7 +115,7 @@ 
             'studio' => 'visible',
         ),
         'link' =>
-        array (
+        array(
             'required' => false,
             'name' => 'link',
             'vname' => 'LBL_LINK',
@@ -133,7 +133,7 @@ 
             'studio' => 'visible',
         ),
         'label' =>
-        array (
+        array(
             'required' => false,
             'name' => 'label',
             'vname' => 'LBL_LABEL',
@@ -152,7 +152,7 @@ 
             'size' => '20',
         ),
         'field_function' =>
-        array (
+        array(
             'required' => false,
             'name' => 'field_function',
             'vname' => 'LBL_FUNCTION',
@@ -174,7 +174,7 @@ 
             'dependency' => false,
         ),
         'sort_by' =>
-        array (
+        array(
             'required' => false,
             'name' => 'sort_by',
             'vname' => 'LBL_SORT',
@@ -196,7 +196,7 @@ 
             'dependency' => false,
         ),
         'format' =>
-            array (
+            array(
                 'required' => false,
                 'name' => 'format',
                 'vname' => 'LBL_FORMAT',
@@ -218,7 +218,7 @@ 
                 'dependency' => false,
             ),
         'total' =>
-            array (
+            array(
                 'required' => false,
                 'name' => 'total',
                 'vname' => 'LBL_TOTAL',
@@ -240,7 +240,7 @@ 
                 'dependency' => false,
             ),
         'sort_order' =>
-        array (
+        array(
             'required' => false,
             'name' => 'sort_order',
             'vname' => 'LBL_SORT_ORDER',
@@ -262,7 +262,7 @@ 
             'dependency' => false,
         ),
         'group_by' =>
-        array (
+        array(
             'required' => false,
             'name' => 'group_by',
             'vname' => 'LBL_GROUP',
@@ -280,7 +280,7 @@ 
             'studio' => 'visible',
         ),
         'group_order' =>
-        array (
+        array(
             'required' => false,
             'name' => 'group_order',
             'vname' => 'LBL_GROUP_ORDER',
@@ -302,7 +302,7 @@ 
             'dependency' => false,
         ),
         'group_display' =>
-        array (
+        array(
             'required' => false,
             'name' => 'group_display',
             'vname' => 'LBL_GROUP_DISPLAY',
@@ -320,7 +320,7 @@ 
             'studio' => 'visible',
         ),
         'aor_reports' =>
-        array (
+        array(
             'name' => 'aor_reports',
             'type' => 'link',
             'relationship' => 'aor_report_aor_fields',
@@ -329,7 +329,7 @@ 
             'source'=>'non-db',
         ),
     ),
-    'relationships'=>array (
+    'relationships'=>array(
     ),
     'indices' => array(
         array(
@@ -341,7 +341,7 @@ 
 	'optimistic_locking'=>true,
 		'unified_search'=>true,
 );
-if (!class_exists('VardefManager')){
+if (!class_exists('VardefManager')) {
         require_once('include/SugarObjects/VardefManager.php');
 }
-VardefManager::createVardef('AOR_Fields','AOR_Field', array('basic'));
+VardefManager::createVardef('AOR_Fields', 'AOR_Field', array('basic'));

modules/AOR_Fields/AOR_Field.php

Spacing +19 added lines, -19 removed lines

@@ -29,7 +29,7 @@ 
 	var $table_name = 'aor_fields';
     var $tracker_visibility = false;
 	var $importable = true;
-	var $disable_row_level_security = true ;
+	var $disable_row_level_security = true;
 	
 	var $id;
 	var $name;
@@ -53,11 +53,11 @@ 
     var $group_by;
     var $group_order;
 		
-	function AOR_Field(){
+	function AOR_Field() {
 		parent::Basic();
 	}
 
-    function save_lines($post_data, $parent, $key = ''){
+    function save_lines($post_data, $parent, $key = '') {
 
         require_once('modules/AOW_WorkFlow/aow_utils.php');
 
@@ -65,45 +65,45 @@ 
         $j = 0;
         for ($i = 0; $i < $line_count; ++$i) {
 
-            if($post_data[$key.'deleted'][$i] == 1){
+            if ($post_data[$key.'deleted'][$i] == 1) {
                 $this->mark_deleted($post_data[$key.'id'][$i]);
             } else {
                 $field = new AOR_Field();
                 $field->group_display = false;
 
-                if($key == 'aor_fields_') {
-                    foreach($post_data['aor_fields_group_display'] as $gdKey => $gdValue) {
-                        if($gdValue == $i) {
-                            $field->group_display = $gdKey+1;
+                if ($key == 'aor_fields_') {
+                    foreach ($post_data['aor_fields_group_display'] as $gdKey => $gdValue) {
+                        if ($gdValue == $i) {
+                            $field->group_display = $gdKey + 1;
                             break;
                         }
                     }
                 }
 
-                foreach($this->field_defs as $field_def) {
-                    if(is_array($post_data[$key.$field_def['name']])) {
-                        if ($field_def['name'] != 'group_display' && isset($post_data[$key . $field_def['name']][$i])) {
-                            if (is_array($post_data[$key . $field_def['name']][$i])) {
-                                $post_data[$key . $field_def['name']][$i] = base64_encode(serialize($post_data[$key . $field_def['name']][$i]));
+                foreach ($this->field_defs as $field_def) {
+                    if (is_array($post_data[$key.$field_def['name']])) {
+                        if ($field_def['name'] != 'group_display' && isset($post_data[$key.$field_def['name']][$i])) {
+                            if (is_array($post_data[$key.$field_def['name']][$i])) {
+                                $post_data[$key.$field_def['name']][$i] = base64_encode(serialize($post_data[$key.$field_def['name']][$i]));
                             } else if ($field_def['name'] == 'value') {
-                                $post_data[$key . $field_def['name']][$i] = fixUpFormatting($_REQUEST['report_module'], $field->field, $post_data[$key . $field_def['name']][$i]);
+                                $post_data[$key.$field_def['name']][$i] = fixUpFormatting($_REQUEST['report_module'], $field->field, $post_data[$key.$field_def['name']][$i]);
                             }
                             if ($field_def['name'] == 'module_path') {
-                                $post_data[$key . $field_def['name']][$i] = base64_encode(serialize(explode(":", $post_data[$key . $field_def['name']][$i])));
+                                $post_data[$key.$field_def['name']][$i] = base64_encode(serialize(explode(":", $post_data[$key.$field_def['name']][$i])));
                             }
 
-                            $field->$field_def['name'] = $post_data[$key . $field_def['name']][$i];
+                            $field->$field_def['name'] = $post_data[$key.$field_def['name']][$i];
                         }
                     }
-                    else if(is_null($post_data[$key.$field_def['name']])) {
+                    else if (is_null($post_data[$key.$field_def['name']])) {
                         // do nothing
                     }
                     else {
-                        throw new Exception('illegal type in post data at key ' . $key.$field_def['name'] . ' ' . gettype($post_data[$key.$field_def['name']]));
+                        throw new Exception('illegal type in post data at key '.$key.$field_def['name'].' '.gettype($post_data[$key.$field_def['name']]));
                     }
 
                 }
-                if(trim($field->field) != ''){
+                if (trim($field->field) != '') {
                     $field->aor_report_id = $parent->id;
                     $field->save();
                 }

Braces +2 added lines, -4 removed lines

@@ -94,11 +94,9 @@
 
                             $field->$field_def['name'] = $post_data[$key . $field_def['name']][$i];
                         }
-                    }
-                    else if(is_null($post_data[$key.$field_def['name']])) {
+                    } else if(is_null($post_data[$key.$field_def['name']])) {
                         // do nothing
-                    }
-                    else {
+                    } else {
                         throw new Exception('illegal type in post data at key ' . $key.$field_def['name'] . ' ' . gettype($post_data[$key.$field_def['name']]));
                     }
 

Indentation +21 added lines, -21 removed lines

@@ -23,26 +23,26 @@ 
  */
 
 class AOR_Field extends Basic {
-	var $new_schema = true;
-	var $module_dir = 'AOR_Fields';
-	var $object_name = 'AOR_Field';
-	var $table_name = 'aor_fields';
+    var $new_schema = true;
+    var $module_dir = 'AOR_Fields';
+    var $object_name = 'AOR_Field';
+    var $table_name = 'aor_fields';
     var $tracker_visibility = false;
-	var $importable = true;
-	var $disable_row_level_security = true ;
+    var $importable = true;
+    var $disable_row_level_security = true ;
 	
-	var $id;
-	var $name;
-	var $date_entered;
-	var $date_modified;
-	var $modified_user_id;
-	var $modified_by_name;
-	var $created_by;
-	var $created_by_name;
-	var $description;
-	var $deleted;
-	var $created_by_link;
-	var $modified_user_link;
+    var $id;
+    var $name;
+    var $date_entered;
+    var $date_modified;
+    var $modified_user_id;
+    var $modified_by_name;
+    var $created_by;
+    var $created_by_name;
+    var $description;
+    var $deleted;
+    var $created_by_link;
+    var $modified_user_link;
     var $field_order;
     var $field;
     var $display;
@@ -53,9 +53,9 @@ 
     var $group_by;
     var $group_order;
 		
-	function AOR_Field(){
-		parent::Basic();
-	}
+    function AOR_Field(){
+        parent::Basic();
+    }
 
     function save_lines($post_data, $parent, $key = ''){
 

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
 		parent::Basic();
 	}
 
+    /**
+     * @param AOR_Report $parent
+     */
     function save_lines($post_data, $parent, $key = ''){
 
         require_once('modules/AOW_WorkFlow/aow_utils.php');

modules/Reminders_Invitees/vardefs.php

Spacing +5 added lines, -5 removed lines

@@ -37,9 +37,9 @@ 
  * display the words  "Powered by SugarCRM" and "Supercharged by SuiteCRM".
  ********************************************************************************/
 
-$dictionary['Reminder_Invitee']['table']= 'reminders_invitees';
-$dictionary['Reminder_Invitee']['audited']= false;
-$dictionary['Reminder_Invitee']['fields']= array(
+$dictionary['Reminder_Invitee']['table'] = 'reminders_invitees';
+$dictionary['Reminder_Invitee']['audited'] = false;
+$dictionary['Reminder_Invitee']['fields'] = array(
     'reminder_id' => array(
         'name' => 'reminder_id',
         'vname' => 'LBL_REMINDER_ID',
@@ -72,9 +72,9 @@ 
 //);
 
 
-if (!class_exists('VardefManager')){
+if (!class_exists('VardefManager')) {
     require_once('include/SugarObjects/VardefManager.php');
 }
-VardefManager::createVardef('Reminders_Invitees','Reminder_Invitee', array('basic','assignable'));
+VardefManager::createVardef('Reminders_Invitees', 'Reminder_Invitee', array('basic', 'assignable'));
 
 ?>
\ No newline at end of file

modules/Reminders_Invitees/Reminder_Invitee.php

Indentation +24 added lines, -24 removed lines

@@ -67,12 +67,12 @@ 
         return false;
     }
 
-	/**
-	 * Save multiple reminders invitees data.
-	 * 
-	 * @param string $reminderId Related Reminder GUID
-	 * @param array $inviteesData Invitees Data
-	 */
+    /**
+     * Save multiple reminders invitees data.
+     * 
+     * @param string $reminderId Related Reminder GUID
+     * @param array $inviteesData Invitees Data
+     */
     public static function saveRemindersInviteesData($reminderId, $inviteesData) {
         $savedInviteeIds = array();
         foreach($inviteesData as $k => $inviteeData) {
@@ -98,16 +98,16 @@ 
         self::deleteRemindersInviteesMultiple($reminderId, $savedInviteeIds);
     }
 	
-	/**
-	 * Load reminders invitees data.
-	 * 
-	 * @param string $reminderId Related Reminder GUID
-	 * @return array Invitees data
-	 */
-	public static function loadRemindersInviteesData($reminderId, $isDuplicate = false) {
-		$ret = array();
-		$reminderInviteeBeen = new Reminder_Invitee();
-		$reminderInvitees = $reminderInviteeBeen->get_full_list("reminders_invitees.date_entered", "reminders_invitees.reminder_id = '$reminderId'");
+    /**
+     * Load reminders invitees data.
+     * 
+     * @param string $reminderId Related Reminder GUID
+     * @return array Invitees data
+     */
+    public static function loadRemindersInviteesData($reminderId, $isDuplicate = false) {
+        $ret = array();
+        $reminderInviteeBeen = new Reminder_Invitee();
+        $reminderInvitees = $reminderInviteeBeen->get_full_list("reminders_invitees.date_entered", "reminders_invitees.reminder_id = '$reminderId'");
         if($reminderInvitees) {
             foreach ($reminderInvitees as $reminderInvitee) {
                 $ret[] = array(
@@ -118,8 +118,8 @@ 
                 );
             }
         }
-		return $ret;
-	}
+        return $ret;
+    }
 
     private static function getInviteeName($module, $moduleId) {
         $retValue = "unknown";
@@ -147,12 +147,12 @@ 
         return $retValue;
     }
 
-	/**
-	 * Delete reminders invitees multiple.
-	 * 
-	 * @param string $reminderId Related Reminder GUID
-	 * @param array $inviteeIds (optional) Exluded Invitees GUIDs, the invitee will not deleted if this argument contains that. Default is empty array.
-	 */
+    /**
+     * Delete reminders invitees multiple.
+     * 
+     * @param string $reminderId Related Reminder GUID
+     * @param array $inviteeIds (optional) Exluded Invitees GUIDs, the invitee will not deleted if this argument contains that. Default is empty array.
+     */
     public static function deleteRemindersInviteesMultiple($reminderId, $inviteeIds = array()) {
         $invitees = BeanFactory::getBean('Reminders_Invitees')->get_full_list("", "reminders_invitees.reminder_id = '$reminderId'");
         if($invitees) {

Spacing +12 added lines, -12 removed lines

@@ -60,8 +60,8 @@ 
         parent::Basic();
     }
 
-    public function bean_implements($interface){
-        switch($interface){
+    public function bean_implements($interface) {
+        switch ($interface) {
             case 'ACL': return true;
         }
         return false;
@@ -75,13 +75,13 @@ 
 	 */
     public static function saveRemindersInviteesData($reminderId, $inviteesData) {
         $savedInviteeIds = array();
-        foreach($inviteesData as $k => $inviteeData) {
-            if(isset($_POST['isDuplicate']) && $_POST['isDuplicate']) $inviteeData->id = '';
+        foreach ($inviteesData as $k => $inviteeData) {
+            if (isset($_POST['isDuplicate']) && $_POST['isDuplicate']) $inviteeData->id = '';
             $reminderInviteeBean = BeanFactory::getBean('Reminders_Invitees', $inviteeData->id);
             $reminderInviteeBean->reminder_id = $reminderId;
             $reminderInviteeBean->related_invitee_module = $inviteeData->module;
             $reminderInviteeBean->related_invitee_module_id = $inviteeData->module_id;
-            if(!$inviteeData->id) {
+            if (!$inviteeData->id) {
                 $reminderInviteeBean->save();
                 $savedInviteeIds[] = $reminderInviteeBean->id;
             }
@@ -108,7 +108,7 @@ 
 		$ret = array();
 		$reminderInviteeBeen = new Reminder_Invitee();
 		$reminderInvitees = $reminderInviteeBeen->get_full_list("reminders_invitees.date_entered", "reminders_invitees.reminder_id = '$reminderId'");
-        if($reminderInvitees) {
+        if ($reminderInvitees) {
             foreach ($reminderInvitees as $reminderInvitee) {
                 $ret[] = array(
                     'id' => $isDuplicate ? null : $reminderInvitee->id,
@@ -125,21 +125,21 @@ 
         $retValue = "unknown";
 
         $bean = BeanFactory::getBean($module, $moduleId);
-        switch($module) {
+        switch ($module) {
             case 'Users':
             case 'Contacts':
             case 'Leads':
             default:
-                if(isset($bean->first_name) && isset($bean->last_name)) {
+                if (isset($bean->first_name) && isset($bean->last_name)) {
                     $retValue = "{$bean->first_name} {$bean->last_name}";
                 }
-                else if(isset($bean->name)) {
+                else if (isset($bean->name)) {
                     $retValue = $bean->name;
                 }
-                else if(isset($bean->email)) {
+                else if (isset($bean->email)) {
                     $retValue = $bean->email;
                 }
-                if(!$retValue) {
+                if (!$retValue) {
                     $retValue = "$module ($moduleId)";
                 }
                 break;
@@ -155,7 +155,7 @@ 
 	 */
     public static function deleteRemindersInviteesMultiple($reminderId, $inviteeIds = array()) {
         $invitees = BeanFactory::getBean('Reminders_Invitees')->get_full_list("", "reminders_invitees.reminder_id = '$reminderId'");
-        if($invitees) {
+        if ($invitees) {
             foreach ($invitees as $invitee) {
                 if (!in_array($invitee->id, $inviteeIds)) {
                     $invitee->mark_deleted($invitee->id);

Braces +6 added lines, -7 removed lines

@@ -76,7 +76,9 @@ 
     public static function saveRemindersInviteesData($reminderId, $inviteesData) {
         $savedInviteeIds = array();
         foreach($inviteesData as $k => $inviteeData) {
-            if(isset($_POST['isDuplicate']) && $_POST['isDuplicate']) $inviteeData->id = '';
+            if(isset($_POST['isDuplicate']) && $_POST['isDuplicate']) {
+                $inviteeData->id = '';
+            }
             $reminderInviteeBean = BeanFactory::getBean('Reminders_Invitees', $inviteeData->id);
             $reminderInviteeBean->reminder_id = $reminderId;
             $reminderInviteeBean->related_invitee_module = $inviteeData->module;
@@ -84,8 +86,7 @@ 
             if(!$inviteeData->id) {
                 $reminderInviteeBean->save();
                 $savedInviteeIds[] = $reminderInviteeBean->id;
-            }
-            else {
+            } else {
                 $addedInvitees = BeanFactory::getBean('Reminders_Invitees')->get_full_list("", "reminders_invitees.id != '{$inviteeData->id}' AND reminders_invitees.reminder_id = '{$reminderInviteeBean->reminder_id}' AND reminders_invitees.related_invitee_module = '{$reminderInviteeBean->related_invitee_module}' AND reminders_invitees.related_invitee_module_id = '{$reminderInviteeBean->related_invitee_module_id}'");
                 if (!$addedInvitees) {
                     $reminderInviteeBean->save();
@@ -132,11 +133,9 @@ 
             default:
                 if(isset($bean->first_name) && isset($bean->last_name)) {
                     $retValue = "{$bean->first_name} {$bean->last_name}";
-                }
-                else if(isset($bean->name)) {
+                } else if(isset($bean->name)) {
                     $retValue = $bean->name;
-                }
-                else if(isset($bean->email)) {
+                } else if(isset($bean->email)) {
                     $retValue = $bean->email;
                 }
                 if(!$retValue) {

modules/AOP_Case_Updates/Case_Updates.php

Spacing +29 added lines, -29 removed lines

@@ -23,7 +23,7 @@ 
  */
 
 
-function display_updates($focus, $field, $value, $view){
+function display_updates($focus, $field, $value, $view) {
     global $mod_strings;
 
     $hideImage = SugarThemeRegistry::current()->getImageURL('basic_search.gif');
@@ -127,8 +127,8 @@ 
 </script>
 A;
 
-    $updates = $focus->get_linked_beans('aop_case_updates',"AOP_Case_Updates");
-    if(!$updates || is_null($focus->id)){
+    $updates = $focus->get_linked_beans('aop_case_updates', "AOP_Case_Updates");
+    if (!$updates || is_null($focus->id)) {
         $html .= quick_edit_case_updates();
         return $html;
         //return $mod_strings['LBL_NO_CASE_UPDATES'];
@@ -154,18 +154,18 @@ 
 EOD;
 
 
-    usort($updates,function($a,$b){
+    usort($updates, function($a, $b) {
         $aDate = $a->fetched_row['date_entered'];
         $bDate = $b->fetched_row['date_entered'];
-        if($aDate < $bDate){
+        if ($aDate < $bDate) {
             return -1;
-        }elseif($aDate > $bDate){
+        }elseif ($aDate > $bDate) {
             return 1;
         }
         return 0;
     });
 
-    foreach($updates as $update){
+    foreach ($updates as $update) {
         $html .= display_single_update($update, $hideImage);
     }
     $html .= "</div>";
@@ -178,9 +178,9 @@ 
 /**
  * @return mixed|string|void
  */
-function display_update_form(){
+function display_update_form() {
     global $mod_strings, $app_strings;
-    $sugar_smarty	= new Sugar_Smarty();
+    $sugar_smarty = new Sugar_Smarty();
     $sugar_smarty->assign('MOD', $mod_strings);
     $sugar_smarty->assign('APP', $app_strings);
     return $sugar_smarty->fetch('modules/AOP_Case_Updates/tpl/caseUpdateForm.tpl');
@@ -191,23 +191,23 @@ 
  * @param SugarBean $update
  * @return string - html to be displayed
  */
-function getUpdateDisplayHead(SugarBean $update){
+function getUpdateDisplayHead(SugarBean $update) {
     global $mod_strings;
-    if($update->contact_id){
+    if ($update->contact_id) {
         $name = $update->getUpdateContact()->name;
-    }elseif($update->assigned_user_id){
+    }elseif ($update->assigned_user_id) {
         $name = $update->getUpdateUser()->name;
-    }else{
+    } else {
         $name = "Unknown";
     }
     $html = "<a href='' onclick='toggleCaseUpdate(\"".$update->id."\");return false;'>";
     $html .= "<img  id='caseUpdate".$update->id."Image' class='caseUpdateImage' src='".SugarThemeRegistry::current()->getImageURL('basic_search.gif')."'>";
     $html .= "</a>";
-    $html .= "<span>".($update->internal ? "<strong>" . $mod_strings['LBL_INTERNAL'] . "</strong> " : '') .$name . " ".$update->date_entered."</span><br>";
-    $notes = $update->get_linked_beans('notes','Notes');
-    if($notes){
-        $html.= $mod_strings['LBL_AOP_CASE_ATTACHMENTS'];
-        foreach($notes as $note){
+    $html .= "<span>".($update->internal ? "<strong>".$mod_strings['LBL_INTERNAL']."</strong> " : '').$name." ".$update->date_entered."</span><br>";
+    $notes = $update->get_linked_beans('notes', 'Notes');
+    if ($notes) {
+        $html .= $mod_strings['LBL_AOP_CASE_ATTACHMENTS'];
+        foreach ($notes as $note) {
             $html .= "<a href='index.php?module=Notes&action=DetailView&record={$note->id}'>{$note->filename}</a>&nbsp;";
         }
     }
@@ -220,12 +220,12 @@ 
  * @param AOP_Case_Updates $update
  * @return string - the html for the update
  */
-function display_single_update(AOP_Case_Updates $update){
+function display_single_update(AOP_Case_Updates $update) {
 
     /*if assigned user*/
-    if($update->assigned_user_id){
+    if ($update->assigned_user_id) {
         /*if internal update*/
-        if ($update->internal){
+        if ($update->internal) {
             $html = "<div id='caseStyleInternal'>".getUpdateDisplayHead($update);
             $html .= "<div id='caseUpdate".$update->id."' class='caseUpdate'>";
             $html .= nl2br(html_entity_decode($update->description));
@@ -243,7 +243,7 @@ 
     }
 
     /*if contact user*/
-    if($update->contact_id){
+    if ($update->contact_id) {
         $html = "<div id='extramargin'><div id='caseStyleContact'>".getUpdateDisplayHead($update);
         $html .= "<div id='caseUpdate".$update->id."' class='caseUpdate'>";
         $html .= nl2br(html_entity_decode($update->description));
@@ -259,11 +259,11 @@ 
  * @param $case
  * @return string - html link
  */
-function display_case_attachments($case){
+function display_case_attachments($case) {
     $html = '';
-    $notes = $case->get_linked_beans('notes','Notes');
-    if($notes){
-        foreach($notes as $note){
+    $notes = $case->get_linked_beans('notes', 'Notes');
+    if ($notes) {
+        foreach ($notes as $note) {
             $html .= "<a href='index.php?module=Notes&action=DetailView&record={$note->id}'>{$note->filename}</a>&nbsp;";
         }
     }
@@ -277,11 +277,11 @@ 
  *
  * @return string - the html to be displayed and javascript
  */
-function quick_edit_case_updates(){
+function quick_edit_case_updates() {
     global $action;
 
     //on DetailView only
-    if($action != 'DetailView') return;
+    if ($action != 'DetailView') return;
 
     //current record id
     $record = $_GET['record'];
@@ -294,7 +294,7 @@ 
     $roles = $acl->getUserRoles($id);
 
     //Return if user cannot edit cases
-    if(in_array( "no edit cases", $roles) || $roles === "no edit cases"){
+    if (in_array("no edit cases", $roles) || $roles === "no edit cases") {
 
         return;
     }

Braces +6 added lines, -4 removed lines

@@ -159,7 +159,7 @@ 
         $bDate = $b->fetched_row['date_entered'];
         if($aDate < $bDate){
             return -1;
-        }elseif($aDate > $bDate){
+        } elseif($aDate > $bDate){
             return 1;
         }
         return 0;
@@ -195,9 +195,9 @@ 
     global $mod_strings;
     if($update->contact_id){
         $name = $update->getUpdateContact()->name;
-    }elseif($update->assigned_user_id){
+    } elseif($update->assigned_user_id){
         $name = $update->getUpdateUser()->name;
-    }else{
+    } else{
         $name = "Unknown";
     }
     $html = "<a href='' onclick='toggleCaseUpdate(\"".$update->id."\");return false;'>";
@@ -281,7 +281,9 @@ 
     global $action;
 
     //on DetailView only
-    if($action != 'DetailView') return;
+    if($action != 'DetailView') {
+        return;
+    }
 
     //current record id
     $record = $_GET['record'];

Indentation +21 added lines, -21 removed lines

@@ -1,26 +1,26 @@
 <?php
 /**
- *
- * @package Advanced OpenPortal
- * @copyright SalesAgility Ltd http://www.salesagility.com
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
- * along with this program; if not, see http://www.gnu.org/licenses
- * or write to the Free Software Foundation,Inc., 51 Franklin Street,
- * Fifth Floor, Boston, MA 02110-1301  USA
- *
- * @author Salesagility Ltd <support@salesagility.com>
- */
+                 *
+                 * @package Advanced OpenPortal
+                 * @copyright SalesAgility Ltd http://www.salesagility.com
+                 *
+                 * This program is free software; you can redistribute it and/or modify
+                 * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+                 * the Free Software Foundation; either version 3 of the License, or
+                 * (at your option) any later version.
+                 *
+                 * This program is distributed in the hope that it will be useful,
+                 * but WITHOUT ANY WARRANTY; without even the implied warranty of
+                 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+                 * GNU General Public License for more details.
+                 *
+                 * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+                 * along with this program; if not, see http://www.gnu.org/licenses
+                 * or write to the Free Software Foundation,Inc., 51 Franklin Street,
+                 * Fifth Floor, Boston, MA 02110-1301  USA
+                 *
+                 * @author Salesagility Ltd <support@salesagility.com>
+                 */
 require_once 'util.php';
 class CaseUpdatesHook {
     private $slug_size = 50;

modules/AOP_Case_Updates/AOP_Case_Updates.php

Spacing +49 added lines, -49 removed lines

@@ -30,35 +30,35 @@ 
 require_once 'include/clean.php';
 class AOP_Case_Updates extends AOP_Case_Updates_sugar {
 
-    function AOP_Case_Updates(){
+    function AOP_Case_Updates() {
         parent::AOP_Case_Updates_sugar();
     }
 
-    function save($check_notify = false){
+    function save($check_notify = false) {
         $this->name = SugarCleaner::cleanHtml($this->name);
         $this->description = SugarCleaner::cleanHtml($this->description);
         global $current_user, $sugar_config;
         parent::save($check_notify);
         $email_template = new EmailTemplate();
-        if($_REQUEST['module'] == 'Import'){
+        if ($_REQUEST['module'] == 'Import') {
             //Don't send email on import
             return;
         }
-        if(!isAOPEnabled()){
+        if (!isAOPEnabled()) {
             return;
         }
-        if($this->internal){
+        if ($this->internal) {
             return;
         }
         $signature = array();
         $addDelimiter = true;
         $aop_config = $sugar_config['aop'];
-        if($this->assigned_user_id){
-            if($aop_config['contact_email_template_id']){
+        if ($this->assigned_user_id) {
+            if ($aop_config['contact_email_template_id']) {
                 $email_template = $email_template->retrieve($aop_config['contact_email_template_id']);
                 $signature = $current_user->getDefaultSignature();
             }
-            if($email_template) {
+            if ($email_template) {
                 foreach ($this->getContacts() as $contact) {
                     $GLOBALS['log']->info("AOPCaseUpdates: Calling send email");
                     $emails = array();
@@ -66,15 +66,15 @@ 
                     $res = $this->sendEmail($emails, $email_template, $signature, $this->case_id, $addDelimiter, $contact->id);
                 }
             }
-        }else{
+        } else {
             $emails = $this->getEmailForUser();
-            if($aop_config['user_email_template_id']){
+            if ($aop_config['user_email_template_id']) {
                 $email_template = $email_template->retrieve($aop_config['user_email_template_id']);
             }
             $addDelimiter = false;
-            if($emails && $email_template){
+            if ($emails && $email_template) {
                 $GLOBALS['log']->info("AOPCaseUpdates: Calling send email");
-                $res = $this->sendEmail($emails, $email_template, $signature, $this->case_id, $addDelimiter,$this->contact_id);
+                $res = $this->sendEmail($emails, $email_template, $signature, $this->case_id, $addDelimiter, $this->contact_id);
             }
         }
 
@@ -83,68 +83,68 @@ 
     /**
      * @return aCase
      */
-    public function getCase(){
-        $case = BeanFactory::getBean("Cases",$this->case_id);
+    public function getCase() {
+        $case = BeanFactory::getBean("Cases", $this->case_id);
         return $case;
     }
 
-    public function getContacts(){
+    public function getContacts() {
         $case = $this->getCase();
-        if($case){
-            return $case->get_linked_beans("contacts","Contacts");
+        if ($case) {
+            return $case->get_linked_beans("contacts", "Contacts");
         }
         return null;
     }
 
-    public function getUpdateContact(){
-        if($this->contact_id){
-            return BeanFactory::getBean("Contacts",$this->contact_id);
+    public function getUpdateContact() {
+        if ($this->contact_id) {
+            return BeanFactory::getBean("Contacts", $this->contact_id);
         }
         return null;
     }
-    public function getUser(){
-        $user = BeanFactory::getBean('Users',$this->getCase()->assigned_user_id);
+    public function getUser() {
+        $user = BeanFactory::getBean('Users', $this->getCase()->assigned_user_id);
         return $user;
     }
-    public function getUpdateUser(){
-        $user = BeanFactory::getBean('Users',$this->assigned_user_id);
+    public function getUpdateUser() {
+        $user = BeanFactory::getBean('Users', $this->assigned_user_id);
         return $user;
     }
 
-    private function getEmailForUser(){
+    private function getEmailForUser() {
         $user = $this->getUser();
-        if($user){
+        if ($user) {
             return array($user->emailAddress->getPrimaryAddress($user));
         }
         return array();
     }
 
-    private function populateTemplate(EmailTemplate $template, $addDelimiter = true, $contactId = null){
+    private function populateTemplate(EmailTemplate $template, $addDelimiter = true, $contactId = null) {
         global $app_strings, $sugar_config;
         //Order of beans seems to matter here so we place contact first.
         $userId = '';
         $user = $this->getUpdateUser();
-        if(!$user){
+        if (!$user) {
             $this->getUser();
         }
-        $beans = array("Contacts" => $contactId,"Cases" => $this->getCase()->id, "Users" => $user->id, "AOP_Case_Updates" => $this->id);
+        $beans = array("Contacts" => $contactId, "Cases" => $this->getCase()->id, "Users" => $user->id, "AOP_Case_Updates" => $this->id);
         $ret = array();
-        $ret['subject'] = from_html(aop_parse_template($template->subject,$beans));
-        $body = aop_parse_template(str_replace("\$sugarurl",$sugar_config['site_url'],$template->body_html),$beans);
-        $bodyAlt = aop_parse_template(str_replace("\$sugarurl",$sugar_config['site_url'],$template->body),$beans);
-        if($addDelimiter){
-            $body = $app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER'] . $body;
-            $bodyAlt = $app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER'] . $bodyAlt;
+        $ret['subject'] = from_html(aop_parse_template($template->subject, $beans));
+        $body = aop_parse_template(str_replace("\$sugarurl", $sugar_config['site_url'], $template->body_html), $beans);
+        $bodyAlt = aop_parse_template(str_replace("\$sugarurl", $sugar_config['site_url'], $template->body), $beans);
+        if ($addDelimiter) {
+            $body = $app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER'].$body;
+            $bodyAlt = $app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER'].$bodyAlt;
         }
         $ret['body'] = from_html($body);
         $ret['body_alt'] = strip_tags(from_html($bodyAlt));
         return $ret;
     }
 
-    private function sendEmail($emails, $template, $signature = array(), $caseId = null, $addDelimiter = true, $contactId = null){
+    private function sendEmail($emails, $template, $signature = array(), $caseId = null, $addDelimiter = true, $contactId = null) {
         $GLOBALS['log']->info("AOPCaseUpdates: sendEmail called");
         require_once("include/SugarPHPMailer.php");
-        $mailer=new SugarPHPMailer();
+        $mailer = new SugarPHPMailer();
         $admin = new Administration();
         $admin->retrieveSettings();
 
@@ -152,36 +152,36 @@ 
         $mailer->setMailerForSystem();
 
         $signatureHTML = "";
-        if($signature && array_key_exists("signature_html",$signature)){
+        if ($signature && array_key_exists("signature_html", $signature)) {
             $signatureHTML = from_html($signature['signature_html']);
         }
         $signaturePlain = "";
-        if($signature && array_key_exists("signature",$signature)){
+        if ($signature && array_key_exists("signature", $signature)) {
             $signaturePlain = $signature['signature'];
         }
         $emailSettings = getPortalEmailSettings();
-        $GLOBALS['log']->info("AOPCaseUpdates: sendEmail email portal settings are ".print_r($emailSettings,true));
+        $GLOBALS['log']->info("AOPCaseUpdates: sendEmail email portal settings are ".print_r($emailSettings, true));
         $text = $this->populateTemplate($template, $addDelimiter, $contactId);
         $mailer->Subject = $text['subject'];
-        $mailer->Body = $text['body'] . $signatureHTML;
+        $mailer->Body = $text['body'].$signatureHTML;
         $mailer->IsHTML(true);
-        $mailer->AltBody = $text['body_alt'] . $signaturePlain;
+        $mailer->AltBody = $text['body_alt'].$signaturePlain;
         $mailer->From     = $emailSettings['from_address'];
         $mailer->FromName = $emailSettings['from_name'];
-        foreach($emails as $email){
+        foreach ($emails as $email) {
             $mailer->AddAddress($email);
         }
-        if ($mailer->Send()){
+        if ($mailer->Send()) {
             require_once('modules/Emails/Email.php');
             $emailObj = new Email();
-            $emailObj->to_addrs = implode(",",$emails);
-            $emailObj->type= 'out';
+            $emailObj->to_addrs = implode(",", $emails);
+            $emailObj->type = 'out';
             $emailObj->deleted = '0';
             $emailObj->name = $mailer->Subject;
             $emailObj->description = $mailer->AltBody;
             $emailObj->description_html = $mailer->Body;
             $emailObj->from_addr = $mailer->From;
-            if ( $caseId) {
+            if ($caseId) {
                 $emailObj->parent_type = "Cases";
                 $emailObj->parent_id = $caseId;
             }
@@ -190,8 +190,8 @@ 
             $emailObj->created_by = '1';
             $emailObj->status = 'sent';
             $emailObj->save();
-        }else{
-            $GLOBALS['log']->info("AOPCaseUpdates: Could not send email:  " . $mailer->ErrorInfo);
+        } else {
+            $GLOBALS['log']->info("AOPCaseUpdates: Could not send email:  ".$mailer->ErrorInfo);
             return false;
         }
         return true;

Braces +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@ 
                     $res = $this->sendEmail($emails, $email_template, $signature, $this->case_id, $addDelimiter, $contact->id);
                 }
             }
-        }else{
+        } else{
             $emails = $this->getEmailForUser();
             if($aop_config['user_email_template_id']){
                 $email_template = $email_template->retrieve($aop_config['user_email_template_id']);
@@ -190,7 +190,7 @@ 
             $emailObj->created_by = '1';
             $emailObj->status = 'sent';
             $emailObj->save();
-        }else{
+        } else{
             $GLOBALS['log']->info("AOPCaseUpdates: Could not send email:  " . $mailer->ErrorInfo);
             return false;
         }

Doc Comments +3 added lines

@@ -279,6 +279,9 @@
         return true;
     }
 
+    /**
+     * @param EmailTemplate $template
+     */
     function parse_template(SugarBean $bean, &$template, $object_override = array()){
         global $sugar_config;
 

modules/AOP_Case_Updates/CaseUpdatesHook.php

Spacing +105 added lines, -105 removed lines

@@ -25,27 +25,27 @@ 
 class CaseUpdatesHook {
     private $slug_size = 50;
 
-    private function getCaseCounts(){
+    private function getCaseCounts() {
         global $db;
         $counts = array();
         $r = $db->query("SELECT users.id,count(cases.id) AS c FROM users LEFT JOIN cases ON (cases.assigned_user_id = users.id AND cases.status != 'Closed' AND cases.status != 'Duplicate' AND cases.status != 'Rejected') WHERE NOT users.deleted GROUP BY users.id");
-        while($a = $db->fetchByAssoc($r)){
+        while ($a = $db->fetchByAssoc($r)) {
             $counts[$a['id']] = $a['c'];
         }
         return $counts;
     }
 
-    private function getAssignToUser(){
+    private function getAssignToUser() {
         require_once 'modules/AOP_Case_Updates/AOPAssignManager.php';
         $assignManager = new AOPAssignManager();
         return $assignManager->getNextAssignedUser();
     }
 
-    private function arrangeFilesArray(){
+    private function arrangeFilesArray() {
         $count = 0;
-        foreach($_FILES['case_update_file'] as $key => $vals){
-            foreach($vals as $index => $val){
-                if(!array_key_exists('case_update_file'.$index,$_FILES)){
+        foreach ($_FILES['case_update_file'] as $key => $vals) {
+            foreach ($vals as $index => $val) {
+                if (!array_key_exists('case_update_file'.$index, $_FILES)) {
                     $_FILES['case_update_file'.$index] = array();
                     $count++;
                 }
@@ -56,34 +56,34 @@ 
     }
 
 
-    public function saveUpdate($bean, $event, $arguments){
-        if(!isAOPEnabled()){
+    public function saveUpdate($bean, $event, $arguments) {
+        if (!isAOPEnabled()) {
             return;
         }
         global $current_user, $app_list_strings;
-        if(empty($bean->fetched_row) || !$bean->id){
+        if (empty($bean->fetched_row) || !$bean->id) {
 
-            if(!$bean->state){
+            if (!$bean->state) {
                 $bean->state = $app_list_strings['case_state_default_key'];
             }
-            if($bean->status == "New"){
+            if ($bean->status == "New") {
                 $bean->status = $app_list_strings['case_status_default_key'];
             }
 
             //New case - assign
-            if(!$bean->assigned_user_id){
+            if (!$bean->assigned_user_id) {
                 $userId = $this->getAssignToUser();
                 $bean->assigned_user_id = $userId;
                 $bean->notify_inworkflow = true;
             }
             return;
         }
-        if($_REQUEST['module'] == 'Import'){
+        if ($_REQUEST['module'] == 'Import') {
             return;
         }
         //Grab the update field and create a new update with it.
         $text = $bean->update_text;
-        if(!$text && empty($_FILES['case_update_file'])){
+        if (!$text && empty($_FILES['case_update_file'])) {
             //No text or files, so nothing really to save.
             return;
         }
@@ -93,8 +93,8 @@ 
         $case_update->internal = $bean->internal;
         $bean->internal = false;
         $case_update->assigned_user_id = $current_user->id;
-        if(strlen($text) > $this->slug_size){
-            $case_update->name = substr($text,0,$this->slug_size)."...";
+        if (strlen($text) > $this->slug_size) {
+            $case_update->name = substr($text, 0, $this->slug_size)."...";
         }
         $case_update->description = nl2br($text);
         $case_update->case_id = $bean->id;
@@ -102,12 +102,12 @@ 
 
         $fileCount = $this->arrangeFilesArray();
 
-        for($x = 0; $x < $fileCount; $x++){
-            if($_FILES['case_update_file']['error'][$x] == UPLOAD_ERR_NO_FILE){
+        for ($x = 0; $x < $fileCount; $x++) {
+            if ($_FILES['case_update_file']['error'][$x] == UPLOAD_ERR_NO_FILE) {
                 continue;
             }
             $uploadFile = new UploadFile('case_update_file'.$x);
-            if(!$uploadFile->confirm_upload()){
+            if (!$uploadFile->confirm_upload()) {
                 continue;
             }
             $note = $this->newNote($case_update->id);
@@ -118,13 +118,13 @@ 
             $uploadFile->final_move($note->id);
         }
         $postPrefix = 'case_update_id_';
-        foreach($_POST as $key => $val){
-            if(strpos($key, $postPrefix) !== 0 || empty($val)){
+        foreach ($_POST as $key => $val) {
+            if (strpos($key, $postPrefix) !== 0 || empty($val)) {
                 continue;
             }
             //Val is selected doc id
-            $doc = BeanFactory::getBean('Documents',$val);
-            if(!$doc){
+            $doc = BeanFactory::getBean('Documents', $val);
+            if (!$doc) {
                 continue;
             }
             $note = $this->newNote($case_update->id);
@@ -134,11 +134,11 @@ 
             $note->save();
             $srcFile = "upload://{$doc->document_revision_id}";
             $destFile = "upload://{$note->id}";
-            copy($srcFile,$destFile);
+            copy($srcFile, $destFile);
         }
     }
 
-    private function newNote($caseUpdateId){
+    private function newNote($caseUpdateId) {
         $note = BeanFactory::newBean('Notes');
         $note->parent_type = 'AOP_Case_Updates';
         $note->parent_id = $caseUpdateId;
@@ -146,30 +146,30 @@ 
         return $note;
     }
 
-    private function linkAccountAndCase($case_id,$account_id){
-        if(!$account_id || !$case_id){
+    private function linkAccountAndCase($case_id, $account_id) {
+        if (!$account_id || !$case_id) {
             return;
         }
-        $case = BeanFactory::getBean("Cases",$case_id);
-        if(!$case->account_id){
+        $case = BeanFactory::getBean("Cases", $case_id);
+        if (!$case->account_id) {
             $case->account_id = $account_id;
             $case->save();
         }
     }
 
-    public function assignAccount($bean, $event, $arguments){
-        if($arguments['module'] != "Cases" || $arguments['related_module'] != "Contacts"){
+    public function assignAccount($bean, $event, $arguments) {
+        if ($arguments['module'] != "Cases" || $arguments['related_module'] != "Contacts") {
             return;
         }
-        if(!isAOPEnabled()){
+        if (!isAOPEnabled()) {
             return;
         }
-        $contact = BeanFactory::getBean("Contacts",$arguments['related_id']);
+        $contact = BeanFactory::getBean("Contacts", $arguments['related_id']);
         $contact->load_relationship("accounts");
-        if(!$contact || !$contact->account_id){
+        if (!$contact || !$contact->account_id) {
             return;
         }
-        $this->linkAccountAndCase($bean->id,$contact->account_id);
+        $this->linkAccountAndCase($bean->id, $contact->account_id);
     }
 
     /**
@@ -178,26 +178,26 @@ 
      * @param $event
      * @param $arguments
      */
-    public function saveEmailUpdate($bean, $event, $arguments){
+    public function saveEmailUpdate($bean, $event, $arguments) {
         global $mod_strings;
-        if($bean->intent != "createcase" || $bean->parent_type != "Cases"){
+        if ($bean->intent != "createcase" || $bean->parent_type != "Cases") {
             $GLOBALS['log']->warn("CaseUpdatesHook: saveEmailUpdate: Not a create case or wrong parent type");
             return;
         }
-        if(!isAOPEnabled()){
+        if (!isAOPEnabled()) {
             return;
         }
-        if(!$bean->parent_id ){
+        if (!$bean->parent_id) {
             $GLOBALS['log']->warn("CaseUpdatesHook: saveEmailUpdate No parent id");
             return;
         }
 
-        if($bean->cases){
+        if ($bean->cases) {
             $GLOBALS['log']->warn("CaseUpdatesHook: saveEmailUpdate cases already set");
             return;
         }
 
-        if($bean->fetched_row['parent_id']){
+        if ($bean->fetched_row['parent_id']) {
             //Will have been processed already
             return;
         }
@@ -206,10 +206,10 @@ 
         $ea = new SugarEmailAddress();
         $beans = $ea->getBeansByEmailAddress($bean->from_addr);
         $contact_id = null;
-        foreach($beans as $emailBean){
-            if($emailBean->module_name == "Contacts" && !empty($emailBean->id)){
+        foreach ($beans as $emailBean) {
+            if ($emailBean->module_name == "Contacts" && !empty($emailBean->id)) {
                 $contact_id = $emailBean->id;
-                $this->linkAccountAndCase($bean->parent_id,$emailBean->account_id);
+                $this->linkAccountAndCase($bean->parent_id, $emailBean->account_id);
             }
         }
         $case_update = new AOP_Case_Updates();
@@ -220,8 +220,8 @@ 
         $case_update->internal = false;
         $case_update->case_id = $bean->parent_id;
         $case_update->save();
-        $notes = $bean->get_linked_beans('notes','Notes');
-        foreach($notes as $note){
+        $notes = $bean->get_linked_beans('notes', 'Notes');
+        foreach ($notes as $note) {
             //Link notes to case update also
             $newNote = BeanFactory::newBean('Notes');
             $newNote->name = $note->name;
@@ -232,7 +232,7 @@ 
             $newNote->save();
             $srcFile = "upload://{$note->id}";
             $destFile = "upload://{$newNote->id}";
-            copy($srcFile,$destFile);
+            copy($srcFile, $destFile);
         }
 
         $this->updateCaseStatus($case_update->case_id);
@@ -242,71 +242,71 @@ 
      * Changes the status of the supplied case based on the case_status_changes config values.
      * @param $caseId
      */
-    private function updateCaseStatus($caseId){
+    private function updateCaseStatus($caseId) {
         global $sugar_config;
-        if(empty($caseId)){
+        if (empty($caseId)) {
             return;
         }
-        if(empty($sugar_config['aop']['case_status_changes'])){
+        if (empty($sugar_config['aop']['case_status_changes'])) {
             return;
         }
-        $statusMap = json_decode($sugar_config['aop']['case_status_changes'],1);
-        if(empty($statusMap)){
+        $statusMap = json_decode($sugar_config['aop']['case_status_changes'], 1);
+        if (empty($statusMap)) {
             return;
         }
-        $case = BeanFactory::getBean('Cases',$caseId);
-        if(empty($case)){
+        $case = BeanFactory::getBean('Cases', $caseId);
+        if (empty($case)) {
             return;
         }
-        if(array_key_exists($case->status,$statusMap)){
+        if (array_key_exists($case->status, $statusMap)) {
             $case->status = $statusMap[$case->status];
-            $statusBits = explode('_',$case->status);
+            $statusBits = explode('_', $case->status);
             $case->state = array_shift($statusBits);
             $case->save();
         }
 
     }
 
-    private function unquoteEmail($text){
+    private function unquoteEmail($text) {
         global $app_strings;
         $text = html_entity_decode($text);
-        $text = preg_replace('/(\r\n|\r|\n)/s',"\n",$text);
-        $pos = strpos($text,$app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER']);
-        if($pos !== false){
-            $text = substr($text,0,$pos);
+        $text = preg_replace('/(\r\n|\r|\n)/s', "\n", $text);
+        $pos = strpos($text, $app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER']);
+        if ($pos !== false) {
+            $text = substr($text, 0, $pos);
         }
         return $text;
     }
 
-    public function closureNotifyPrep($bean, $event, $arguments){
-        if($_REQUEST['module'] == 'Import'){
+    public function closureNotifyPrep($bean, $event, $arguments) {
+        if ($_REQUEST['module'] == 'Import') {
             return;
         }
-        if($bean->state!= "Closed" || $bean->fetched_row['state'] == "Closed"){
+        if ($bean->state != "Closed" || $bean->fetched_row['state'] == "Closed") {
             $bean->send_closure_email = false;
-        }else{
+        } else {
             $bean->send_closure_email = true;
         }
 
     }
 
-    public function closureNotify($bean, $event, $arguments){
-        if($_REQUEST['module'] == 'Import'){
+    public function closureNotify($bean, $event, $arguments) {
+        if ($_REQUEST['module'] == 'Import') {
             return;
         }
-        if($bean->state != "Closed" || !$bean->send_closure_email){
+        if ($bean->state != "Closed" || !$bean->send_closure_email) {
             return;
         }
         $this->sendClosureEmail($bean, $arguments['related_bean']);
     }
 
-    private function sendClosureEmail(aCase $bean){
-        if(!isAOPEnabled()){
+    private function sendClosureEmail(aCase $bean) {
+        if (!isAOPEnabled()) {
             return;
         }
         $GLOBALS['log']->warn("CaseUpdatesHook: sendClosureEmail called");
         require_once("include/SugarPHPMailer.php");
-        $mailer=new SugarPHPMailer();
+        $mailer = new SugarPHPMailer();
         $admin = new Administration();
         $admin->retrieveSettings();
 
@@ -315,18 +315,18 @@ 
 
         $email_template = new EmailTemplate();
         $aop_config = $this->getAOPConfig();
-        $GLOBALS['log']->warn("CaseUpdatesHook: sendClosureEmail Config is ".print_r($aop_config,true));
+        $GLOBALS['log']->warn("CaseUpdatesHook: sendClosureEmail Config is ".print_r($aop_config, true));
         $email_template = $email_template->retrieve($aop_config['case_closure_email_template_id']);
 
-        if(!$email_template){
+        if (!$email_template) {
             $GLOBALS['log']->warn("CaseUpdatesHook: sendClosureEmail template is empty");
             return false;
         }
 
-        $contact = $bean->get_linked_beans("contacts","Contact");
-        if($contact){
+        $contact = $bean->get_linked_beans("contacts", "Contact");
+        if ($contact) {
             $contact = $contact[0];
-        }else{
+        } else {
             return false;
         }
 
@@ -343,10 +343,10 @@ 
         $email = $contact->emailAddress->getPrimaryAddress($contact);
 
         $mailer->AddAddress($email);
-        if (!$mailer->Send()){
-            $GLOBALS['log']->info("CaseUpdatesHook: Could not send email:  " . $mailer->ErrorInfo);
+        if (!$mailer->Send()) {
+            $GLOBALS['log']->info("CaseUpdatesHook: Could not send email:  ".$mailer->ErrorInfo);
             return false;
-        }else{
+        } else {
             $this->logEmail($email, $mailer, $bean->id);
             return true;
         }
@@ -359,25 +359,25 @@ 
      * @param $event
      * @param $arguments
      */
-    public function creationNotify($bean, $event, $arguments){
-        if($_REQUEST['module'] == 'Import'){
+    public function creationNotify($bean, $event, $arguments) {
+        if ($_REQUEST['module'] == 'Import') {
             return;
         }
-        if($arguments['module'] != "Cases" || $arguments['related_module'] != "Contacts"){
+        if ($arguments['module'] != "Cases" || $arguments['related_module'] != "Contacts") {
             return;
         }
-        if(!$bean->fetched_row){
+        if (!$bean->fetched_row) {
             return;
         }
-        if(!empty($arguments['related_bean'])){
+        if (!empty($arguments['related_bean'])) {
             $contact = $arguments['related_bean'];
-        }else{
-            $contact = BeanFactory::getBean("Contacts",$arguments['related_id']);
+        } else {
+            $contact = BeanFactory::getBean("Contacts", $arguments['related_id']);
         }
         $this->sendCreationEmail($bean, $contact);
     }
 
-    private function populateTemplate(EmailTemplate $template, aCase $bean, $contact){
+    private function populateTemplate(EmailTemplate $template, aCase $bean, $contact) {
         global $app_strings, $sugar_config;
         //Order of beans seems to matter here so we place contact first.
         $beans = array(
@@ -386,26 +386,26 @@ 
             "Users" => $bean->assigned_user_id
         );
         $ret = array();
-        $ret['subject'] = from_html(aop_parse_template($template->subject,$beans));
-        $ret['body'] = from_html($app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER'].aop_parse_template(str_replace("\$sugarurl",$sugar_config['site_url'],$template->body_html),$beans));
-        $ret['body_alt'] = strip_tags(from_html(aop_parse_template(str_replace("\$sugarurl",$sugar_config['site_url'],$template->body),$beans)));
+        $ret['subject'] = from_html(aop_parse_template($template->subject, $beans));
+        $ret['body'] = from_html($app_strings['LBL_AOP_EMAIL_REPLY_DELIMITER'].aop_parse_template(str_replace("\$sugarurl", $sugar_config['site_url'], $template->body_html), $beans));
+        $ret['body_alt'] = strip_tags(from_html(aop_parse_template(str_replace("\$sugarurl", $sugar_config['site_url'], $template->body), $beans)));
         return $ret;
     }
 
-    private function getAOPConfig(){
+    private function getAOPConfig() {
         global $sugar_config;
-        if(!array_key_exists("aop",$sugar_config)){
+        if (!array_key_exists("aop", $sugar_config)) {
             return array();
         }
         return $sugar_config['aop'];
     }
 
-    private function sendCreationEmail(aCase $bean, $contact){
-        if(!isAOPEnabled()){
+    private function sendCreationEmail(aCase $bean, $contact) {
+        if (!isAOPEnabled()) {
             return;
         }
         require_once("include/SugarPHPMailer.php");
-        $mailer=new SugarPHPMailer();
+        $mailer = new SugarPHPMailer();
         $admin = new Administration();
         $admin->retrieveSettings();
 
@@ -416,7 +416,7 @@ 
 
         $aop_config = $this->getAOPConfig();
         $email_template = $email_template->retrieve($aop_config['case_creation_email_template_id']);
-        if(!$aop_config['case_creation_email_template_id'] || !$email_template){
+        if (!$aop_config['case_creation_email_template_id'] || !$email_template) {
             $GLOBALS['log']->warn("CaseUpdatesHook: sendCreationEmail template is empty");
             return false;
         }
@@ -430,24 +430,24 @@ 
         $mailer->From     = $emailSettings['from_address'];
         $mailer->FromName = $emailSettings['from_name'];
         $email = $contact->emailAddress->getPrimaryAddress($contact);
-        if(empty($email) && !empty($contact->email1)){
+        if (empty($email) && !empty($contact->email1)) {
             $email = $contact->email1;
         }
         $mailer->AddAddress($email);
-        if (!$mailer->Send()){
-            $GLOBALS['log']->info("CaseUpdatesHook: Could not send email:  " . $mailer->ErrorInfo);
+        if (!$mailer->Send()) {
+            $GLOBALS['log']->info("CaseUpdatesHook: Could not send email:  ".$mailer->ErrorInfo);
             return false;
-        }else{
+        } else {
             $this->logEmail($email, $mailer, $bean->id);
             return true;
         }
     }
 
-    private function logEmail($email, $mailer, $caseId = null){
+    private function logEmail($email, $mailer, $caseId = null) {
         require_once('modules/Emails/Email.php');
         $emailObj = new Email();
         $emailObj->to_addrs = $email;
-        $emailObj->type= 'out';
+        $emailObj->type = 'out';
         $emailObj->deleted = '0';
         $emailObj->name = $mailer->Subject;
         $emailObj->description = $mailer->AltBody;
@@ -464,7 +464,7 @@ 
         $emailObj->save();
     }
 
-    public function filterHTML($bean, $event, $arguments){
-        $bean->description = SugarCleaner::cleanHtml($bean->description,true);
+    public function filterHTML($bean, $event, $arguments) {
+        $bean->description = SugarCleaner::cleanHtml($bean->description, true);
     }
 }

Braces +5 added lines, -5 removed lines

@@ -284,7 +284,7 @@ 
         }
         if($bean->state!= "Closed" || $bean->fetched_row['state'] == "Closed"){
             $bean->send_closure_email = false;
-        }else{
+        } else{
             $bean->send_closure_email = true;
         }
 
@@ -326,7 +326,7 @@ 
         $contact = $bean->get_linked_beans("contacts","Contact");
         if($contact){
             $contact = $contact[0];
-        }else{
+        } else{
             return false;
         }
 
@@ -346,7 +346,7 @@ 
         if (!$mailer->Send()){
             $GLOBALS['log']->info("CaseUpdatesHook: Could not send email:  " . $mailer->ErrorInfo);
             return false;
-        }else{
+        } else{
             $this->logEmail($email, $mailer, $bean->id);
             return true;
         }
@@ -371,7 +371,7 @@ 
         }
         if(!empty($arguments['related_bean'])){
             $contact = $arguments['related_bean'];
-        }else{
+        } else{
             $contact = BeanFactory::getBean("Contacts",$arguments['related_id']);
         }
         $this->sendCreationEmail($bean, $contact);
@@ -437,7 +437,7 @@ 
         if (!$mailer->Send()){
             $GLOBALS['log']->info("CaseUpdatesHook: Could not send email:  " . $mailer->ErrorInfo);
             return false;
-        }else{
+        } else{
             $this->logEmail($email, $mailer, $bean->id);
             return true;
         }

Doc Comments +3 added lines

@@ -443,6 +443,9 @@
         }
     }
 
+    /**
+     * @param SugarPHPMailer $mailer
+     */
     private function logEmail($email, $mailer, $caseId = null){
         require_once('modules/Emails/Email.php');
         $emailObj = new Email();

Indentation +21 added lines, -21 removed lines

@@ -1,26 +1,26 @@
 <?php
 /**
- *
- * @package Advanced OpenPortal
- * @copyright SalesAgility Ltd http://www.salesagility.com
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
- * along with this program; if not, see http://www.gnu.org/licenses
- * or write to the Free Software Foundation,Inc., 51 Franklin Street,
- * Fifth Floor, Boston, MA 02110-1301  USA
- *
- * @author Salesagility Ltd <support@salesagility.com>
- */
+         *
+         * @package Advanced OpenPortal
+         * @copyright SalesAgility Ltd http://www.salesagility.com
+         *
+         * This program is free software; you can redistribute it and/or modify
+         * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+         * the Free Software Foundation; either version 3 of the License, or
+         * (at your option) any later version.
+         *
+         * This program is distributed in the hope that it will be useful,
+         * but WITHOUT ANY WARRANTY; without even the implied warranty of
+         * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+         * GNU General Public License for more details.
+         *
+         * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+         * along with this program; if not, see http://www.gnu.org/licenses
+         * or write to the Free Software Foundation,Inc., 51 Franklin Street,
+         * Fifth Floor, Boston, MA 02110-1301  USA
+         *
+         * @author Salesagility Ltd <support@salesagility.com>
+         */
 
 
 function display_updates($focus, $field, $value, $view){

modules/AOP_Case_Updates/AOP_Case_Updates_sugar.php

Indentation +51 added lines, -51 removed lines

@@ -1,26 +1,26 @@ 
 <?PHP
 /**
- *
- * @package Advanced OpenPortal
- * @copyright SalesAgility Ltd http://www.salesagility.com
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
- * along with this program; if not, see http://www.gnu.org/licenses
- * or write to the Free Software Foundation,Inc., 51 Franklin Street,
- * Fifth Floor, Boston, MA 02110-1301  USA
- *
- * @author Salesagility Ltd <support@salesagility.com>
- */
+     *
+     * @package Advanced OpenPortal
+     * @copyright SalesAgility Ltd http://www.salesagility.com
+     *
+     * This program is free software; you can redistribute it and/or modify
+     * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+     * the Free Software Foundation; either version 3 of the License, or
+     * (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+     * along with this program; if not, see http://www.gnu.org/licenses
+     * or write to the Free Software Foundation,Inc., 51 Franklin Street,
+     * Fifth Floor, Boston, MA 02110-1301  USA
+     *
+     * @author Salesagility Ltd <support@salesagility.com>
+     */
 
 /**
  * THIS CLASS IS GENERATED BY MODULE BUILDER
@@ -30,37 +30,37 @@ 
 
 
 class AOP_Case_Updates_sugar extends Basic {
-	var $new_schema = true;
-	var $module_dir = 'AOP_Case_Updates';
-	var $object_name = 'AOP_Case_Updates';
-	var $table_name = 'aop_case_updates';
-	var $tracker_visibility = false;
-	var $importable = false;
-	var $disable_row_level_security = true ; // to ensure that modules created and deployed under CE will continue to function under team security if the instance is upgraded to PRO
-		var $id;
-		var $name;
-		var $date_entered;
-		var $date_modified;
-		var $modified_user_id;
-		var $modified_by_name;
-		var $created_by;
-		var $created_by_name;
-		var $description;
-		var $deleted;
-		var $created_by_link;
-		var $modified_user_link;
-		var $assigned_user_id;
-		var $assigned_user_name;
-		var $assigned_user_link;
-		function AOP_Case_Updates_sugar(){	
-		parent::Basic();
-	}
+    var $new_schema = true;
+    var $module_dir = 'AOP_Case_Updates';
+    var $object_name = 'AOP_Case_Updates';
+    var $table_name = 'aop_case_updates';
+    var $tracker_visibility = false;
+    var $importable = false;
+    var $disable_row_level_security = true ; // to ensure that modules created and deployed under CE will continue to function under team security if the instance is upgraded to PRO
+        var $id;
+        var $name;
+        var $date_entered;
+        var $date_modified;
+        var $modified_user_id;
+        var $modified_by_name;
+        var $created_by;
+        var $created_by_name;
+        var $description;
+        var $deleted;
+        var $created_by_link;
+        var $modified_user_link;
+        var $assigned_user_id;
+        var $assigned_user_name;
+        var $assigned_user_link;
+        function AOP_Case_Updates_sugar(){	
+        parent::Basic();
+    }
 	
-	function bean_implements($interface){
-		switch($interface){
-			case 'ACL': return true;
-		}
-		return false;
+    function bean_implements($interface){
+        switch($interface){
+            case 'ACL': return true;
+        }
+        return false;
 }
 		
 }

Spacing +4 added lines, -4 removed lines

@@ -36,7 +36,7 @@ 
 	var $table_name = 'aop_case_updates';
 	var $tracker_visibility = false;
 	var $importable = false;
-	var $disable_row_level_security = true ; // to ensure that modules created and deployed under CE will continue to function under team security if the instance is upgraded to PRO
+	var $disable_row_level_security = true; // to ensure that modules created and deployed under CE will continue to function under team security if the instance is upgraded to PRO
 		var $id;
 		var $name;
 		var $date_entered;
@@ -52,12 +52,12 @@ 
 		var $assigned_user_id;
 		var $assigned_user_name;
 		var $assigned_user_link;
-		function AOP_Case_Updates_sugar(){	
+		function AOP_Case_Updates_sugar() {	
 		parent::Basic();
 	}
 	
-	function bean_implements($interface){
-		switch($interface){
+	function bean_implements($interface) {
+		switch ($interface) {
 			case 'ACL': return true;
 		}
 		return false;