0
0
Fork 0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2025-02-24 05:56:11 +00:00
salesagility_SuiteCRM/include/SugarFields/SugarFieldHandler.php

165 lines
6.3 KiB
PHP
Raw Permalink Normal View History

2013-09-23 19:30:44 +00:00
<?php
/**
*
2013-09-23 19:30:44 +00:00
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
*
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
* Copyright (C) 2011 - 2018 SalesAgility Ltd.
2014-07-07 15:33:23 +00:00
*
2013-09-23 19:30:44 +00:00
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
2014-07-07 15:33:23 +00:00
*
2013-09-23 19:30:44 +00:00
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
2013-09-23 19:30:44 +00:00
* details.
2014-07-07 15:33:23 +00:00
*
2013-09-23 19:30:44 +00:00
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
2014-07-07 15:33:23 +00:00
*
2013-09-23 19:30:44 +00:00
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
2014-07-07 15:33:23 +00:00
*
2013-09-23 19:30:44 +00:00
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
2014-07-07 15:33:23 +00:00
*
2013-09-23 19:30:44 +00:00
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
2014-07-07 15:33:23 +00:00
* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
*/
2013-09-23 19:30:44 +00:00
/**
* Handle Sugar fields
* @api
*/
class SugarFieldHandler
{
public function __construct()
2019-01-25 13:51:46 +00:00
{
2013-09-23 19:30:44 +00:00
}
public static function fixupFieldType($field)
2019-01-25 13:51:46 +00:00
{
switch ($field) {
2013-09-23 19:30:44 +00:00
case 'double':
case 'decimal':
$field = 'float';
break;
case 'uint':
case 'ulong':
case 'long':
case 'short':
case 'tinyint':
$field = 'int';
break;
case 'date':
$field = 'datetime';
break;
case 'url':
2019-01-25 14:07:05 +00:00
$field = 'link';
break;
2013-09-23 19:30:44 +00:00
case 'varchar':
$field = 'base';
break;
}
return ucfirst($field);
}
/**
* return the singleton of the SugarField
2017-05-25 14:49:54 +00:00
* @param $field
* @param bool $returnNullIfBase
* @return mixed
2013-09-23 19:30:44 +00:00
*/
2019-01-25 13:51:46 +00:00
public static function getSugarField($field, $returnNullIfBase=false)
{
2013-09-23 19:30:44 +00:00
static $sugarFieldObjects = array();
$field = self::fixupFieldType($field);
$field = ucfirst($field);
2019-01-25 13:51:46 +00:00
if (!isset($sugarFieldObjects[$field])) {
//check custom directory
if (file_exists('custom/include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php')) {
$file = 'custom/include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php';
2013-09-23 19:30:44 +00:00
$type = $field;
2019-01-25 13:51:46 +00:00
//else check the fields directory
} elseif (file_exists('include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php')) {
$file = 'include/SugarFields/Fields/' . $field . '/SugarField' . $field. '.php';
$type = $field;
2019-01-25 13:51:46 +00:00
} else {
// No direct class, check the directories to see if they are defined
if ($returnNullIfBase &&
2013-09-23 19:30:44 +00:00
!is_dir('custom/include/SugarFields/Fields/'.$field) &&
!is_dir('include/SugarFields/Fields/'.$field)) {
return null;
2013-09-23 19:30:44 +00:00
}
$file = get_custom_file_if_exists('include/SugarFields/Fields/Base/SugarFieldBase.php');
$type = 'Base';
2019-01-25 13:51:46 +00:00
}
require_once($file);
2013-09-23 19:30:44 +00:00
2019-01-25 13:51:46 +00:00
$class = 'SugarField' . $type;
//could be a custom class check it
$customClass = 'Custom' . $class;
if (class_exists($customClass)) {
$sugarFieldObjects[$field] = new $customClass($field);
} else {
$sugarFieldObjects[$field] = new $class($field);
}
2013-09-23 19:30:44 +00:00
}
return $sugarFieldObjects[$field];
}
/**
* Returns the smarty code to be used in a template built by TemplateHandler
* The SugarField class is choosen dependant on the vardef's type field.
*
* @param parentFieldArray string name of the variable in the parent template for the bean's data
* @param vardef vardef field defintion
* @param displayType string the display type for the field (eg DetailView, EditView, etc)
* @param displayParam parameters for displayin
* available paramters are:
* * labelSpan - column span for the label
* * fieldSpan - column span for the field
*/
public static function displaySmarty($parentFieldArray, $vardef, $displayType, $displayParams = array(), $tabindex = 1)
2019-01-25 13:51:46 +00:00
{
2013-09-23 19:30:44 +00:00
$string = '';
$displayTypeFunc = 'get' . $displayType . 'Smarty'; // getDetailViewSmarty, getEditViewSmarty, etc...
2019-01-25 13:51:46 +00:00
// This will handle custom type fields.
// The incoming $vardef Array may have custom_type set.
// If so, set $vardef['type'] to the $vardef['custom_type'] value
if (isset($vardef['custom_type'])) {
$vardef['type'] = $vardef['custom_type'];
}
if (empty($vardef['type'])) {
$vardef['type'] = 'varchar';
}
2013-09-23 19:30:44 +00:00
2019-01-25 13:51:46 +00:00
$field = self::getSugarField($vardef['type']);
if (!empty($vardef['function'])) {
2019-01-25 13:51:46 +00:00
$string = $field->displayFromFunc($displayType, $parentFieldArray, $vardef, $displayParams, $tabindex);
} else {
$string = $field->$displayTypeFunc($parentFieldArray, $vardef, $displayParams, $tabindex);
}
2013-09-23 19:30:44 +00:00
return $string;
}
}