2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
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
43 class SugarFieldBase {
44 var $ss; // Sugar Smarty Object
45 var $hasButton = false;
46 function SugarFieldBase($type) {
48 $this->ss = new Sugar_Smarty();
50 function fetch($path){
52 if(!$this->hasButton && !empty($this->button)){
53 $additional .= '<input type="button" class="button" ' . $this->button . '>';
55 if(!empty($this->buttons)){
56 foreach($this->buttons as $v){
57 $additional .= ' <input type="button" class="button" ' . $v . '>';
61 if(!empty($this->image)){
62 $additional .= ' <img ' . $this->image . '>';
64 return $this->ss->fetch($path) . $additional;
67 function findTemplate($view){
68 static $tplCache = array();
70 if ( isset($tplCache[$this->type][$view]) ) {
71 return $tplCache[$this->type][$view];
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);
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;
89 if ( file_exists($tplName) ) {
93 $tplName = 'include/SugarFields/Fields/'. $className .'/'. $view .'.tpl';
94 if ( file_exists('custom/'.$tplName) ) {
95 $tplName = 'custom/'.$tplName;
98 if ( file_exists($tplName) ) {
103 $tplCache[$this->type][$view] = $tplName;
108 public function formatField($rawField, $vardef){
109 // The base field doesn't do any formatting, so override it in subclasses for more specific actions
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;
119 function getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex = -1, $view){
120 $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
123 return $this->fetch($this->findTemplate($view));
126 function getListViewSmarty($parentFieldArray, $vardef, $displayParams, $col) {
128 $parentFieldArray = $this->setupFieldArray($parentFieldArray, $vardef);
129 $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex, false);
131 $this->ss->left_delimiter = '{';
132 $this->ss->right_delimiter = '}';
133 $this->ss->assign('col',$vardef['name']);
135 return $this->fetch($this->findTemplate('ListView'));
139 * Returns a smarty template for the DetailViews
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
148 function getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
149 return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'DetailView');
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);
158 function getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
159 if(!empty($vardef['function']['returns']) && $vardef['function']['returns'] == 'html'){
161 $this->type = 'Base';
162 $result= $this->getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
166 return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'EditView');
169 function getImportViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex)
171 return $this->getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
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');
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);
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);
194 function displayFromFunc( $displayType, $parentFieldArray, $vardef, $displayParams, $tabindex = 0 ) {
196 if ( ! is_array($vardef['function']) ) {
197 $funcName = $vardef['function'];
200 $returnsHtml = false;
202 $funcName = $vardef['function']['name'];
204 if ( isset($vardef['function']['include']) ) {
205 $includeFile = $vardef['function']['include'];
207 if ( isset($vardef['function']['onListView']) && $vardef['function']['onListView'] == true ) {
212 if ( isset($vardef['function']['returns']) && $vardef['function']['returns'] == 'html' ) {
215 $returnsHtml = false;
219 if ( $displayType == 'ListView'
220 || $displayType == 'popupView'
221 || $displayType == 'searchView'
222 || $displayType == 'wirelessEditView'
223 || $displayType == 'wirelessDetailView'
224 || $displayType == 'wirelessListView'
226 // Traditionally, before 6.0, additional functions were never called, so this code doesn't get called unless the vardef forces it
228 if ( !empty($includeFile) ) {
229 require_once($includeFile);
232 return $funcName($parentFieldArray, $vardef['name'], $parentFieldArray[$vardef['name']], $displayType);
234 $displayTypeFunc = 'get'.$displayType.'Smarty';
235 return $this->$displayTypeFunc($parentFieldArray, $vardef, $displayParams, $tabindex);
238 if ( !empty($displayParams['idName']) ) {
239 $fieldName = $displayParams['idName'];
241 $fieldName = $vardef['name'];
243 if ( $returnsHtml ) {
244 $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
245 $tpl = $this->findTemplate($displayType.'Function');
247 // Can't find a function template, just use the base
248 $tpl = $this->findTemplate('DetailViewFunction');
250 return "<span id='{$vardef['name']}'>" . $this->fetch($tpl) . '</span>';
252 return '{sugar_run_helper include="'.$includeFile.'" func="'.$funcName.'" bean=$bean field="'.$fieldName.'" value=$fields.'.$fieldName.'.value displayType="'.$displayType.'"}';
257 function getEditView() {
263 * This function allows the SugarFields to handle returning the search input value given arguments (typically from $_REQUEST/$_POST)
264 * and a search string.
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
270 function getSearchInput($key='', $args=array())
272 //Nothing specified return empty string
273 if(empty($key) || empty($args))
278 return isset($args[$key]) ? $args[$key] : '';
281 function getQueryLike() {
285 function getQueryIn() {
289 * Setup function to assign values to the smarty template, should be called before every display function
291 function setup($parentFieldArray, $vardef, $displayParams, $tabindex, $twopass=true) {
296 $this->ss->left_delimiter = '{{';
297 $this->ss->right_delimiter = '}}';
299 $this->ss->assign('parentFieldArray', $parentFieldArray);
300 $this->ss->assign('vardef', $vardef);
301 $this->ss->assign('tabindex', $tabindex);
303 //for adding attributes to the field
305 if(!empty($displayParams['field'])){
307 foreach($displayParams['field'] as $key=>$value){
308 $plusField .= ' ' . $key . '="' . $value . '"';//bug 27381
310 $displayParams['field'] = $plusField;
312 //for adding attributes to the button
313 if(!empty($displayParams['button'])){
315 foreach($displayParams['button'] as $key=>$value){
316 $plusField .= ' ' . $key . '="' . $value . '"';
318 $displayParams['button'] = $plusField;
319 $this->button = $displayParams['button'];
321 if(!empty($displayParams['buttons'])){
323 foreach($displayParams['buttons'] as $keys=>$values){
324 foreach($values as $key=>$value){
325 $plusField[$keys] .= ' ' . $key . '="' . $value . '"';
328 $displayParams['buttons'] = $plusField;
329 $this->buttons = $displayParams['buttons'];
331 if(!empty($displayParams['image'])){
333 foreach($displayParams['image'] as $key=>$value){
334 $plusField .= ' ' . $key . '="' . $value . '"';
336 $displayParams['image'] = $plusField;
337 $this->image = $displayParams['image'];
339 $this->ss->assign('displayParams', $displayParams);
345 * This should be called when the bean is saved. The bean itself will be passed by reference
346 * @param SugarBean bean - the bean performing the save
347 * @param array params - an array of paramester relevant to the save, most likely will be $_REQUEST
349 public function save($bean, $params, $field, $properties, $prefix = '') {
350 if ( isset($params[$prefix.$field]) ) {
351 if(isset($properties['len']) && isset($properties['type']) && $this->isTrimmable($properties['type'])){
352 $bean->$field = trim($this->unformatField($params[$prefix.$field], $properties));
355 $bean->$field = $this->unformatField($params[$prefix.$field], $properties);
361 * Check if the field is allowed to be trimmed
363 * @param string $type
366 protected function isTrimmable($type) {
367 return in_array($type, array('varchar', 'name'));
371 * Handles import field sanitizing for an field type
373 * @param $value string value to be sanitized
374 * @param $vardefs array
375 * @param $focus SugarBean object
376 * @param $settings ImportFieldSanitize object
377 * @return string sanitized value or boolean false if there's a problem with the value
379 public function importSanitize(
383 ImportFieldSanitize $settings
386 if( isset($vardef['len']) ) {
387 // check for field length
388 $value = sugar_substr($value, $vardef['len']);
396 * This method helps determine whether or not to display the range search view code for the sugar field
397 * @param array $vardef entry representing the sugar field's definition
398 * @return boolean true if range search view should be displayed, false otherwise
400 protected function isRangeSearchView($vardef)
402 return !empty($vardef['enable_range_search']) && !empty($_REQUEST['action']) && $_REQUEST['action']!='Popup';
407 * This method takes the $parentFieldArray mixed variable which may be an Array or object and attempts
408 * to call any custom fieldSpecific formatting to the value depending on the field type.
410 * @see SugarFieldEnum.php, SugarFieldInt.php, SugarFieldFloat.php, SugarFieldRelate.php
411 * @param mixed $parentFieldArray Array or Object of data where the field's value comes from
412 * @param array $vardef The vardef entry linked to the SugarField instance
413 * @return array $parentFieldArray The formatted $parentFieldArray with the formatField method possibly applied
415 protected function setupFieldArray($parentFieldArray, $vardef)
417 $fieldName = $vardef['name'];
418 if ( is_array($parentFieldArray) )
420 $fieldNameUpper = strtoupper($fieldName);
421 if ( isset($parentFieldArray[$fieldNameUpper]))
423 $parentFieldArray[$fieldName] = $this->formatField($parentFieldArray[$fieldNameUpper],$vardef);
425 $parentFieldArray[$fieldName] = '';
427 } elseif (is_object($parentFieldArray)) {
428 if ( isset($parentFieldArray->$fieldName) )
430 $parentFieldArray->$fieldName = $this->formatField($parentFieldArray->$fieldName,$vardef);
432 $parentFieldArray->$fieldName = '';
435 return $parentFieldArray;