3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6.alpha1 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * Base class for incremental upgrades
31 class CRM_Upgrade_Incremental_Base
{
32 const BATCH_SIZE
= 5000;
41 public function verifyPreDBstate(&$errors) {
46 * Compute any messages which should be displayed before upgrade.
48 * Note: This function is called iteratively for each upcoming
49 * revision to the database.
51 * @param $preUpgradeMessage
53 * a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
54 * @param null $currentVer
56 public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
60 * Compute any messages which should be displayed after upgrade.
62 * @param string $postUpgradeMessage
65 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
68 public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
73 * (Queue Task Callback)
75 public static function runSql(CRM_Queue_TaskContext
$ctx, $rev) {
76 $upgrade = new CRM_Upgrade_Form();
77 $upgrade->processSQL($rev);
83 * Syntactic sugar for adding a task which (a) is in this class and (b) has
86 * After passing the $funcName, you can also pass parameters that will go to
87 * the function. Note that all params must be serializable.
89 protected function addTask($title, $funcName) {
90 $queue = CRM_Queue_Service
::singleton()->load(array(
92 'name' => CRM_Upgrade_Form
::QUEUE_NAME
,
95 $args = func_get_args();
96 $title = array_shift($args);
97 $funcName = array_shift($args);
98 $task = new CRM_Queue_Task(
99 array(get_class($this), $funcName),
103 $queue->createItem($task, array('weight' => -1));