2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2012 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 ********************************************************************************/
41 class SugarFieldHandler
44 function SugarFieldHandler() {
47 static function fixupFieldType($field) {
71 return ucfirst($field);
75 * return the singleton of the SugarField
77 * @param field string field type
79 static function getSugarField($field, $returnNullIfBase=false) {
80 static $sugarFieldObjects = array();
82 $field = self::fixupFieldType($field);
83 $field = ucfirst($field);
85 if(!isset($sugarFieldObjects[$field])) {
86 //check custom directory
87 if(file_exists('custom/include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php')){
88 $file = 'custom/include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php';
90 //else check the fields directory
91 }else if(file_exists('include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php')){
92 $file = 'include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php';
95 // No direct class, check the directories to see if they are defined
96 if( $returnNullIfBase &&
97 !is_dir('custom/include/SugarFields/Fields/'.$field) &&
98 !is_dir('include/SugarFields/Fields/'.$field) ) {
101 $file = 'include/SugarFields/Fields/Base/SugarFieldBase.php';
106 $class = 'SugarField' . $type;
107 //could be a custom class check it
108 $customClass = 'Custom' . $class;
109 if(class_exists($customClass)){
110 $sugarFieldObjects[$field] = new $customClass($field);
112 $sugarFieldObjects[$field] = new $class($field);
115 return $sugarFieldObjects[$field];
119 * Returns the smarty code to be used in a template built by TemplateHandler
120 * The SugarField class is choosen dependant on the vardef's type field.
122 * @param parentFieldArray string name of the variable in the parent template for the bean's data
123 * @param vardef vardef field defintion
124 * @param displayType string the display type for the field (eg DetailView, EditView, etc)
125 * @param displayParam parameters for displayin
126 * available paramters are:
127 * * labelSpan - column span for the label
128 * * fieldSpan - column span for the field
130 static function displaySmarty($parentFieldArray, $vardef, $displayType, $displayParams = array(), $tabindex = 1) {
132 $displayTypeFunc = 'get' . $displayType . 'Smarty'; // getDetailViewSmarty, getEditViewSmarty, etc...
134 // This will handle custom type fields.
135 // The incoming $vardef Array may have custom_type set.
136 // If so, set $vardef['type'] to the $vardef['custom_type'] value
137 if(isset($vardef['custom_type'])) {
138 $vardef['type'] = $vardef['custom_type'];
140 if(empty($vardef['type'])) {
141 $vardef['type'] = 'varchar';
144 $field = self::getSugarField($vardef['type']);
145 if ( !empty($vardef['function']) ) {
146 $string = $field->displayFromFunc($displayType, $parentFieldArray, $vardef, $displayParams, $tabindex);
148 $string = $field->$displayTypeFunc($parentFieldArray, $vardef, $displayParams, $tabindex);