From 866c3273e0ae556eaad2fb5afe8e8b75bf4b6a9f Mon Sep 17 00:00:00 2001 From: eileen Date: Thu, 10 Sep 2020 09:31:41 +1200 Subject: [PATCH] Re-run civix upgrader --- .../gui/CRM/AfformGui/Upgrader/Base.php | 91 ++++++++++++------- 1 file changed, 56 insertions(+), 35 deletions(-) diff --git a/ext/afform/gui/CRM/AfformGui/Upgrader/Base.php b/ext/afform/gui/CRM/AfformGui/Upgrader/Base.php index 0dad883897..d9632679d7 100644 --- a/ext/afform/gui/CRM/AfformGui/Upgrader/Base.php +++ b/ext/afform/gui/CRM/AfformGui/Upgrader/Base.php @@ -9,9 +9,9 @@ use CRM_AfformGui_ExtensionUtil as E; class CRM_AfformGui_Upgrader_Base { /** - * @var varies, subclass of this + * @var CRM_AfformGui_Upgrader_Base */ - static $instance; + public static $instance; /** * @var CRM_Queue_TaskContext @@ -19,22 +19,25 @@ class CRM_AfformGui_Upgrader_Base { protected $ctx; /** - * @var string, eg 'com.example.myextension' + * @var string + * eg 'com.example.myextension' */ protected $extensionName; /** - * @var string, full path to the extension's source tree + * @var string + * full path to the extension's source tree */ protected $extensionDir; /** - * @var array(revisionNumber) sorted numerically + * @var revisionNumber[] + * sorted numerically */ private $revisions; /** - * @var boolean + * @var bool * Flag to clean up extension revision data in civicrm_setting */ private $revisionStorageIsDeprecated = FALSE; @@ -42,7 +45,7 @@ class CRM_AfformGui_Upgrader_Base { /** * Obtain a reference to the active upgrade handler. */ - static public function instance() { + public static function instance() { if (!self::$instance) { // FIXME auto-generate self::$instance = new CRM_AfformGui_Upgrader( @@ -59,19 +62,25 @@ class CRM_AfformGui_Upgrader_Base { * Note: Each upgrader instance should only be associated with one * task-context; otherwise, this will be non-reentrant. * - * @code + * ``` * CRM_AfformGui_Upgrader_Base::_queueAdapter($ctx, 'methodName', 'arg1', 'arg2'); - * @endcode + * ``` */ - static public function _queueAdapter() { + public static function _queueAdapter() { $instance = self::instance(); $args = func_get_args(); $instance->ctx = array_shift($args); $instance->queue = $instance->ctx->queue; $method = array_shift($args); - return call_user_func_array(array($instance, $method), $args); + return call_user_func_array([$instance, $method], $args); } + /** + * CRM_AfformGui_Upgrader_Base constructor. + * + * @param $extensionName + * @param $extensionDir + */ public function __construct($extensionName, $extensionDir) { $this->extensionName = $extensionName; $this->extensionDir = $extensionDir; @@ -82,7 +91,8 @@ class CRM_AfformGui_Upgrader_Base { /** * Run a CustomData file. * - * @param string $relativePath the CustomData XML file path (relative to this extension's dir) + * @param string $relativePath + * the CustomData XML file path (relative to this extension's dir) * @return bool */ public function executeCustomDataFile($relativePath) { @@ -93,11 +103,12 @@ class CRM_AfformGui_Upgrader_Base { /** * Run a CustomData file * - * @param string $xml_file the CustomData XML file path (absolute path) + * @param string $xml_file + * the CustomData XML file path (absolute path) * * @return bool */ - protected static function executeCustomDataFileByAbsPath($xml_file) { + protected function executeCustomDataFileByAbsPath($xml_file) { $import = new CRM_Utils_Migrate_Import(); $import->run($xml_file); return TRUE; @@ -106,7 +117,8 @@ class CRM_AfformGui_Upgrader_Base { /** * Run a SQL file. * - * @param string $relativePath the SQL file path (relative to this extension's dir) + * @param string $relativePath + * the SQL file path (relative to this extension's dir) * * @return bool */ @@ -119,10 +131,14 @@ class CRM_AfformGui_Upgrader_Base { } /** + * Run the sql commands in the specified file. + * * @param string $tplFile * The SQL file path (relative to this extension's dir). * Ex: "sql/mydata.mysql.tpl". + * * @return bool + * @throws \CRM_Core_Exception */ public function executeSqlTemplate($tplFile) { // Assign multilingual variable to Smarty. @@ -141,17 +157,19 @@ class CRM_AfformGui_Upgrader_Base { * Run one SQL query. * * This is just a wrapper for CRM_Core_DAO::executeSql, but it - * provides syntatic sugar for queueing several tasks that + * provides syntactic sugar for queueing several tasks that * run different queries + * + * @return bool */ - public function executeSql($query, $params = array()) { + public function executeSql($query, $params = []) { // FIXME verify that we raise an exception on error CRM_Core_DAO::executeQuery($query, $params); return TRUE; } /** - * Syntatic sugar for enqueuing a task which calls a function in this class. + * Syntactic sugar for enqueuing a task which calls a function in this class. * * The task is weighted so that it is processed * as part of the currently-pending revision. @@ -163,11 +181,11 @@ class CRM_AfformGui_Upgrader_Base { $args = func_get_args(); $title = array_shift($args); $task = new CRM_Queue_Task( - array(get_class($this), '_queueAdapter'), + [get_class($this), '_queueAdapter'], $args, $title ); - return $this->queue->createItem($task, array('weight' => -1)); + return $this->queue->createItem($task, ['weight' => -1]); } // ******** Revision-tracking helpers ******** @@ -193,6 +211,8 @@ class CRM_AfformGui_Upgrader_Base { /** * Add any pending revisions to the queue. + * + * @param CRM_Queue_Queue $queue */ public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { $this->queue = $queue; @@ -200,23 +220,23 @@ class CRM_AfformGui_Upgrader_Base { $currentRevision = $this->getCurrentRevision(); foreach ($this->getRevisions() as $revision) { if ($revision > $currentRevision) { - $title = ts('Upgrade %1 to revision %2', array( + $title = E::ts('Upgrade %1 to revision %2', [ 1 => $this->extensionName, 2 => $revision, - )); + ]); // note: don't use addTask() because it sets weight=-1 $task = new CRM_Queue_Task( - array(get_class($this), '_queueAdapter'), - array('upgrade_' . $revision), + [get_class($this), '_queueAdapter'], + ['upgrade_' . $revision], $title ); $this->queue->createItem($task); $task = new CRM_Queue_Task( - array(get_class($this), '_queueAdapter'), - array('setCurrentRevision', $revision), + [get_class($this), '_queueAdapter'], + ['setCurrentRevision', $revision], $title ); $this->queue->createItem($task); @@ -227,11 +247,12 @@ class CRM_AfformGui_Upgrader_Base { /** * Get a list of revisions. * - * @return array(revisionNumbers) sorted numerically + * @return array + * revisionNumbers sorted numerically */ public function getRevisions() { if (!is_array($this->revisions)) { - $this->revisions = array(); + $this->revisions = []; $clazz = new ReflectionClass(get_class($this)); $methods = $clazz->getMethods(); @@ -256,7 +277,7 @@ class CRM_AfformGui_Upgrader_Base { private function getCurrentRevisionDeprecated() { $key = $this->extensionName . ':version'; - if ($revision = CRM_Core_BAO_Setting::getItem('Extension', $key)) { + if ($revision = \Civi::settings()->get($key)) { $this->revisionStorageIsDeprecated = TRUE; } return $revision; @@ -302,7 +323,7 @@ class CRM_AfformGui_Upgrader_Base { $this->executeCustomDataFileByAbsPath($file); } } - if (is_callable(array($this, 'install'))) { + if (is_callable([$this, 'install'])) { $this->install(); } } @@ -315,7 +336,7 @@ class CRM_AfformGui_Upgrader_Base { if (!empty($revisions)) { $this->setCurrentRevision(max($revisions)); } - if (is_callable(array($this, 'postInstall'))) { + if (is_callable([$this, 'postInstall'])) { $this->postInstall(); } } @@ -330,7 +351,7 @@ class CRM_AfformGui_Upgrader_Base { $this->executeSqlTemplate($file); } } - if (is_callable(array($this, 'uninstall'))) { + if (is_callable([$this, 'uninstall'])) { $this->uninstall(); } $files = glob($this->extensionDir . '/sql/*_uninstall.sql'); @@ -346,7 +367,7 @@ class CRM_AfformGui_Upgrader_Base { */ public function onEnable() { // stub for possible future use - if (is_callable(array($this, 'enable'))) { + if (is_callable([$this, 'enable'])) { $this->enable(); } } @@ -356,7 +377,7 @@ class CRM_AfformGui_Upgrader_Base { */ public function onDisable() { // stub for possible future use - if (is_callable(array($this, 'disable'))) { + if (is_callable([$this, 'disable'])) { $this->disable(); } } @@ -364,7 +385,7 @@ class CRM_AfformGui_Upgrader_Base { public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) { switch ($op) { case 'check': - return array($this->hasPendingRevisions()); + return [$this->hasPendingRevisions()]; case 'enqueue': return $this->enqueuePendingRevisions($queue); -- 2.25.1