CRM/Extension/Upgrades.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 and the CiviCRM Licensing Exception.   |
  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 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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This class stores logic for managing schema upgrades in CiviCRM extensions.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  */
  34 class CRM_Extension_Upgrades {
  35
  36   const QUEUE_NAME = 'ext-upgrade';
  37
  38   /**
  39    * Determine whether any extensions have pending upgrades.
  40    *
  41    * @return bool
  42    */
  43   public static function hasPending() {
  44     $checks = CRM_Utils_Hook::upgrade('check');
  45     if (is_array($checks)) {
  46       foreach ($checks as $check) {
  47         if ($check) {
  48           return TRUE;
  49         }
  50       }
  51     }
  52
  53     return FALSE;
  54   }
  55
  56   /**
  57    * Fill a queue with upgrade tasks.
  58    *
  59    * @return CRM_Queue_Queue
  60    */
  61   public static function createQueue() {
  62     $queue = CRM_Queue_Service::singleton()->create([
  63       'type' => 'Sql',
  64       'name' => self::QUEUE_NAME,
  65       'reset' => TRUE,
  66     ]);
  67
  68     CRM_Utils_Hook::upgrade('enqueue', $queue);
  69
  70     return $queue;
  71   }
  72
  73 }