From d2b131092ddc8584410702d5d3892dc7fe935900 Mon Sep 17 00:00:00 2001 From: Seamus Lee Date: Mon, 21 Dec 2020 09:01:51 +1100 Subject: [PATCH] Update Civix auto generated files --- CRM/Iats/Upgrader/Base.php | 94 +++++++++++++++++++++++--------------- iats.civix.php | 73 +++++++++++++++-------------- 2 files changed, 95 insertions(+), 72 deletions(-) diff --git a/CRM/Iats/Upgrader/Base.php b/CRM/Iats/Upgrader/Base.php index 956bcaf5..289598c0 100644 --- a/CRM/Iats/Upgrader/Base.php +++ b/CRM/Iats/Upgrader/Base.php @@ -9,9 +9,9 @@ class CRM_Iats_Upgrader_Base { /** - * @var varies, subclass of this + * @var CRM_Iats_Upgrader_Base */ - static $instance; + public static $instance; /** * @var CRM_Queue_TaskContext @@ -19,22 +19,25 @@ class CRM_Iats_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 array + * sorted numerically */ private $revisions; /** - * @var boolean + * @var bool * Flag to clean up extension revision data in civicrm_setting */ private $revisionStorageIsDeprecated = FALSE; @@ -42,12 +45,11 @@ class CRM_Iats_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_Iats_Upgrader( 'com.iatspayments.civicrm', - realpath(__DIR__ . '/../../../') + E::path() ); } return self::$instance; @@ -59,19 +61,25 @@ static public function instance() { * Note: Each upgrader instance should only be associated with one * task-context; otherwise, this will be non-reentrant. * - * @code + * ``` * CRM_Iats_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_Iats_Upgrader_Base constructor. + * + * @param $extensionName + * @param $extensionDir + */ public function __construct($extensionName, $extensionDir) { $this->extensionName = $extensionName; $this->extensionDir = $extensionDir; @@ -82,7 +90,8 @@ public function __construct($extensionName, $extensionDir) { /** * 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 +102,12 @@ public function executeCustomDataFile($relativePath) { /** * 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 +116,8 @@ protected static function executeCustomDataFileByAbsPath($xml_file) { /** * 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 +130,14 @@ public function executeSqlFile($relativePath) { } /** + * 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 +156,19 @@ public function executeSqlTemplate($tplFile) { * 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 +180,11 @@ public function addTask($title) { $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 +210,8 @@ public function hasPendingRevisions() { /** * Add any pending revisions to the queue. + * + * @param CRM_Queue_Queue $queue */ public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { $this->queue = $queue; @@ -200,23 +219,23 @@ public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { $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 +246,12 @@ public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { /** * 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 +276,7 @@ public function getCurrentRevision() { 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 +322,7 @@ public function onInstall() { $this->executeCustomDataFileByAbsPath($file); } } - if (is_callable(array($this, 'install'))) { + if (is_callable([$this, 'install'])) { $this->install(); } } @@ -315,7 +335,7 @@ public function onPostInstall() { if (!empty($revisions)) { $this->setCurrentRevision(max($revisions)); } - if (is_callable(array($this, 'postInstall'))) { + if (is_callable([$this, 'postInstall'])) { $this->postInstall(); } } @@ -330,7 +350,7 @@ public function onUninstall() { $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 +366,7 @@ public function onUninstall() { */ public function onEnable() { // stub for possible future use - if (is_callable(array($this, 'enable'))) { + if (is_callable([$this, 'enable'])) { $this->enable(); } } @@ -356,7 +376,7 @@ public function onEnable() { */ public function onDisable() { // stub for possible future use - if (is_callable(array($this, 'disable'))) { + if (is_callable([$this, 'disable'])) { $this->disable(); } } @@ -364,7 +384,7 @@ public function onDisable() { 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); diff --git a/iats.civix.php b/iats.civix.php index 3628541f..d6bc9551 100644 --- a/iats.civix.php +++ b/iats.civix.php @@ -7,9 +7,9 @@ * extension. */ class CRM_Iats_ExtensionUtil { - const SHORT_NAME = "iats"; - const LONG_NAME = "com.iatspayments.civicrm"; - const CLASS_PREFIX = "CRM_Iats"; + const SHORT_NAME = 'iats'; + const LONG_NAME = 'com.iatspayments.civicrm'; + const CLASS_PREFIX = 'CRM_Iats'; /** * Translate a string using the extension's domain. @@ -24,9 +24,9 @@ class CRM_Iats_ExtensionUtil { * Translated text. * @see ts */ - public static function ts($text, $params = array()) { + public static function ts($text, $params = []) { if (!array_key_exists('domain', $params)) { - $params['domain'] = array(self::LONG_NAME, NULL); + $params['domain'] = [self::LONG_NAME, NULL]; } return ts($text, $params); } @@ -100,7 +100,7 @@ function _iats_civix_civicrm_config(&$config = NULL) { array_unshift($template->template_dir, $extDir); } else { - $template->template_dir = array($extDir, $template->template_dir); + $template->template_dir = [$extDir, $template->template_dir]; } $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); @@ -140,7 +140,7 @@ function _iats_civix_civicrm_install() { function _iats_civix_civicrm_postInstall() { _iats_civix_civicrm_config(); if ($upgrader = _iats_civix_upgrader()) { - if (is_callable(array($upgrader, 'onPostInstall'))) { + if (is_callable([$upgrader, 'onPostInstall'])) { $upgrader->onPostInstall(); } } @@ -166,7 +166,7 @@ function _iats_civix_civicrm_uninstall() { function _iats_civix_civicrm_enable() { _iats_civix_civicrm_config(); if ($upgrader = _iats_civix_upgrader()) { - if (is_callable(array($upgrader, 'onEnable'))) { + if (is_callable([$upgrader, 'onEnable'])) { $upgrader->onEnable(); } } @@ -181,7 +181,7 @@ function _iats_civix_civicrm_enable() { function _iats_civix_civicrm_disable() { _iats_civix_civicrm_config(); if ($upgrader = _iats_civix_upgrader()) { - if (is_callable(array($upgrader, 'onDisable'))) { + if (is_callable([$upgrader, 'onDisable'])) { $upgrader->onDisable(); } } @@ -193,8 +193,9 @@ function _iats_civix_civicrm_disable() { * @param $op string, the type of operation being performed; 'check' or 'enqueue' * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks * - * @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) - * for 'enqueue', returns void + * @return mixed + * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) + * for 'enqueue', returns void * * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade */ @@ -217,22 +218,23 @@ function _iats_civix_upgrader() { } /** - * Search directory tree for files which match a glob pattern + * Search directory tree for files which match a glob pattern. * * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() * - * @param $dir string, base dir - * @param $pattern string, glob pattern, eg "*.txt" - * @return array(string) + * @param string $dir base dir + * @param string $pattern , glob pattern, eg "*.txt" + * + * @return array */ function _iats_civix_find_files($dir, $pattern) { - if (is_callable(array('CRM_Utils_File', 'findFiles'))) { + if (is_callable(['CRM_Utils_File', 'findFiles'])) { return CRM_Utils_File::findFiles($dir, $pattern); } - $todos = array($dir); - $result = array(); + $todos = [$dir]; + $result = []; while (!empty($todos)) { $subdir = array_shift($todos); foreach (_iats_civix_glob("$subdir/$pattern") as $match) { @@ -243,7 +245,7 @@ function _iats_civix_find_files($dir, $pattern) { if ($dh = opendir($subdir)) { while (FALSE !== ($entry = readdir($dh))) { $path = $subdir . DIRECTORY_SEPARATOR . $entry; - if ($entry{0} == '.') { + if ($entry[0] == '.') { } elseif (is_dir($path)) { $todos[] = $path; @@ -254,6 +256,7 @@ function _iats_civix_find_files($dir, $pattern) { } return $result; } + /** * (Delegated) Implements hook_civicrm_managed(). * @@ -296,14 +299,13 @@ function _iats_civix_civicrm_caseTypes(&$caseTypes) { $name = preg_replace('/\.xml$/', '', basename($file)); if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name)); - CRM_Core_Error::fatal($errorMessage); - // throw new CRM_Core_Exception($errorMessage); + throw new CRM_Core_Exception($errorMessage); } - $caseTypes[$name] = array( + $caseTypes[$name] = [ 'module' => E::LONG_NAME, 'name' => $name, 'file' => $file, - ); + ]; } } @@ -361,11 +363,12 @@ function _iats_civix_civicrm_themes(&$themes) { * * @link http://php.net/glob * @param string $pattern - * @return array, possibly empty + * + * @return array */ function _iats_civix_glob($pattern) { $result = glob($pattern); - return is_array($result) ? $result : array(); + return is_array($result) ? $result : []; } /** @@ -376,16 +379,18 @@ function _iats_civix_glob($pattern) { * 'Mailing', or 'Administer/System Settings' * @param array $item - the item to insert (parent/child attributes will be * filled for you) + * + * @return bool */ function _iats_civix_insert_navigation_menu(&$menu, $path, $item) { // If we are done going down the path, insert menu if (empty($path)) { - $menu[] = array( - 'attributes' => array_merge(array( + $menu[] = [ + 'attributes' => array_merge([ 'label' => CRM_Utils_Array::value('name', $item), 'active' => 1, - ), $item), - ); + ], $item), + ]; return TRUE; } else { @@ -396,9 +401,9 @@ function _iats_civix_insert_navigation_menu(&$menu, $path, $item) { foreach ($menu as $key => &$entry) { if ($entry['attributes']['name'] == $first) { if (!isset($entry['child'])) { - $entry['child'] = array(); + $entry['child'] = []; } - $found = _iats_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + $found = _iats_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); } } return $found; @@ -409,7 +414,7 @@ function _iats_civix_insert_navigation_menu(&$menu, $path, $item) { * (Delegated) Implements hook_civicrm_navigationMenu(). */ function _iats_civix_navigationMenu(&$nodes) { - if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { + if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { _iats_civix_fixNavigationMenu($nodes); } } @@ -467,8 +472,6 @@ function _iats_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { * * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes */ - function _iats_civix_civicrm_entityTypes(&$entityTypes) { - $entityTypes = array_merge($entityTypes, array ( - )); + $entityTypes = array_merge($entityTypes, []); }