include/connectors/formatters/FormatterFactory.php

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