modules/ModuleBuilder/parsers/StandardField.php

   1 <?php
   2 if (! defined ( 'sugarEntry' ) || ! sugarEntry)
   3     die ( 'Not A Valid Entry Point' ) ;
   4 /*********************************************************************************
   5  * SugarCRM Community Edition is a customer relationship management program developed by
   6  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Affero General Public License version 3 as published by the
  10  * Free Software Foundation with the addition of the following permission added
  11  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  12  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  13  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License along with
  21  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  22  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23  * 02110-1301 USA.
  24  *
  25  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  26  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  27  *
  28  * The interactive user interfaces in modified source and object code versions
  29  * of this program must display Appropriate Legal Notices, as required under
  30  * Section 5 of the GNU Affero General Public License version 3.
  31  *
  32  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  33  * these Appropriate Legal Notices must retain the display of the "Powered by
  34  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  35  * technical reasons, the Appropriate Legal Notices must display the words
  36  * "Powered by SugarCRM".
  37  ********************************************************************************/
  38
  39
  40 require_once ('modules/DynamicFields/DynamicField.php') ;
  41
  42 class StandardField extends DynamicField
  43 {
  44         var $custom_def = array();
  45         var $base_def = array();
  46         var $baseField;
  47
  48
  49     function __construct($module = '') {
  50         parent::DynamicField($module);
  51     }
  52
  53     protected function loadCustomDef($field){
  54         global $beanList;
  55         if (!empty($beanList[$this->module]) && is_file("custom/Extension/modules/{$this->module}/Ext/Vardefs/sugarfield_$field.php"))
  56         {
  57                 $dictionary = array($beanList[$this->module] => array("fields" => array($field => array())));
  58             include("$this->base_path/sugarfield_$field.php");
  59             if (!empty($dictionary[$beanList[$this->module]]) && isset($dictionary[$beanList[$this->module]]["fields"][$field]))
  60                 $this->custom_def = $dictionary[$beanList[$this->module]]["fields"][$field];
  61         }
  62     }
  63
  64     protected function loadBaseDef($field){
  65         global $beanList;
  66         if (!empty($beanList[$this->module]) && is_file("modules/{$this->module}/vardefs.php"))
  67         {
  68             $dictionary = array();
  69             include("modules/{$this->module}/vardefs.php");
  70             if (!empty($dictionary[$beanList[$this->module]]) && isset($dictionary[$beanList[$this->module]]["fields"][$field]))
  71                 $this->base_def = $dictionary[$beanList[$this->module]]["fields"][$field];
  72         }
  73     }
  74
  75     /**
  76      * Adds a custom field using a field object
  77      *
  78      * @param Field Object $field
  79      * @return boolean
  80      */
  81     function addFieldObject(&$field){
  82         global $dictionary, $beanList;
  83
  84
  85         if (empty($beanList[$this->module]))
  86             return false;
  87
  88         $bean_name = get_valid_bean_name($this->module);
  89
  90         if (empty($dictionary[$bean_name]) || empty($dictionary[$bean_name]["fields"][$field->name]))
  91             return false;
  92
  93         $currdef = $dictionary[$bean_name]["fields"][$field->name];
  94         $this->loadCustomDef($field->name);
  95         $this->loadBaseDef($field->name);
  96         $newDef = $field->get_field_def();
  97
  98         require_once ('modules/DynamicFields/FieldCases.php') ;
  99         $this->baseField = get_widget ( $field->type) ;
 100         foreach ($field->vardef_map as $property => $fmd_col){
 101
 102                 if ($property == "action" || $property == "label_value" || $property == "label"
 103                 || ((substr($property, 0,3) == 'ext' && strlen($property) == 4))
 104             )
 105                 continue;
 106
 107             // Bug 37043 - Avoid writing out vardef defintions that are the default value.
 108             if (isset($newDef[$property]) &&
 109                 ((!isset($currdef[$property]) && !$this->isDefaultValue($property,$newDef[$property], $this->baseField))
 110                         || (isset($currdef[$property]) && $currdef[$property] != $newDef[$property])
 111                 )
 112             ){
 113                 $this->custom_def[$property] =
 114                     is_string($newDef[$property]) ? htmlspecialchars_decode($newDef[$property], ENT_QUOTES) : $newDef[$property];
 115             }
 116
 117             //Remove any orphaned entries
 118             if (isset($this->custom_def[$property]) && !isset($newDef[$property]))
 119                 unset($this->custom_def[$property]);
 120
 121             //Handle overrides of out of the box definitions with empty
 122             if (!empty($this->base_def[$property]) && !isset($newDef[$property]))
 123             {
 124                 //Switch on type of the property to find what the correct 'empty' is.
 125                 if(is_string($this->base_def[$property]))
 126                     $this->custom_def[$property] = "";
 127                 else if(is_array($this->base_def[$property]))
 128                     $this->custom_def[$property] = array();
 129                 else if(is_bool($this->base_def[$property]))
 130                     $this->custom_def[$property] = false;
 131                 else
 132                     $this->custom_def[$property] = null;
 133             }
 134         }
 135
 136         if (isset($this->custom_def["duplicate_merge_dom_value"]) && !isset($this->custom_def["duplicate_merge"]))
 137                 unset($this->custom_def["duplicate_merge_dom_value"]);
 138
 139         $this->writeVardefExtension($bean_name, $field, $this->custom_def);
 140     }
 141
 142
 143 }
 144
 145 ?>