CRM/Extension/Manager/Interface.php

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