CRM/Extension/Manager/Interface.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  34  */
  35 interface CRM_Extension_Manager_Interface {
  36   /**
  37    * Perform type-specific installation logic (before marking the
  38    * extension as installed or clearing the caches).
  39    *
  40    * @param CRM_Extension_Info $info
  41    */
  42   public function onPreInstall(CRM_Extension_Info $info);
  43
  44   /**
  45    * Perform type-specific installation logic (after marking the
  46    * extension as installed but before clearing the caches).
  47    *
  48    * @param CRM_Extension_Info $info
  49    */
  50   public function onPostInstall(CRM_Extension_Info $info);
  51
  52   /**
  53    * Perform type-specific installation logic (after marking the
  54    * extension as installed and clearing the caches).
  55    *
  56    * @param CRM_Extension_Info $info
  57    */
  58   public function onPostPostInstall(CRM_Extension_Info $info);
  59
  60   /**
  61    * @param CRM_Extension_Info $info
  62    */
  63   public function onPreEnable(CRM_Extension_Info $info);
  64
  65   /**
  66    * @param CRM_Extension_Info $info
  67    */
  68   public function onPostEnable(CRM_Extension_Info $info);
  69
  70   /**
  71    * Perform type-specific removal logic (before updating the extension
  72    * row in the "civicrm_extension" table).
  73    *
  74    * @param CRM_Extension_Info $info
  75    *   May be generated from xml or DB (which is lossy).
  76    * @see CRM_Extension_Manager::createInfoFromDB
  77    */
  78   public function onPreDisable(CRM_Extension_Info $info);
  79
  80   /**
  81    * Perform type-specific removal logic (after updating the extension
  82    * row in the "civicrm_extension" table).
  83    *
  84    * @param CRM_Extension_Info $info
  85    *   May be generated from xml or DB (which is lossy).
  86    * @see CRM_Extension_Manager::createInfoFromDB
  87    */
  88   public function onPostDisable(CRM_Extension_Info $info);
  89
  90   /**
  91    * Perform type-specific removal logic (before removing the extension
  92    * row in the "civicrm_extension" table).
  93    *
  94    * @param CRM_Extension_Info $info
  95    *   May be generated from xml or DB (which is lossy).
  96    * @see CRM_Extension_Manager::createInfoFromDB
  97    */
  98   public function onPreUninstall(CRM_Extension_Info $info);
  99
 100   /**
 101    * Perform type-specific removal logic (after removing the extension
 102    * row in the "civicrm_extension" table).
 103    *
 104    * @param CRM_Extension_Info $info
 105    *   May be generated from xml or DB (which is lossy).
 106    * @see CRM_Extension_Manager::createInfoFromDB
 107    */
 108   public function onPostUninstall(CRM_Extension_Info $info);
 109
 110   /**
 111    * @param CRM_Extension_Info $oldInfo
 112    * @param CRM_Extension_Info $newInfo
 113    */
 114   public function onPreReplace(CRM_Extension_Info $oldInfo, CRM_Extension_Info $newInfo);
 115
 116   /**
 117    * @param CRM_Extension_Info $oldInfo
 118    * @param CRM_Extension_Info $newInfo
 119    */
 120   public function onPostReplace(CRM_Extension_Info $oldInfo, CRM_Extension_Info $newInfo);
 121
 122 }