NFC - Cleanup messy boilerplate
authorColeman Watts <coleman@civicrm.org>
Wed, 8 Dec 2021 13:44:07 +0000 (08:44 -0500)
committerColeman Watts <coleman@civicrm.org>
Wed, 8 Dec 2021 13:44:07 +0000 (08:44 -0500)
CRM/Upgrade/Incremental/php/FiveFortySix.php

index 6b94c7836b2e87afbdc77026c54abdb72cfec437..26d9bdc87e5a51381273a674e6789d9d3ff1bba8 100644 (file)
  */
 
 /**
- * Upgrade logic for FiveFortySix */
+ * Upgrade logic for FiveFortySix
+ */
 class CRM_Upgrade_Incremental_php_FiveFortySix extends CRM_Upgrade_Incremental_Base {
 
   /**
-   * Compute any messages which should be displayed beforeupgrade.
+   * Compute any messages which should be displayed before upgrade.
    *
    * Note: This function is called iteratively for each incremental upgrade step.
    * There must be a concrete step (eg 'X.Y.Z.mysql.tpl' or 'upgrade_X_Y_Z()').
@@ -25,10 +26,6 @@ class CRM_Upgrade_Incremental_php_FiveFortySix extends CRM_Upgrade_Incremental_B
    * @param null $currentVer
    */
   public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL): void {
-    // Example: Generate a pre-upgrade message.
-    // if ($rev == '5.12.34') {
-    //   $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>';
-    // }
   }
 
   /**
@@ -43,33 +40,15 @@ class CRM_Upgrade_Incremental_php_FiveFortySix extends CRM_Upgrade_Incremental_B
    *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    */
   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev): void {
-    // Example: Generate a post-upgrade message.
-    // if ($rev == '5.12.34') {
-    //   $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'.");
-    // }
   }
 
-  /*
-   * Important! All upgrade functions MUST add a 'runSql' task.
-   * Uncomment and use the following template for a new upgrade version
-   * (change the x in the function name):
+  /**
+   * Upgrade function.
+   *
+   * @param string $rev
    */
-
-  //  /**
-  //   * Upgrade function.
-  //   *
-  //   * @param string $rev
-  //   */
-  //  public function upgrade_5_0_x($rev): void {
-  //    $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
-  //    $this->addTask('Do the foo change', 'taskFoo', ...);
-  //    // Additional tasks here...
-  //    // Note: do not use ts() in the addTask description because it adds unnecessary strings to transifex.
-  //    // The above is an exception because 'Upgrade DB to %1: SQL' is generic & reusable.
-  //  }
-
-  // public static function taskFoo(CRM_Queue_TaskContext $ctx, ...): bool {
-  //   return TRUE;
-  // }
+  public function upgrade_5_46_alpha1($rev): void {
+    $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
+  }
 
 }