include/MVC/SugarModule.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-2011 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 class SugarModule
  40 {
  41     protected static $_instances = array();
  42
  43     protected $_moduleName;
  44
  45     public static function get(
  46         $moduleName
  47         )
  48     {
  49         if ( !isset(self::$_instances[$moduleName]) )
  50             self::$_instances[$moduleName] = new SugarModule($moduleName);
  51
  52         return self::$_instances[$moduleName];
  53     }
  54
  55     public function __construct(
  56         $moduleName
  57         )
  58     {
  59         $this->_moduleName = $moduleName;
  60     }
  61
  62     /**
  63      * Returns true if the given module implements the indicated template
  64      *
  65      * @param  string $template
  66      * @return bool
  67      */
  68     public function moduleImplements(
  69         $template
  70         )
  71     {
  72         $focus = self::loadBean();
  73
  74         if ( !$focus )
  75             return false;
  76
  77         return is_a($focus,$template);
  78     }
  79
  80     /**
  81      * Returns the bean object of the given module
  82      *
  83      * @return object
  84      */
  85     public function loadBean($beanList = null, $beanFiles = null, $returnObject = true)
  86     {
  87         // Populate these reference arrays
  88         if ( empty($beanList) ) {
  89             global $beanList;
  90         }
  91         if ( empty($beanFiles) ) {
  92             global $beanFiles;
  93         }
  94         if ( !isset($beanList) || !isset($beanFiles) ) {
  95             require('include/modules.php');
  96         }
  97
  98         if ( isset($beanList[$this->_moduleName]) ) {
  99             $bean = $beanList[$this->_moduleName];
 100             if (isset($beanFiles[$bean])) {
 101                 if ( !$returnObject ) {
 102                     return true;
 103                 }
 104                 if ( !sugar_is_file($beanFiles[$bean]) ) {
 105                     return false;
 106                 }
 107                 require_once($beanFiles[$bean]);
 108                 $focus = new $bean;
 109             }
 110             else {
 111                 return false;
 112             }
 113         }
 114         else {
 115             return false;
 116         }
 117
 118         return $focus;
 119     }
 120 }