CRM/Extension/Manager/Module.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  * This class stores logic for managing CiviCRM extensions.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36 class CRM_Extension_Manager_Module extends CRM_Extension_Manager_Base {
  37
  38   /**
  39    * @param CRM_Extension_Mapper $mapper
  40    */
  41   public function __construct(CRM_Extension_Mapper $mapper) {
  42     parent::__construct(FALSE);
  43     $this->mapper = $mapper;
  44   }
  45
  46   /**
  47    * @param CRM_Extension_Info $info
  48    */
  49   public function onPreInstall(CRM_Extension_Info $info) {
  50     $this->callHook($info, 'install');
  51     $this->callHook($info, 'enable');
  52   }
  53
  54   /**
  55    * @param CRM_Extension_Info $info
  56    */
  57   public function onPostPostInstall(CRM_Extension_Info $info) {
  58     $this->callHook($info, 'postInstall');
  59   }
  60
  61   /**
  62    * @param CRM_Extension_Info $info
  63    * @param $hookName
  64    */
  65   private function callHook(CRM_Extension_Info $info, $hookName) {
  66     try {
  67       $file = $this->mapper->keyToPath($info->key);
  68     } catch (CRM_Extension_Exception $e) {
  69       return;
  70     }
  71     if (!file_exists($file)) {
  72       return;
  73     }
  74     include_once $file;
  75     $fnName = "{$info->file}_civicrm_{$hookName}";
  76     if (function_exists($fnName)) {
  77       $fnName();
  78     }
  79   }
  80
  81   /**
  82    * @param CRM_Extension_Info $info
  83    *
  84    * @return bool
  85    */
  86   public function onPreUninstall(CRM_Extension_Info $info) {
  87     $this->callHook($info, 'uninstall');
  88     return TRUE;
  89   }
  90
  91   /**
  92    * @param CRM_Extension_Info $info
  93    */
  94   public function onPostUninstall(CRM_Extension_Info $info) {
  95   }
  96
  97   /**
  98    * @param CRM_Extension_Info $info
  99    */
 100   public function onPreDisable(CRM_Extension_Info $info) {
 101     $this->callHook($info, 'disable');
 102   }
 103
 104   /**
 105    * @param CRM_Extension_Info $info
 106    */
 107   public function onPreEnable(CRM_Extension_Info $info) {
 108     $this->callHook($info, 'enable');
 109   }
 110 }
 111