CRM/Upgrade/Incremental/php/FiveTwo.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   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.                                       |
  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 along with this program; if not, contact CiviCRM LLC       |
  21  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  22  | GNU Affero General Public License or the licensing of CiviCRM,     |
  23  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  24  +--------------------------------------------------------------------+
  25  */
  26
  27 /**
  28  * Upgrade logic for FiveTwo */
  29 class CRM_Upgrade_Incremental_php_FiveTwo extends CRM_Upgrade_Incremental_Base {
  30
  31   /**
  32    * Compute any messages which should be displayed beforeupgrade.
  33    *
  34    * Note: This function is called iteratively for each upcoming
  35    * revision to the database.
  36    *
  37    * @param string $preUpgradeMessage
  38    * @param string $rev
  39    *   a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
  40    * @param null $currentVer
  41    */
  42   public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
  43   }
  44
  45   /**
  46    * Compute any messages which should be displayed after upgrade.
  47    *
  48    * @param string $postUpgradeMessage
  49    *   alterable.
  50    * @param string $rev
  51    *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
  52    */
  53   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  54     // Example: Generate a post-upgrade message.
  55     // if ($rev == '5.12.34') {
  56     //   $postUpgradeMessage .= '<br /><br />' . ts("By default, CiviCRM now disables the ability to import directly from SQL. To use this feature, you must explicitly grant permission 'import SQL datasource'.");
  57     // }
  58   }
  59
  60   /*
  61    * Important! All upgrade functions MUST add a 'runSql' task.
  62    * Uncomment and use the following template for a new upgrade version
  63    * (change the x in the function name):
  64    */
  65
  66   //  /**
  67   //   * Upgrade function.
  68   //   *
  69   //   * @param string $rev
  70   //   */
  71   //  public function upgrade_5_0_x($rev) {
  72   //    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
  73   //    $this->addTask('Do the foo change', 'taskFoo', ...);
  74   //    // Additional tasks here...
  75   //    // Note: do not use ts() in the addTask description because it adds unnecessary strings to transifex.
  76   //    // The above is an exception because 'Upgrade DB to %1: SQL' is generic & reusable.
  77   //  }
  78
  79   // public static function taskFoo(CRM_Queue_TaskContext $ctx, ...) {
  80   //   return TRUE;
  81   // }
  82
  83 }