]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - include/SugarFields/Fields/Base/SugarFieldBase.php
Release 6.5.6
[Github/sugarcrm.git] / 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-2012 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         //fixing bug #46666: don't need to format enum and radioenum fields 
129         //because they are already formated in SugarBean.php in the function get_list_view_array() as fix of bug #21672
130         if ($this->type != 'Enum' && $this->type != 'Radioenum')
131         {
132             $parentFieldArray = $this->setupFieldArray($parentFieldArray, $vardef);
133         }
134                 else
135         {
136                 $vardef['name'] = strtoupper($vardef['name']);
137         }
138         
139         $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex, false);
140
141         $this->ss->left_delimiter = '{';
142         $this->ss->right_delimiter = '}';
143         $this->ss->assign('col',$vardef['name']);
144
145         return $this->fetch($this->findTemplate('ListView'));
146     }
147
148     /**
149      * Returns a smarty template for the DetailViews
150      *
151      * @param parentFieldArray string name of the variable in the parent template for the bean's data
152      * @param vardef vardef field defintion
153      * @param displayParam parameters for display
154      *      available paramters are:
155      *      * labelSpan - column span for the label
156      *      * fieldSpan - column span for the field
157      */
158     function getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
159         return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'DetailView');
160     }
161
162         // 99% of all fields will just format like a listview, but just in case, it's here to override
163     function getChangeLogSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
164         return $this->formatField($parentFieldArray[$vardef['name']],$vardef);
165     }
166
167
168     function getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
169         if(!empty($vardef['function']['returns']) && $vardef['function']['returns'] == 'html'){
170                 $type = $this->type;
171                 $this->type = 'Base';
172                 $result= $this->getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
173                 $this->type = $type;
174                 return $result;
175         }
176         // jpereira@dri - #Bug49513 - Readonly type not working as expected
177         // If readonly is set in displayParams, the vardef will be displayed as in DetailView.
178         if (isset($displayParams['readonly']) && $displayParams['readonly']) {
179                 return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'DetailView');
180         }       
181         // ~ jpereira@dri - #Bug49513 - Readonly type not working as expected
182        return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'EditView');
183     }
184
185     function getImportViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex)
186     {
187         return $this->getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
188     }
189
190
191
192     function getSearchViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
193                 if(!empty($vardef['auto_increment']))$vardef['len']=255;
194         return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'EditView');
195     }
196
197     function getPopupViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex){
198          if (is_array($displayParams) && !isset($displayParams['formName']))
199                      $displayParams['formName'] = 'popup_query_form';
200              else if (empty($displayParams))
201                      $displayParams = array('formName' => 'popup_query_form');
202                  return $this->getSearchViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
203     }
204
205     public function getEmailTemplateValue($inputField, $vardef, $context = null){
206         // This does not return a smarty section, instead it returns a direct value
207         return $this->formatField($inputField,$vardef);
208     }
209
210     function displayFromFunc( $displayType, $parentFieldArray, $vardef, $displayParams, $tabindex = 0 ) {
211
212         if ( ! is_array($vardef['function']) ) {
213             $funcName = $vardef['function'];
214             $includeFile = '';
215             $onListView = false;
216             $returnsHtml = false;
217         } else {
218             $funcName = $vardef['function']['name'];
219             $includeFile = '';
220             if ( isset($vardef['function']['include']) ) {
221                 $includeFile = $vardef['function']['include'];
222             }
223             if ( isset($vardef['function']['onListView']) && $vardef['function']['onListView'] == true ) {
224                 $onListView = true;
225             } else {
226                 $onListView = false;
227             }
228             if ( isset($vardef['function']['returns']) && $vardef['function']['returns'] == 'html' ) {
229                 $returnsHtml = true;
230             } else {
231                 $returnsHtml = false;
232             }
233         }
234
235         if ( $displayType == 'ListView'
236                 || $displayType == 'popupView'
237                 || $displayType == 'searchView'
238                 ) {
239             // Traditionally, before 6.0, additional functions were never called, so this code doesn't get called unless the vardef forces it
240             if ( $onListView ) {
241                 if ( !empty($includeFile) ) {
242                     require_once($includeFile);
243                 }
244
245                 return $funcName($parentFieldArray, $vardef['name'], $parentFieldArray[strtoupper($vardef['name'])], $displayType);
246             } else {
247                 $displayTypeFunc = 'get'.$displayType.'Smarty';
248                 return $this->$displayTypeFunc($parentFieldArray, $vardef, $displayParams, $tabindex);
249             }
250         } else {
251             if ( !empty($displayParams['idName']) ) {
252                 $fieldName = $displayParams['idName'];
253             } else {
254                 $fieldName = $vardef['name'];
255             }
256             if ( $returnsHtml ) {
257                 $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
258                 $tpl = $this->findTemplate($displayType.'Function');
259                 if ( $tpl == '' ) {
260                     // Can't find a function template, just use the base
261                     $tpl = $this->findTemplate('DetailViewFunction');
262                 }
263                 return "<span id='{$vardef['name']}_span'>" . $this->fetch($tpl) . '</span>';
264             } else {
265                 return '{sugar_run_helper include="'.$includeFile.'" func="'.$funcName.'" bean=$bean field="'.$fieldName.'" value=$fields.'.$fieldName.'.value displayType="'.$displayType.'"}';
266             }
267         }
268     }
269
270     function getEditView() {
271     }
272
273     /**
274      * getSearchWhereValue
275      *
276      * Checks and returns a sane value based on the field type that can be used when building the where clause in a
277      * search form.
278      *
279      * @param $value Mixed value being searched on
280      * @return Mixed the value for the where clause used in search
281      */
282     function getSearchWhereValue($value) {
283         return $value;
284     }
285
286     /**
287      * getSearchInput
288      *
289      * This function allows the SugarFields to handle returning the search input value given arguments (typically from $_REQUEST/$_POST)
290      * and a search string.
291      *
292      * @param $key String value of key to search for
293      * @param $args Mixed value containing haystack to search for value in
294      * @return $value Mixed value that the SugarField should return
295      */
296     function getSearchInput($key='', $args=array())
297     {
298         //Nothing specified return empty string
299         if(empty($key) || empty($args))
300         {
301                 return '';
302         }
303
304         return isset($args[$key]) ? $args[$key] : '';
305     }
306
307     function getQueryLike() {
308
309     }
310
311     function getQueryIn() {
312     }
313
314     /**
315      * Setup function to assign values to the smarty template, should be called before every display function
316      */
317     function setup($parentFieldArray, $vardef, $displayParams, $tabindex, $twopass=true) {
318         $this->button = '';
319         $this->buttons = '';
320         $this->image = '';
321         if ($twopass)
322         {
323             $this->ss->left_delimiter = '{{';
324             $this->ss->right_delimiter = '}}';
325         }
326         else
327         {
328             $this->ss->left_delimiter = '{';
329             $this->ss->right_delimiter = '}';
330         }
331         $this->ss->assign('parentFieldArray', $parentFieldArray);
332         $this->ss->assign('vardef', $vardef);
333         $this->ss->assign('tabindex', $tabindex);
334
335         //for adding attributes to the field
336
337         if(!empty($displayParams['field'])){
338                 $plusField = '';
339                 foreach($displayParams['field'] as $key=>$value){
340                         $plusField .= ' ' . $key . '="' . $value . '"';//bug 27381
341                 }
342                 $displayParams['field'] = $plusField;
343         }
344         //for adding attributes to the button
345         if(!empty($displayParams['button'])){
346                 $plusField = '';
347                 foreach($displayParams['button'] as $key=>$value){
348                         $plusField .= ' ' . $key . '="' . $value . '"';
349                 }
350                 $displayParams['button'] = $plusField;
351                 $this->button = $displayParams['button'];
352         }
353         if(!empty($displayParams['buttons'])){
354             $plusField = '';
355             foreach($displayParams['buttons'] as $keys=>$values){
356                 foreach($values as $key=>$value){
357                     $plusField[$keys] .= ' ' . $key . '="' . $value . '"';
358                 }
359             }
360             $displayParams['buttons'] = $plusField;
361             $this->buttons = $displayParams['buttons'];
362         }
363         if(!empty($displayParams['image'])){
364             $plusField = '';
365             foreach($displayParams['image'] as $key=>$value){
366                 $plusField .= ' ' . $key . '="' . $value . '"';
367             }
368             $displayParams['image'] = $plusField;
369             $this->image = $displayParams['image'];
370         }
371         $this->ss->assign('displayParams', $displayParams);
372
373
374     }
375
376     protected function getAccessKey($vardef, $fieldType = null, $module = null) {
377         global $app_strings;
378
379         $labelList = array(
380             'accessKey' => array(),
381             'accessKeySelect' => array(),
382             'accessKeyClear' => array(),
383         );
384
385         // Labels are always in uppercase
386         if ( isset($fieldType) ) {
387             $fieldType = strtoupper($fieldType);
388         }
389
390         if ( isset($module) ) {
391             $module = strtoupper($module);
392         }
393
394         // The vardef is the most specific, then the module + fieldType, then the module, then the fieldType
395         if ( isset($vardef['accessKey']) ) {
396             $labelList['accessKey'][] = $vardef['accessKey'];
397         }
398         if ( isset($vardef['accessKeySelect']) ) {
399             $labelList['accessKeySelect'][] = $vardef['accessKeySelect'];
400         }
401         if ( isset($vardef['accessKeyClear']) ) {
402             $labelList['accessKeyClear'][] = $vardef['accessKeyClear'];
403         }
404
405         if ( isset($fieldType) && isset($module) ) {
406             $labelList['accessKey'][] = 'LBL_ACCESSKEY_'.$fieldType.'_'.$module;
407             $labelList['accessKeySelect'][] = 'LBL_ACCESSKEY_SELECT_'.$fieldType.'_'.$module;
408             $labelList['accessKeyClear'][] = 'LBL_ACCESSKEY_CLEAR_'.$fieldType.'_'.$module;
409         }
410
411         if ( isset($module) ) {
412             $labelList['accessKey'][] = 'LBL_ACCESSKEY_'.$module;
413             $labelList['accessKeySelect'][] = 'LBL_ACCESSKEY_SELECT_'.$module;
414             $labelList['accessKeyClear'][] = 'LBL_ACCESSKEY_CLEAR_'.$module;
415         }
416
417         if ( isset($fieldType) ) {
418             $labelList['accessKey'][] = 'LBL_ACCESSKEY_'.$fieldType;
419             $labelList['accessKeySelect'][] = 'LBL_ACCESSKEY_SELECT_'.$fieldType;
420             $labelList['accessKeyClear'][] = 'LBL_ACCESSKEY_CLEAR_'.$fieldType;
421         }
422
423         // Attach the defaults to the ends
424         $labelList['accessKey'][] = 'LBL_ACCESSKEY';
425         $labelList['accessKeySelect'][] = 'LBL_SELECT_BUTTON';
426         $labelList['accessKeyClear'][] = 'LBL_CLEAR_BUTTON';
427
428         // Figure out the label and the key for the button.
429         // 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.
430         $keyTypes = array('accessKey','accessKeySelect','accessKeyClear');
431         $accessKeyList = array(
432             'accessKey' => '',
433             'accessKeyLabel' => '',
434             'accessKeyTitle' => '',
435             'accessKeySelect' => '',
436             'accessKeySelectLabel' => '',
437             'accessKeySelectTitle' => '',
438             'accessKeyClear' => '',
439             'accessKeyClearLabel' => '',
440             'accessKeyClearTitle' => '',
441         );
442         foreach( $keyTypes as $type ) {
443             foreach ( $labelList[$type] as $tryThis ) {
444                 if ( isset($app_strings[$tryThis.'_KEY']) && isset($app_strings[$tryThis.'_TITLE']) && isset($app_strings[$tryThis.'_LABEL']) ) {
445                     $accessKeyList[$type] = $tryThis.'_KEY';
446                     $accessKeyList[$type.'Title'] = $tryThis.'_TITLE';
447                     $accessKeyList[$type.'Label'] = $tryThis.'_LABEL';
448                     break;
449                 }
450             }
451         }
452
453         return $accessKeyList;
454     }
455
456         /**
457      * This should be called when the bean is saved. The bean itself will be passed by reference
458      * @param SugarBean bean - the bean performing the save
459      * @param array params - an array of paramester relevant to the save, most likely will be $_REQUEST
460      */
461     public function save($bean, $params, $field, $properties, $prefix = '') {
462          if ( isset($params[$prefix.$field]) ) {
463              if(isset($properties['len']) && isset($properties['type']) && $this->isTrimmable($properties['type'])){
464                  $bean->$field = trim($this->unformatField($params[$prefix.$field], $properties));
465              }
466              else {
467                  $bean->$field = $this->unformatField($params[$prefix.$field], $properties);
468                  }
469          }
470      }
471
472      /**
473       * Check if the field is allowed to be trimmed
474       *
475       * @param string $type
476       * @return boolean
477       */
478      protected function isTrimmable($type) {
479          return in_array($type, array('varchar', 'name'));
480      }
481
482     /**
483      * Handles import field sanitizing for an field type
484      *
485      * @param  $value    string value to be sanitized
486      * @param  $vardefs  array
487      * @param  $focus    SugarBean object
488      * @param  $settings ImportFieldSanitize object
489      * @return string sanitized value or boolean false if there's a problem with the value
490      */
491     public function importSanitize(
492         $value,
493         $vardef,
494         $focus,
495         ImportFieldSanitize $settings
496         )
497     {
498         if( isset($vardef['len']) ) {
499             // check for field length
500             $value = sugar_substr($value, $vardef['len']);
501         }
502
503         return $value;
504     }
505
506     /**
507      * isRangeSearchView
508      * This method helps determine whether or not to display the range search view code for the sugar field
509      * @param array $vardef entry representing the sugar field's definition
510      * @return boolean true if range search view should be displayed, false otherwise
511      */
512     protected function isRangeSearchView($vardef)
513     {
514         return !empty($vardef['enable_range_search']) && !empty($_REQUEST['action']) && $_REQUEST['action']!='Popup';
515     }
516
517     /**
518      * setupFieldArray
519      * This method takes the $parentFieldArray mixed variable which may be an Array or object and attempts
520      * to call any custom fieldSpecific formatting to the value depending on the field type.
521      *
522      * @see SugarFieldEnum.php, SugarFieldInt.php, SugarFieldFloat.php, SugarFieldRelate.php
523      * @param   mixed   $parentFieldArray Array or Object of data where the field's value comes from
524      * @param   array   $vardef The vardef entry linked to the SugarField instance
525      * @return  array   $parentFieldArray The formatted $parentFieldArray with the formatField method possibly applied
526      */
527     protected function setupFieldArray($parentFieldArray, $vardef)
528     {
529         $fieldName = $vardef['name'];
530         if ( is_array($parentFieldArray) )
531         {
532             $fieldNameUpper = strtoupper($fieldName);
533             if ( isset($parentFieldArray[$fieldNameUpper]))
534             {
535                 $parentFieldArray[$fieldName] = $this->formatField($parentFieldArray[$fieldNameUpper],$vardef);
536             } else {
537                 $parentFieldArray[$fieldName] = '';
538             }
539         } elseif (is_object($parentFieldArray)) {
540             if ( isset($parentFieldArray->$fieldName) )
541             {
542                 $parentFieldArray->$fieldName = $this->formatField($parentFieldArray->$fieldName,$vardef);
543             } else {
544                 $parentFieldArray->$fieldName = '';
545             }
546         }
547         return $parentFieldArray;
548     }
549
550 }
551 ?>