CRM/Extension/Manager/Base.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * The extension manager handles installing, disabling enabling, and
  30  * uninstalling extensions.
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2017
  34  */
  35 class CRM_Extension_Manager_Base implements CRM_Extension_Manager_Interface {
  36
  37   /**
  38    * @var bool hether to automatically uninstall and install during 'replace'
  39    */
  40   public $autoReplace;
  41
  42   /**
  43    * @param bool $autoReplace
  44    *   Whether to automatically uninstall and install during 'replace'.
  45    */
  46   public function __construct($autoReplace = FALSE) {
  47     $this->autoReplace = $autoReplace;
  48   }
  49
  50   /**
  51    * @inheritDoc
  52    *
  53    * @param CRM_Extension_Info $info
  54    */
  55   public function onPreInstall(CRM_Extension_Info $info) {
  56   }
  57
  58   /**
  59    * @inheritDoc
  60    *
  61    * @param CRM_Extension_Info $info
  62    */
  63   public function onPostInstall(CRM_Extension_Info $info) {
  64   }
  65
  66   /**
  67    * @inheritDoc
  68    *
  69    * @param CRM_Extension_Info $info
  70    */
  71   public function onPostPostInstall(CRM_Extension_Info $info) {
  72   }
  73
  74   /**
  75    * @inheritDoc
  76    *
  77    * @param CRM_Extension_Info $info
  78    */
  79   public function onPreEnable(CRM_Extension_Info $info) {
  80   }
  81
  82   /**
  83    * @inheritDoc
  84    *
  85    * @param CRM_Extension_Info $info
  86    */
  87   public function onPostEnable(CRM_Extension_Info $info) {
  88   }
  89
  90   /**
  91    * @inheritDoc
  92    *
  93    * @param CRM_Extension_Info $info
  94    */
  95   public function onPreDisable(CRM_Extension_Info $info) {
  96   }
  97
  98   /**
  99    * @inheritDoc
 100    *
 101    * @param CRM_Extension_Info $info
 102    */
 103   public function onPostDisable(CRM_Extension_Info $info) {
 104   }
 105
 106   /**
 107    * @inheritDoc
 108    *
 109    * @param CRM_Extension_Info $info
 110    */
 111   public function onPreUninstall(CRM_Extension_Info $info) {
 112   }
 113
 114   /**
 115    * @inheritDoc
 116    *
 117    * @param CRM_Extension_Info $info
 118    */
 119   public function onPostUninstall(CRM_Extension_Info $info) {
 120   }
 121
 122   /**
 123    * @inheritDoc
 124    *
 125    * @param CRM_Extension_Info $oldInfo
 126    * @param CRM_Extension_Info $newInfo
 127    */
 128   public function onPreReplace(CRM_Extension_Info $oldInfo, CRM_Extension_Info $newInfo) {
 129     if ($this->autoReplace) {
 130       $this->onPreUninstall($oldInfo);
 131       $this->onPostUninstall($oldInfo);
 132     }
 133   }
 134
 135   /**
 136    * @inheritDoc
 137    *
 138    * @param CRM_Extension_Info $oldInfo
 139    * @param CRM_Extension_Info $newInfo
 140    */
 141   public function onPostReplace(CRM_Extension_Info $oldInfo, CRM_Extension_Info $newInfo) {
 142     if ($this->autoReplace) {
 143       $this->onPreInstall($oldInfo);
 144       $this->onPostInstall($oldInfo);
 145     }
 146   }
 147
 148 }