CRM/Upgrade/Incremental/php/FiveTwenty.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 FiveTwenty */
  29 class CRM_Upgrade_Incremental_php_FiveTwenty 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     // Example: Generate a pre-upgrade message.
  44     // if ($rev == '5.12.34') {
  45     //   $preUpgradeMessage .= '<p>' . ts('A new permission, "%1", has been added. This permission is now used to control access to the Manage Tags screen.', array(1 => ts('manage tags'))) . '</p>';
  46     // }
  47   }
  48
  49   /**
  50    * Compute any messages which should be displayed after upgrade.
  51    *
  52    * @param string $postUpgradeMessage
  53    *   alterable.
  54    * @param string $rev
  55    *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
  56    */
  57   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  58     // Example: Generate a post-upgrade message.
  59     // if ($rev == '5.12.34') {
  60     //   $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'.");
  61     // }
  62   }
  63
  64   /*
  65    * Important! All upgrade functions MUST add a 'runSql' task.
  66    * Uncomment and use the following template for a new upgrade version
  67    * (change the x in the function name):
  68    */
  69
  70   // public static function taskFoo(CRM_Queue_TaskContext $ctx, ...) {
  71   //   return TRUE;
  72   // }
  73
  74   /**
  75    * Upgrade function.
  76    *
  77    * @param string $rev
  78    */
  79   public function upgrade_5_20_alpha1($rev) {
  80     $this->addTask('Add frontend title column to contribution page table', 'addColumn', 'civicrm_contribution_page',
  81       'frontend_title', "varchar(255) DEFAULT NULL COMMENT 'Contribution Page Public title'", TRUE, '5.20.alpha1');
  82     $this->addTask('Add is_template field to civicrm_contribution', 'addColumn', 'civicrm_contribution', 'is_template',
  83       "tinyint(4) DEFAULT '0' COMMENT 'Shows this is a template for recurring contributions.'", FALSE, '5.20.alpha1');
  84     $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
  85   }
  86
  87 }