CRM/Extension/Manager/Module.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  33  */
  34 class CRM_Extension_Manager_Module extends CRM_Extension_Manager_Base {
  35
  36   /**
  37    * @param CRM_Extension_Mapper $mapper
  38    */
  39   public function __construct(CRM_Extension_Mapper $mapper) {
  40     parent::__construct(FALSE);
  41     $this->mapper = $mapper;
  42   }
  43
  44   /**
  45    * @param CRM_Extension_Info $info
  46    */
  47   public function onPreInstall(CRM_Extension_Info $info) {
  48     $this->callHook($info, 'install');
  49     $this->callHook($info, 'enable');
  50   }
  51
  52   /**
  53    * @param CRM_Extension_Info $info
  54    */
  55   public function onPostPostInstall(CRM_Extension_Info $info) {
  56     $this->callHook($info, 'postInstall');
  57   }
  58
  59   /**
  60    * @param CRM_Extension_Info $info
  61    * @param string $hookName
  62    */
  63   private function callHook(CRM_Extension_Info $info, $hookName) {
  64     try {
  65       $file = $this->mapper->keyToPath($info->key);
  66     }
  67     catch (CRM_Extension_Exception $e) {
  68       return;
  69     }
  70     if (!file_exists($file)) {
  71       return;
  72     }
  73     include_once $file;
  74     $fnName = "{$info->file}_civicrm_{$hookName}";
  75     if (function_exists($fnName)) {
  76       $fnName();
  77     }
  78   }
  79
  80   /**
  81    * @param CRM_Extension_Info $info
  82    *
  83    * @return bool
  84    */
  85   public function onPreUninstall(CRM_Extension_Info $info) {
  86     $this->callHook($info, 'uninstall');
  87     return TRUE;
  88   }
  89
  90   /**
  91    * @param CRM_Extension_Info $info
  92    */
  93   public function onPostUninstall(CRM_Extension_Info $info) {
  94   }
  95
  96   /**
  97    * @param CRM_Extension_Info $info
  98    */
  99   public function onPreDisable(CRM_Extension_Info $info) {
 100     $this->callHook($info, 'disable');
 101   }
 102
 103   /**
 104    * @param CRM_Extension_Info $info
 105    */
 106   public function onPreEnable(CRM_Extension_Info $info) {
 107     $this->callHook($info, 'enable');
 108   }
 109
 110 }