include/VarDefHandler/VarDefHandler.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
  39
  40 /**
  41  * Vardef Handler Object
  42  * @api
  43  */
  44 class VarDefHandler {
  45
  46         var $meta_array_name;
  47         var $target_meta_array = false;
  48         var $start_none = false;
  49         var $extra_array = array();                                     //used to add custom items
  50         var $options_array = array();
  51         var $module_object;
  52         var $start_none_lbl = null;
  53
  54         function VarDefHandler(& $module, $meta_array_name=null){
  55                 $this->module_object = $module;
  56                 if($meta_array_name!=null){
  57                         global $vardef_meta_array;
  58                         include("include/VarDefHandler/vardef_meta_arrays.php");
  59                         $this->target_meta_array = $vardef_meta_array[$meta_array_name];
  60                 }
  61
  62         //end function setup
  63         }
  64
  65         function get_vardef_array($use_singular=false, $remove_dups = false, $use_field_name = false, $use_field_label = false){
  66                 global $dictionary;
  67                 global $current_language;
  68                 global $app_strings;
  69                 global $app_list_strings;
  70
  71                 $temp_module_strings = return_module_language($current_language, $this->module_object->module_dir);
  72
  73                 $base_array = $this->module_object->field_defs;
  74                 //$base_array = $dictionary[$this->module_object->object_name]['fields'];
  75
  76                 ///Inclue empty none set or not
  77                 if($this->start_none==true){
  78                         if(!empty($this->start_none_lbl)){
  79                                 $this->options_array[''] = $this->start_none_lbl;
  80                         } else {
  81                                 $this->options_array[''] = $app_strings['LBL_NONE'];
  82                         }
  83                 }
  84
  85         ///used for special one off items added to filter array  ex. would be href link for alert templates
  86                 if(!empty($this->extra_array)){
  87
  88                         foreach($this->extra_array as $key => $value){
  89                                 $this->options_array[$key] = $value;
  90                         }
  91                 }
  92         /////////end special one off//////////////////////////////////
  93
  94
  95                 foreach($base_array as $key => $value_array){
  96                         $compare_results = $this->compare_type($value_array);
  97
  98                         if($compare_results == true){
  99                                  $label_name = '';
 100                  if($value_array['type'] == 'link' && !$use_field_label){
 101                         $this->module_object->load_relationship($value_array['name']);
 102                     if(!empty($app_list_strings['moduleList'][$this->module_object->$value_array['name']->getRelatedModuleName()])){
 103                         $label_name = $app_list_strings['moduleList'][$this->module_object->$value_array['name']->getRelatedModuleName()];
 104                     }else{
 105                         $label_name = $this->module_object->$value_array['name']->getRelatedModuleName();
 106                     }
 107                 }
 108                                 else if(!empty($value_array['vname'])){
 109                                         $label_name = $value_array['vname'];
 110                                 } else {
 111                                         $label_name = $value_array['name'];
 112                                 }
 113
 114
 115                                 $label_name = get_label($label_name, $temp_module_strings);
 116
 117                                 if(!empty($value_array['table'])){
 118                                         //Custom Field
 119                                         $column_table = $value_array['table'];
 120                                 } else {
 121                                         //Non-Custom Field
 122                                         $column_table = $this->module_object->table_name;
 123                                 }
 124
 125                 if($value_array['type'] == 'link'){
 126                         if($use_field_name){
 127                                 $index = $value_array['name'];
 128
 129                         }else{
 130                                 $index = $this->module_object->$key->getRelatedModuleName();
 131                         }
 132                 }else{
 133                                         $index = $key;
 134                 }
 135
 136                                 $value = trim($label_name, ':');
 137                                 if($remove_dups){
 138                                         if(!in_array($value, $this->options_array))
 139                                                 $this->options_array[$index] = $value;
 140                                 }
 141                                 else
 142                                         $this->options_array[$index] = $value;
 143
 144                         //end if field is included
 145                         }
 146
 147                 //end foreach
 148                 }
 149                 if($use_singular == true){
 150                         return convert_module_to_singular($this->options_array);
 151                 } else {
 152                         return $this->options_array;
 153                 }
 154
 155         //end get_vardef_array
 156         }
 157
 158
 159         function compare_type($value_array){
 160
 161                 //Filter nothing?
 162                 if(!is_array($this->target_meta_array)){
 163                         return true;
 164                 }
 165
 166                 ////////Use the $target_meta_array;
 167                 if(isset($this->target_meta_array['inc_override'])){
 168                         foreach($this->target_meta_array['inc_override'] as $attribute => $value){
 169
 170                                         foreach($value as $actual_value){
 171                                                 if(isset($value_array[$attribute]) && $value_array[$attribute] == $actual_value) return true;
 172                                         }
 173                                         if(isset($value_array[$attribute]) && $value_array[$attribute] == $value) return true;
 174
 175                         }
 176                 }
 177                 if(isset($this->target_meta_array['ex_override'])){
 178                         foreach($this->target_meta_array['ex_override'] as $attribute => $value){
 179
 180
 181                                         foreach($value as $actual_value){
 182                                         if(isset($value_array[$attribute]) && $value_array[$attribute] == $actual_value) return false;
 183
 184                                                 if(isset($value_array[$attribute]) && $value_array[$attribute] == $value) return false;
 185                                         }
 186
 187                         //end foreach inclusion array
 188                         }
 189                 }
 190
 191                 if(isset($this->target_meta_array['inclusion'])){
 192                         foreach($this->target_meta_array['inclusion'] as $attribute => $value){
 193
 194                                 if($attribute=="type"){
 195                                         foreach($value as $actual_value){
 196                                         if(isset($value_array[$attribute]) && $value_array[$attribute] != $actual_value) return false;
 197                                         }
 198                                 } else {
 199                                         if(isset($value_array[$attribute]) && $value_array[$attribute] != $value) return false;
 200                                 }
 201                         //end foreach inclusion array
 202                         }
 203                 }
 204
 205                 if(isset($this->target_meta_array['exclusion'])){
 206                         foreach($this->target_meta_array['exclusion'] as $attribute => $value){
 207
 208                                 foreach($value as $actual_value){
 209                                     if ( $attribute == 'reportable' ) {
 210                                         if ( $actual_value == 'true' ) $actual_value = 1;
 211                                         if ( $actual_value == 'false' ) $actual_value = 0;
 212                                     }
 213                                         if(isset($value_array[$attribute]) && $value_array[$attribute] == $actual_value) return false;
 214                                 }
 215
 216                         //end foreach inclusion array
 217                         }
 218                 }
 219
 220
 221                 return true;
 222
 223         //end function compare_type
 224         }
 225
 226 //end class VarDefHandler
 227 }
 228
 229
 230 ?>