Merge pull request #16103 from civicrm/5.21
[civicrm-core.git] / CRM / Upgrade / Headless.php
index 31ccc3ae1c74bedc4913be22a49d7508d25187d6..0e1e869b0c732586d70db9012c4ee1c51b19029b 100644 (file)
@@ -1,27 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019                                |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM.                                    |
- |                                                                    |
- | CiviCRM is free software; you can copy, modify, and distribute it  |
- | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
- |                                                                    |
- | CiviCRM is distributed in the hope that it will be useful, but     |
- | WITHOUT ANY WARRANTY; without even the implied warranty of         |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
- | See the GNU Affero General Public License for more details.        |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | You should have received a copy of the GNU Affero General Public   |
- | License and the CiviCRM Licensing Exception along                  |
- | with this program; if not, contact CiviCRM LLC                     |
- | at info[AT]civicrm[DOT]org. If you have questions about the        |
- | GNU Affero General Public License or the licensing of CiviCRM,     |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 
@@ -36,7 +20,8 @@ class CRM_Upgrade_Headless {
    * @param bool $enablePrint
    *
    * @throws Exception
-   * @return array, with keys:
+   * @return array
+   *   - with keys:
    *   - message: string, HTML-ish blob
    */
   public function run($enablePrint = TRUE) {
@@ -60,10 +45,10 @@ class CRM_Upgrade_Headless {
     $upgrade->setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
 
     $postUpgradeMessageFile = CRM_Utils_File::tempnam('civicrm-post-upgrade');
-    $queueRunner = new CRM_Queue_Runner(array(
+    $queueRunner = new CRM_Queue_Runner([
       'title' => ts('CiviCRM Upgrade Tasks'),
       'queue' => CRM_Upgrade_Form::buildQueue($currentVer, $latestVer, $postUpgradeMessageFile),
-    ));
+    ]);
     $queueResult = $queueRunner->runAll();
     if ($queueResult !== TRUE) {
       $errorMessage = CRM_Core_Error::formatTextException($queueResult['exception']);
@@ -71,17 +56,18 @@ class CRM_Upgrade_Headless {
       if ($enablePrint) {
         print ($errorMessage);
       }
-      throw $queueResult['exception']; // FIXME test
+      // FIXME test
+      throw $queueResult['exception'];
     }
 
     CRM_Upgrade_Form::doFinish();
 
     $message = file_get_contents($postUpgradeMessageFile);
-    return array(
+    return [
       'latestVer' => $latestVer,
       'message' => $message,
       'text' => CRM_Utils_String::htmlToText($message),
-    );
+    ];
   }
 
 }