1
|
|
|
<?php |
2
|
|
|
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point'); |
3
|
|
|
/********************************************************************************* |
4
|
|
|
* SugarCRM Community Edition is a customer relationship management program developed by |
5
|
|
|
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc. |
6
|
|
|
|
7
|
|
|
* SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd. |
8
|
|
|
* Copyright (C) 2011 - 2014 Salesagility Ltd. |
9
|
|
|
* |
10
|
|
|
* This program is free software; you can redistribute it and/or modify it under |
11
|
|
|
* the terms of the GNU Affero General Public License version 3 as published by the |
12
|
|
|
* Free Software Foundation with the addition of the following permission added |
13
|
|
|
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK |
14
|
|
|
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY |
15
|
|
|
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. |
16
|
|
|
* |
17
|
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT |
18
|
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
19
|
|
|
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more |
20
|
|
|
* details. |
21
|
|
|
* |
22
|
|
|
* You should have received a copy of the GNU Affero General Public License along with |
23
|
|
|
* this program; if not, see http://www.gnu.org/licenses or write to the Free |
24
|
|
|
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
25
|
|
|
* 02110-1301 USA. |
26
|
|
|
* |
27
|
|
|
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road, |
28
|
|
|
* SW2-130, Cupertino, CA 95014, USA. or at email address [email protected]. |
29
|
|
|
* |
30
|
|
|
* The interactive user interfaces in modified source and object code versions |
31
|
|
|
* of this program must display Appropriate Legal Notices, as required under |
32
|
|
|
* Section 5 of the GNU Affero General Public License version 3. |
33
|
|
|
* |
34
|
|
|
* In accordance with Section 7(b) of the GNU Affero General Public License version 3, |
35
|
|
|
* these Appropriate Legal Notices must retain the display of the "Powered by |
36
|
|
|
* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not |
37
|
|
|
* reasonably feasible for technical reasons, the Appropriate Legal Notices must |
38
|
|
|
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM". |
39
|
|
|
********************************************************************************/ |
40
|
|
|
|
41
|
|
|
/** |
42
|
|
|
* Formatter factory |
43
|
|
|
* @api |
44
|
|
|
*/ |
45
|
|
|
class FormatterFactory { |
46
|
|
|
|
47
|
|
|
static $formatter_map = array(); |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* getInstance |
51
|
|
|
* This method returns a formatter instance for the given source name and |
52
|
|
|
* formatter name. If no formatter name is specified, the default formatter |
53
|
|
|
* for the source is used. |
54
|
|
|
* |
55
|
|
|
* @param $source_name The data source name to retreive formatter for |
56
|
|
|
* @param $formatter_name Optional formatter name to use |
57
|
|
|
* @param $wrapper_name Optional wrapper name to use |
58
|
|
|
* @return $instance The formatter instance |
|
|
|
|
59
|
|
|
*/ |
60
|
|
|
public static function getInstance($source_name, $formatter_name=''){ |
61
|
|
|
require_once('include/connectors/formatters/default/formatter.php'); |
62
|
|
|
$key = $source_name . $formatter_name; |
63
|
|
|
if(empty(self::$formatter_map[$key])) { |
64
|
|
|
|
65
|
|
|
if(empty($formatter_name)){ |
66
|
|
|
$formatter_name = $source_name; |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
//split the wrapper name to find the path to the file. |
70
|
|
|
$dir = str_replace('_','/',$formatter_name); |
71
|
|
|
$parts = explode("/", $dir); |
72
|
|
|
$file = $parts[count($parts)-1]; |
73
|
|
|
|
74
|
|
|
//check if this override wrapper file exists. |
75
|
|
|
require_once('include/connectors/ConnectorFactory.php'); |
76
|
|
|
if(file_exists("modules/Connectors/connectors/formatters/{$dir}/{$file}.php") || |
77
|
|
|
file_exists("custom/modules/Connectors/connectors/formatters/{$dir}/{$file}.php")) { |
78
|
|
|
ConnectorFactory::load($formatter_name, 'formatters'); |
79
|
|
|
try{ |
80
|
|
|
$formatter_name .= '_formatter'; |
81
|
|
|
}catch(Exception $ex){ |
|
|
|
|
82
|
|
|
return null; |
83
|
|
|
} |
84
|
|
|
}else{ |
85
|
|
|
//if there is no override wrapper, use the default. |
86
|
|
|
$formatter_name = 'default_formatter'; |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
$component = ConnectorFactory::getInstance($source_name); |
90
|
|
|
$formatter = new $formatter_name(); |
91
|
|
|
$formatter->setComponent($component); |
92
|
|
|
if(file_exists("custom/modules/Connectors/connectors/formatters/{$dir}/tpls/{$file}.tpl")){ |
93
|
|
|
$formatter->setTplFileName("custom/modules/Connectors/connectors/formatters/{$dir}/tpls/{$file}.tpl"); |
94
|
|
|
} else if("modules/Connectors/connectors/formatters/{$dir}/tpls/{$file}.tpl") { |
95
|
|
|
$formatter->setTplFileName("modules/Connectors/connectors/formatters/{$dir}/tpls/{$file}.tpl"); |
96
|
|
|
} |
97
|
|
|
self::$formatter_map[$key] = $formatter; |
98
|
|
|
} //if |
99
|
|
|
return self::$formatter_map[$key]; |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
} |
103
|
|
|
?> |
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.