modules/UpgradeWizard/SugarMerge/SubpanelMerge.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  40  * Description:  Defines the English language pack for the base application.
  41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  42  * All Rights Reserved.
  43  * Contributor(s): ______________________________________..
  44  ********************************************************************************/
  45
  46 require_once('modules/UpgradeWizard/SugarMerge/ListViewMerge.php');
  47 /**
  48  * SubpanelMerge is a class for merging subpanel meta data together. This subpanel meta-data is a mix of the layouts seen in listviews and editviews
  49  *
  50  */
  51
  52 class SubpanelMerge extends ListViewMerge{
  53         protected $varName = 'subpanel_layout';
  54         protected $viewDefs = 'SubPanel';
  55         /**
  56          * Loads the meta data of the original, new, and custom file into the variables originalData, newData, and customData respectively it then transforms them into a structure that EditView Merge would understand
  57          *
  58          * @param STRING $module - name of the module's files that are to be merged
  59          * @param STRING $original_file - path to the file that originally shipped with sugar
  60          * @param STRING $new_file - path to the new file that is shipping with the patch
  61          * @param STRING $custom_file - path to the custom file
  62          */
  63         protected function loadData($module, $original_file, $new_file, $custom_file){
  64                 parent::loadData($module, $original_file, $new_file, $custom_file);
  65                 $this->originalData = array($module=>array( $this->viewDefs=>array($this->panelName=>array('DEFAULT'=>$this->originalData[$module]['list_fields']))));
  66                 $this->customData = array($module=>array( $this->viewDefs=>array($this->panelName=>array('DEFAULT'=>$this->customData[$module]['list_fields']))));
  67                 $this->mergeData = $this->newData;
  68                 $this->newData = array($module=>array( $this->viewDefs=>array($this->panelName=>array('DEFAULT'=>$this->newData[$module]['list_fields']))));
  69
  70         }
  71
  72         /**
  73          * We take mergeData which is a copy of the new meta data prior to merging and set it's list_fields variable to the merged panels
  74          *
  75          */
  76         protected function setPanels(){
  77                 $this->mergeData['list_fields'] = $this->buildPanels();
  78         }
  79
  80         /**
  81          * This will save the merged data to a file
  82          *
  83          * @param STRING $to - path of the file to save it to
  84          * @return BOOLEAN - success or failure of the save
  85          */
  86         public function save($to){
  87                 return write_array_to_file("$this->varName", $this->newData, $to);
  88         }
  89 }
  90
  91 ?>