include/SugarFields/Fields/Base/SugarFieldBase.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  * SugarFieldBase translates and displays fields from a vardef definition into different formats
  39  * including DetailView, ListView, EditView. It also provides Search Inputs and database queries
  40  * to handle searching
  41  *
  42  */
  43 class SugarFieldBase {
  44     var $ss; // Sugar Smarty Object
  45     var $hasButton = false;
  46     function SugarFieldBase($type) {
  47         $this->type = $type;
  48         $this->ss = new Sugar_Smarty();
  49     }
  50     function fetch($path){
  51         $additional = '';
  52         if(!$this->hasButton && !empty($this->button)){
  53                 $additional .= '<input type="button" class="button" ' . $this->button . '>';
  54         }
  55         if(!empty($this->buttons)){
  56             foreach($this->buttons as $v){
  57                 $additional .= ' <input type="button" class="button" ' . $v . '>';
  58             }
  59
  60         }
  61         if(!empty($this->image)){
  62             $additional .= ' <img ' . $this->image . '>';
  63         }
  64         return $this->ss->fetch($path) . $additional;
  65     }
  66
  67     function findTemplate($view){
  68         static $tplCache = array();
  69
  70         if ( isset($tplCache[$this->type][$view]) ) {
  71             return $tplCache[$this->type][$view];
  72         }
  73
  74         $lastClass = get_class($this);
  75         $classList = array($this->type,str_replace('SugarField','',$lastClass));
  76         while ( $lastClass = get_parent_class($lastClass) ) {
  77             $classList[] = str_replace('SugarField','',$lastClass);
  78         }
  79
  80         $tplName = '';
  81         foreach ( $classList as $className ) {
  82             global $current_language;
  83             if(isset($current_language)) {
  84                 $tplName = 'include/SugarFields/Fields/'. $className .'/'. $current_language . '.' . $view .'.tpl';
  85                 if ( file_exists('custom/'.$tplName) ) {
  86                     $tplName = 'custom/'.$tplName;
  87                     break;
  88                 }
  89                 if ( file_exists($tplName) ) {
  90                     break;
  91                 }
  92             }
  93             $tplName = 'include/SugarFields/Fields/'. $className .'/'. $view .'.tpl';
  94             if ( file_exists('custom/'.$tplName) ) {
  95                 $tplName = 'custom/'.$tplName;
  96                 break;
  97             }
  98             if ( file_exists($tplName) ) {
  99                 break;
 100             }
 101         }
 102
 103         $tplCache[$this->type][$view] = $tplName;
 104
 105         return $tplName;
 106     }
 107
 108     public function formatField($rawField, $vardef){
 109         // The base field doesn't do any formatting, so override it in subclasses for more specific actions
 110         return $rawField;
 111     }
 112
 113
 114     public function unformatField($formattedField, $vardef){
 115         // The base field doesn't do any formatting, so override it in subclasses for more specific actions
 116         return $formattedField;
 117     }
 118
 119     function getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex = -1, $view){
 120         $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
 121
 122
 123         return $this->fetch($this->findTemplate($view));
 124     }
 125
 126     function getListViewSmarty($parentFieldArray, $vardef, $displayParams, $col) {
 127         $tabindex = 1;
 128                 $parentFieldArray = $this->setupFieldArray($parentFieldArray, $vardef);
 129         $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex, false);
 130
 131         $this->ss->left_delimiter = '{';
 132         $this->ss->right_delimiter = '}';
 133         $this->ss->assign('col',$vardef['name']);
 134
 135         return $this->fetch($this->findTemplate('ListView'));
 136     }
 137
 138     /**
 139      * Returns a smarty template for the DetailViews
 140      *
 141      * @param parentFieldArray string name of the variable in the parent template for the bean's data
 142      * @param vardef vardef field defintion
 143      * @param displayParam parameters for display
 144      *      available paramters are:
 145      *      * labelSpan - column span for the label
 146      *      * fieldSpan - column span for the field
 147      */
 148     function getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
 149         return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'DetailView');
 150     }
 151
 152         // 99% of all fields will just format like a listview, but just in case, it's here to override
 153     function getChangeLogSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
 154         return $this->formatField($parentFieldArray[$vardef['name']],$vardef);
 155     }
 156
 157
 158     function getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
 159         if(!empty($vardef['function']['returns']) && $vardef['function']['returns'] == 'html'){
 160                 $type = $this->type;
 161                 $this->type = 'Base';
 162                 $result= $this->getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
 163                 $this->type = $type;
 164                 return $result;
 165         }
 166        return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'EditView');
 167     }
 168
 169     function getImportViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex)
 170     {
 171         return $this->getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
 172     }
 173
 174
 175
 176     function getSearchViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
 177                 if(!empty($vardef['auto_increment']))$vardef['len']=255;
 178         return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'EditView');
 179     }
 180
 181     function getPopupViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex){
 182          if (is_array($displayParams) && !isset($displayParams['formName']))
 183                      $displayParams['formName'] = 'popup_query_form';
 184              else if (empty($displayParams))
 185                      $displayParams = array('formName' => 'popup_query_form');
 186                  return $this->getSearchViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
 187     }
 188
 189     public function getEmailTemplateValue($inputField, $vardef, $context = null){
 190         // This does not return a smarty section, instead it returns a direct value
 191         return $this->formatField($inputField,$vardef);
 192     }
 193
 194     function displayFromFunc( $displayType, $parentFieldArray, $vardef, $displayParams, $tabindex = 0 ) {
 195
 196         if ( ! is_array($vardef['function']) ) {
 197             $funcName = $vardef['function'];
 198             $includeFile = '';
 199             $onListView = false;
 200             $returnsHtml = false;
 201         } else {
 202             $funcName = $vardef['function']['name'];
 203             $includeFile = '';
 204             if ( isset($vardef['function']['include']) ) {
 205                 $includeFile = $vardef['function']['include'];
 206             }
 207             if ( isset($vardef['function']['onListView']) && $vardef['function']['onListView'] == true ) {
 208                 $onListView = true;
 209             } else {
 210                 $onListView = false;
 211             }
 212             if ( isset($vardef['function']['returns']) && $vardef['function']['returns'] == 'html' ) {
 213                 $returnsHtml = true;
 214             } else {
 215                 $returnsHtml = false;
 216             }
 217         }
 218
 219         if ( $displayType == 'ListView'
 220                 || $displayType == 'popupView'
 221                 || $displayType == 'searchView'
 222                 || $displayType == 'wirelessEditView'
 223                 || $displayType == 'wirelessDetailView'
 224                 || $displayType == 'wirelessListView'
 225                 ) {
 226             // Traditionally, before 6.0, additional functions were never called, so this code doesn't get called unless the vardef forces it
 227             if ( $onListView ) {
 228                 if ( !empty($includeFile) ) {
 229                     require_once($includeFile);
 230                 }
 231
 232                 return $funcName($parentFieldArray, $vardef['name'], $parentFieldArray[$vardef['name']], $displayType);
 233             } else {
 234                 $displayTypeFunc = 'get'.$displayType.'Smarty';
 235                 return $this->$displayTypeFunc($parentFieldArray, $vardef, $displayParams, $tabindex);
 236             }
 237         } else {
 238             if ( !empty($displayParams['idName']) ) {
 239                 $fieldName = $displayParams['idName'];
 240             } else {
 241                 $fieldName = $vardef['name'];
 242             }
 243             if ( $returnsHtml ) {
 244                 $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
 245                 $tpl = $this->findTemplate($displayType.'Function');
 246                 if ( $tpl == '' ) {
 247                     // Can't find a function template, just use the base
 248                     $tpl = $this->findTemplate('DetailViewFunction');
 249                 }
 250                 return "<span id='{$vardef['name']}'>" . $this->fetch($tpl) . '</span>';
 251             } else {
 252                 return '{sugar_run_helper include="'.$includeFile.'" func="'.$funcName.'" bean=$bean field="'.$fieldName.'" value=$fields.'.$fieldName.'.value displayType="'.$displayType.'"}';
 253             }
 254         }
 255     }
 256
 257     function getEditView() {
 258     }
 259
 260     /**
 261      * getSearchInput
 262      *
 263      * This function allows the SugarFields to handle returning the search input value given arguments (typically from $_REQUEST/$_POST)
 264      * and a search string.
 265      *
 266      * @param $key String value of key to search for
 267      * @param $args Mixed value containing haystack to search for value in
 268      * @return $value Mixed value that the SugarField should return
 269      */
 270     function getSearchInput($key='', $args=array())
 271     {
 272         //Nothing specified return empty string
 273         if(empty($key) || empty($args))
 274         {
 275                 return '';
 276         }
 277
 278         return isset($args[$key]) ? $args[$key] : '';
 279     }
 280
 281     function getQueryLike() {
 282
 283     }
 284
 285     function getQueryIn() {
 286     }
 287
 288     /**
 289      * Setup function to assign values to the smarty template, should be called before every display function
 290      */
 291     function setup($parentFieldArray, $vardef, $displayParams, $tabindex, $twopass=true) {
 292         $this->button = '';
 293         $this->buttons = '';
 294         $this->image = '';
 295         if ($twopass){
 296                 $this->ss->left_delimiter = '{{';
 297                 $this->ss->right_delimiter = '}}';
 298         }
 299         $this->ss->assign('parentFieldArray', $parentFieldArray);
 300         $this->ss->assign('vardef', $vardef);
 301         $this->ss->assign('tabindex', $tabindex);
 302
 303         //for adding attributes to the field
 304
 305         if(!empty($displayParams['field'])){
 306                 $plusField = '';
 307                 foreach($displayParams['field'] as $key=>$value){
 308                         $plusField .= ' ' . $key . '="' . $value . '"';//bug 27381
 309                 }
 310                 $displayParams['field'] = $plusField;
 311         }
 312         //for adding attributes to the button
 313         if(!empty($displayParams['button'])){
 314                 $plusField = '';
 315                 foreach($displayParams['button'] as $key=>$value){
 316                         $plusField .= ' ' . $key . '="' . $value . '"';
 317                 }
 318                 $displayParams['button'] = $plusField;
 319                 $this->button = $displayParams['button'];
 320         }
 321         if(!empty($displayParams['buttons'])){
 322             $plusField = '';
 323             foreach($displayParams['buttons'] as $keys=>$values){
 324                 foreach($values as $key=>$value){
 325                     $plusField[$keys] .= ' ' . $key . '="' . $value . '"';
 326                 }
 327             }
 328             $displayParams['buttons'] = $plusField;
 329             $this->buttons = $displayParams['buttons'];
 330         }
 331         if(!empty($displayParams['image'])){
 332             $plusField = '';
 333             foreach($displayParams['image'] as $key=>$value){
 334                 $plusField .= ' ' . $key . '="' . $value . '"';
 335             }
 336             $displayParams['image'] = $plusField;
 337             $this->image = $displayParams['image'];
 338         }
 339         $this->ss->assign('displayParams', $displayParams);
 340
 341
 342     }
 343
 344     protected function getAccessKey($vardef, $fieldType = null, $module = null) {
 345         global $app_strings;
 346
 347         $labelList = array(
 348             'accessKey' => array(),
 349             'accessKeySelect' => array(),
 350             'accessKeyClear' => array(),
 351         );
 352
 353         // Labels are always in uppercase
 354         if ( isset($fieldType) ) {
 355             $fieldType = strtoupper($fieldType);
 356         }
 357
 358         if ( isset($module) ) {
 359             $module = strtoupper($module);
 360         }
 361
 362         // The vardef is the most specific, then the module + fieldType, then the module, then the fieldType
 363         if ( isset($vardef['accessKey']) ) {
 364             $labelList['accessKey'][] = $vardef['accessKey'];
 365         }
 366         if ( isset($vardef['accessKeySelect']) ) {
 367             $labelList['accessKeySelect'][] = $vardef['accessKeySelect'];
 368         }
 369         if ( isset($vardef['accessKeyClear']) ) {
 370             $labelList['accessKeyClear'][] = $vardef['accessKeyClear'];
 371         }
 372
 373         if ( isset($fieldType) && isset($module) ) {
 374             $labelList['accessKey'][] = 'LBL_ACCESSKEY_'.$fieldType.'_'.$module;
 375             $labelList['accessKeySelect'][] = 'LBL_ACCESSKEY_SELECT_'.$fieldType.'_'.$module;
 376             $labelList['accessKeyClear'][] = 'LBL_ACCESSKEY_CLEAR_'.$fieldType.'_'.$module;
 377         }
 378
 379         if ( isset($module) ) {
 380             $labelList['accessKey'][] = 'LBL_ACCESSKEY_'.$module;
 381             $labelList['accessKeySelect'][] = 'LBL_ACCESSKEY_SELECT_'.$module;
 382             $labelList['accessKeyClear'][] = 'LBL_ACCESSKEY_CLEAR_'.$module;
 383         }
 384
 385         if ( isset($fieldType) ) {
 386             $labelList['accessKey'][] = 'LBL_ACCESSKEY_'.$fieldType;
 387             $labelList['accessKeySelect'][] = 'LBL_ACCESSKEY_SELECT_'.$fieldType;
 388             $labelList['accessKeyClear'][] = 'LBL_ACCESSKEY_CLEAR_'.$fieldType;
 389         }
 390
 391         // Attach the defaults to the ends
 392         $labelList['accessKey'][] = 'LBL_ACCESSKEY';
 393         $labelList['accessKeySelect'][] = 'LBL_SELECT_BUTTON';
 394         $labelList['accessKeyClear'][] = 'LBL_CLEAR_BUTTON';
 395
 396         // Figure out the label and the key for the button.
 397         // Later on we may attempt to make sure there are no two buttons with the same keys, but for now we will just use whatever is specified.
 398         $keyTypes = array('accessKey','accessKeySelect','accessKeyClear');
 399         $accessKeyList = array(
 400             'accessKey' => '',
 401             'accessKeyLabel' => '',
 402             'accessKeyTitle' => '',
 403             'accessKeySelect' => '',
 404             'accessKeySelectLabel' => '',
 405             'accessKeySelectTitle' => '',
 406             'accessKeyClear' => '',
 407             'accessKeyClearLabel' => '',
 408             'accessKeyClearTitle' => '',
 409         );
 410         foreach( $keyTypes as $type ) {
 411             foreach ( $labelList[$type] as $tryThis ) {
 412                 if ( isset($app_strings[$tryThis.'_KEY']) && isset($app_strings[$tryThis.'_TITLE']) && isset($app_strings[$tryThis.'_LABEL']) ) {
 413                     $accessKeyList[$type] = $tryThis.'_KEY';
 414                     $accessKeyList[$type.'Title'] = $tryThis.'_TITLE';
 415                     $accessKeyList[$type.'Label'] = $tryThis.'_LABEL';
 416                     break;
 417                 }
 418             }
 419         }
 420
 421         return $accessKeyList;
 422     }
 423
 424         /**
 425      * This should be called when the bean is saved. The bean itself will be passed by reference
 426      * @param SugarBean bean - the bean performing the save
 427      * @param array params - an array of paramester relevant to the save, most likely will be $_REQUEST
 428      */
 429     public function save($bean, $params, $field, $properties, $prefix = '') {
 430          if ( isset($params[$prefix.$field]) ) {
 431              if(isset($properties['len']) && isset($properties['type']) && $this->isTrimmable($properties['type'])){
 432                  $bean->$field = trim($this->unformatField($params[$prefix.$field], $properties));
 433              }
 434              else {
 435                  $bean->$field = $this->unformatField($params[$prefix.$field], $properties);
 436                  }
 437          }
 438      }
 439
 440      /**
 441       * Check if the field is allowed to be trimmed
 442       *
 443       * @param string $type
 444       * @return boolean
 445       */
 446      protected function isTrimmable($type) {
 447          return in_array($type, array('varchar', 'name'));
 448      }
 449
 450     /**
 451      * Handles import field sanitizing for an field type
 452      *
 453      * @param  $value    string value to be sanitized
 454      * @param  $vardefs  array
 455      * @param  $focus    SugarBean object
 456      * @param  $settings ImportFieldSanitize object
 457      * @return string sanitized value or boolean false if there's a problem with the value
 458      */
 459     public function importSanitize(
 460         $value,
 461         $vardef,
 462         $focus,
 463         ImportFieldSanitize $settings
 464         )
 465     {
 466         if( isset($vardef['len']) ) {
 467             // check for field length
 468             $value = sugar_substr($value, $vardef['len']);
 469         }
 470
 471         return $value;
 472     }
 473
 474     /**
 475      * isRangeSearchView
 476      * This method helps determine whether or not to display the range search view code for the sugar field
 477      * @param array $vardef entry representing the sugar field's definition
 478      * @return boolean true if range search view should be displayed, false otherwise
 479      */
 480     protected function isRangeSearchView($vardef)
 481     {
 482         return !empty($vardef['enable_range_search']) && !empty($_REQUEST['action']) && $_REQUEST['action']!='Popup';
 483     }
 484
 485     /**
 486      * setupFieldArray
 487      * This method takes the $parentFieldArray mixed variable which may be an Array or object and attempts
 488      * to call any custom fieldSpecific formatting to the value depending on the field type.
 489      *
 490      * @see SugarFieldEnum.php, SugarFieldInt.php, SugarFieldFloat.php, SugarFieldRelate.php
 491      * @param   mixed   $parentFieldArray Array or Object of data where the field's value comes from
 492      * @param   array   $vardef The vardef entry linked to the SugarField instance
 493      * @return  array   $parentFieldArray The formatted $parentFieldArray with the formatField method possibly applied
 494      */
 495     protected function setupFieldArray($parentFieldArray, $vardef)
 496     {
 497         $fieldName = $vardef['name'];
 498         if ( is_array($parentFieldArray) )
 499         {
 500             $fieldNameUpper = strtoupper($fieldName);
 501             if ( isset($parentFieldArray[$fieldNameUpper]))
 502             {
 503                 $parentFieldArray[$fieldName] = $this->formatField($parentFieldArray[$fieldNameUpper],$vardef);
 504             } else {
 505                 $parentFieldArray[$fieldName] = '';
 506             }
 507         } elseif (is_object($parentFieldArray)) {
 508             if ( isset($parentFieldArray->$fieldName) )
 509             {
 510                 $parentFieldArray->$fieldName = $this->formatField($parentFieldArray->$fieldName,$vardef);
 511             } else {
 512                 $parentFieldArray->$fieldName = '';
 513             }
 514         }
 515         return $parentFieldArray;
 516     }
 517
 518 }
 519 ?>