CRM/Extension/Manager/Module.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This class stores logic for managing CiviCRM extensions.
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  */
  18 class CRM_Extension_Manager_Module extends CRM_Extension_Manager_Base {
  19
  20   /**
  21    * @param CRM_Extension_Mapper $mapper
  22    */
  23   public function __construct(CRM_Extension_Mapper $mapper) {
  24     parent::__construct(FALSE);
  25     $this->mapper = $mapper;
  26   }
  27
  28   /**
  29    * @param CRM_Extension_Info $info
  30    */
  31   public function onPreInstall(CRM_Extension_Info $info) {
  32     $this->callHook($info, 'install');
  33     $this->callHook($info, 'enable');
  34   }
  35
  36   /**
  37    * @param CRM_Extension_Info $info
  38    */
  39   public function onPostPostInstall(CRM_Extension_Info $info) {
  40     $this->callHook($info, 'postInstall');
  41   }
  42
  43   /**
  44    * @param CRM_Extension_Info $info
  45    * @param string $hookName
  46    */
  47   private function callHook(CRM_Extension_Info $info, $hookName) {
  48     try {
  49       $file = $this->mapper->keyToPath($info->key);
  50     }
  51     catch (CRM_Extension_Exception $e) {
  52       return;
  53     }
  54     if (!file_exists($file)) {
  55       return;
  56     }
  57     include_once $file;
  58     $fnName = "{$info->file}_civicrm_{$hookName}";
  59     if (function_exists($fnName)) {
  60       $fnName();
  61     }
  62   }
  63
  64   /**
  65    * @param CRM_Extension_Info $info
  66    *
  67    * @return bool
  68    */
  69   public function onPreUninstall(CRM_Extension_Info $info) {
  70     $this->callHook($info, 'uninstall');
  71     return TRUE;
  72   }
  73
  74   /**
  75    * @param CRM_Extension_Info $info
  76    */
  77   public function onPostUninstall(CRM_Extension_Info $info) {
  78   }
  79
  80   /**
  81    * @param CRM_Extension_Info $info
  82    */
  83   public function onPreDisable(CRM_Extension_Info $info) {
  84     $this->callHook($info, 'disable');
  85   }
  86
  87   /**
  88    * @param CRM_Extension_Info $info
  89    */
  90   public function onPreEnable(CRM_Extension_Info $info) {
  91     $this->callHook($info, 'enable');
  92   }
  93
  94 }