CRM/Upgrade/Incremental/php/FourSix.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6.alpha1                                         |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  *
  29  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2014
  31  * $Id$
  32  *
  33  */
  34 class CRM_Upgrade_Incremental_php_FourSix {
  35   const BATCH_SIZE = 5000;
  36
  37   /**
  38    * @param $errors
  39    *
  40    * @return bool
  41    */
  42   function verifyPreDBstate(&$errors) {
  43     return TRUE;
  44   }
  45
  46   /**
  47    * Compute any messages which should be displayed beforeupgrade
  48    *
  49    * Note: This function is called iteratively for each upcoming
  50    * revision to the database.
  51    *
  52    * @param $preUpgradeMessage
  53    * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
  54    * @param null $currentVer
  55    *
  56    * @return void
  57    */
  58   function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
  59   }
  60
  61   /**
  62    * Compute any messages which should be displayed after upgrade
  63    *
  64    * @param $postUpgradeMessage string, alterable
  65    * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
  66    * @return void
  67    */
  68   function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  69    if ($rev == '4.6.alpha1') {
  70       $postUpgradeMessage .= '<br /><br />' . ts('Default versions of the following System Workflow Message Templates have been modified to handle new functionality: <ul><li>Events - Registration Confirmation and Receipt (on-line)</li><li>Events - Registration Confirmation and Receipt (off-line)</li><li>Contributions - Receipt (on-line)</li><li>Contributions - Receipt (off-line)</li><li>Memberships - Receipt (on-line)</li><li>Memberships - Signup and Renewal Receipts (off-line)</li></ul> If you have modified these templates, please review the new default versions and implement updates as needed to your copies (Administer > Communications > Message Templates > System Workflow Messages).');
  71     }
  72   }
  73
  74
  75
  76   /**
  77    * (Queue Task Callback)
  78    */
  79   static function task_4_6_x_runSql(CRM_Queue_TaskContext $ctx, $rev) {
  80     $upgrade = new CRM_Upgrade_Form();
  81     $upgrade->processSQL($rev);
  82
  83     return TRUE;
  84   }
  85
  86   /**
  87    * Syntactic sugar for adding a task which (a) is in this class and (b) has
  88    * a high priority.
  89    *
  90    * After passing the $funcName, you can also pass parameters that will go to
  91    * the function. Note that all params must be serializable.
  92    */
  93   protected function addTask($title, $funcName) {
  94     $queue = CRM_Queue_Service::singleton()->load(array(
  95       'type' => 'Sql',
  96       'name' => CRM_Upgrade_Form::QUEUE_NAME,
  97     ));
  98
  99     $args = func_get_args();
 100     $title = array_shift($args);
 101     $funcName = array_shift($args);
 102     $task = new CRM_Queue_Task(
 103       array(get_class($this), $funcName),
 104       $args,
 105       $title
 106     );
 107     $queue->createItem($task, array('weight' => -1));
 108   }
 109 }