From 18f208404d560c0210804daf5b87b09759da4bc0 Mon Sep 17 00:00:00 2001
From: Muhammad Shahrukh <>
Date: Mon, 29 Jul 2024 12:47:07 +0500
Subject: [PATCH 1/2] COMCL-635: Upgrade civix
---
CRM/ManageLetterheads/Upgrader.php | 2 +-
CRM/ManageLetterheads/Upgrader/Base.php | 376 ------------------------
info.xml | 14 +-
manageletterheads.civix.php | 315 +-------------------
manageletterheads.php | 104 -------
mixin/entity-types-php@1.0.0.mixin.php | 36 +++
mixin/smarty-v2@1.0.1.mixin.php | 51 ++++
phpunit.xml.dist | 2 +-
tests/phpunit/BaseHeadlessTest.php | 3 +-
9 files changed, 116 insertions(+), 787 deletions(-)
delete mode 100644 CRM/ManageLetterheads/Upgrader/Base.php
create mode 100644 mixin/entity-types-php@1.0.0.mixin.php
create mode 100644 mixin/smarty-v2@1.0.1.mixin.php
diff --git a/CRM/ManageLetterheads/Upgrader.php b/CRM/ManageLetterheads/Upgrader.php
index e996903..a0ba166 100644
--- a/CRM/ManageLetterheads/Upgrader.php
+++ b/CRM/ManageLetterheads/Upgrader.php
@@ -6,7 +6,7 @@
/**
* Collection of upgrade steps.
*/
-class CRM_ManageLetterheads_Upgrader extends CRM_ManageLetterheads_Upgrader_Base {
+class CRM_ManageLetterheads_Upgrader extends CRM_Extension_Upgrader_Base {
/**
* A list of directories to be scanned for XML installation files
diff --git a/CRM/ManageLetterheads/Upgrader/Base.php b/CRM/ManageLetterheads/Upgrader/Base.php
deleted file mode 100644
index a999c41..0000000
--- a/CRM/ManageLetterheads/Upgrader/Base.php
+++ /dev/null
@@ -1,376 +0,0 @@
-ctx = array_shift($args);
- $instance->queue = $instance->ctx->queue;
- $method = array_shift($args);
- return call_user_func_array(array($instance, $method), $args);
- }
-
- public function __construct($extensionName, $extensionDir) {
- $this->extensionName = $extensionName;
- $this->extensionDir = $extensionDir;
- }
-
- // ******** Task helpers ********
-
- /**
- * Run a CustomData file.
- *
- * @param string $relativePath the CustomData XML file path (relative to this extension's dir)
- * @return bool
- */
- public function executeCustomDataFile($relativePath) {
- $xml_file = $this->extensionDir . '/' . $relativePath;
- return $this->executeCustomDataFileByAbsPath($xml_file);
- }
-
- /**
- * Run a CustomData file
- *
- * @param string $xml_file the CustomData XML file path (absolute path)
- *
- * @return bool
- */
- protected static function executeCustomDataFileByAbsPath($xml_file) {
- $import = new CRM_Utils_Migrate_Import();
- $import->run($xml_file);
- return TRUE;
- }
-
- /**
- * Run a SQL file.
- *
- * @param string $relativePath the SQL file path (relative to this extension's dir)
- *
- * @return bool
- */
- public function executeSqlFile($relativePath) {
- CRM_Utils_File::sourceSQLFile(
- CIVICRM_DSN,
- $this->extensionDir . DIRECTORY_SEPARATOR . $relativePath
- );
- return TRUE;
- }
-
- /**
- * @param string $tplFile
- * The SQL file path (relative to this extension's dir).
- * Ex: "sql/mydata.mysql.tpl".
- * @return bool
- */
- public function executeSqlTemplate($tplFile) {
- // Assign multilingual variable to Smarty.
- $upgrade = new CRM_Upgrade_Form();
-
- $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile;
- $smarty = CRM_Core_Smarty::singleton();
- $smarty->assign('domainID', CRM_Core_Config::domainID());
- CRM_Utils_File::sourceSQLFile(
- CIVICRM_DSN, $smarty->fetch($tplFile), NULL, TRUE
- );
- return TRUE;
- }
-
- /**
- * Run one SQL query.
- *
- * This is just a wrapper for CRM_Core_DAO::executeSql, but it
- * provides syntatic sugar for queueing several tasks that
- * run different queries
- */
- public function executeSql($query, $params = array()) {
- // 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.
- *
- * The task is weighted so that it is processed
- * as part of the currently-pending revision.
- *
- * After passing the $funcName, you can also pass parameters that will go to
- * the function. Note that all params must be serializable.
- */
- public function addTask($title) {
- $args = func_get_args();
- $title = array_shift($args);
- $task = new CRM_Queue_Task(
- array(get_class($this), '_queueAdapter'),
- $args,
- $title
- );
- return $this->queue->createItem($task, array('weight' => -1));
- }
-
- // ******** Revision-tracking helpers ********
-
- /**
- * Determine if there are any pending revisions.
- *
- * @return bool
- */
- public function hasPendingRevisions() {
- $revisions = $this->getRevisions();
- $currentRevision = $this->getCurrentRevision();
-
- if (empty($revisions)) {
- return FALSE;
- }
- if (empty($currentRevision)) {
- return TRUE;
- }
-
- return ($currentRevision < max($revisions));
- }
-
- /**
- * Add any pending revisions to the queue.
- */
- public function enqueuePendingRevisions(CRM_Queue_Queue $queue) {
- $this->queue = $queue;
-
- $currentRevision = $this->getCurrentRevision();
- foreach ($this->getRevisions() as $revision) {
- if ($revision > $currentRevision) {
- $title = ts('Upgrade %1 to revision %2', array(
- 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),
- $title
- );
- $this->queue->createItem($task);
-
- $task = new CRM_Queue_Task(
- array(get_class($this), '_queueAdapter'),
- array('setCurrentRevision', $revision),
- $title
- );
- $this->queue->createItem($task);
- }
- }
- }
-
- /**
- * Get a list of revisions.
- *
- * @return array(revisionNumbers) sorted numerically
- */
- public function getRevisions() {
- if (!is_array($this->revisions)) {
- $this->revisions = array();
-
- $clazz = new ReflectionClass(get_class($this));
- $methods = $clazz->getMethods();
- foreach ($methods as $method) {
- if (preg_match('/^upgrade_(.*)/', $method->name, $matches)) {
- $this->revisions[] = $matches[1];
- }
- }
- sort($this->revisions, SORT_NUMERIC);
- }
-
- return $this->revisions;
- }
-
- public function getCurrentRevision() {
- $revision = CRM_Core_BAO_Extension::getSchemaVersion($this->extensionName);
- if (!$revision) {
- $revision = $this->getCurrentRevisionDeprecated();
- }
- return $revision;
- }
-
- private function getCurrentRevisionDeprecated() {
- $key = $this->extensionName . ':version';
- if ($revision = CRM_Core_BAO_Setting::getItem('Extension', $key)) {
- $this->revisionStorageIsDeprecated = TRUE;
- }
- return $revision;
- }
-
- public function setCurrentRevision($revision) {
- CRM_Core_BAO_Extension::setSchemaVersion($this->extensionName, $revision);
- // clean up legacy schema version store (CRM-19252)
- $this->deleteDeprecatedRevision();
- return TRUE;
- }
-
- private function deleteDeprecatedRevision() {
- if ($this->revisionStorageIsDeprecated) {
- $setting = new CRM_Core_BAO_Setting();
- $setting->name = $this->extensionName . ':version';
- $setting->delete();
- CRM_Core_Error::debug_log_message("Migrated extension schema revision ID for {$this->extensionName} from civicrm_setting (deprecated) to civicrm_extension.\n");
- }
- }
-
- // ******** Hook delegates ********
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
- */
- public function onInstall() {
- $files = glob($this->extensionDir . '/sql/*_install.sql');
- if (is_array($files)) {
- foreach ($files as $file) {
- CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
- }
- }
- $files = glob($this->extensionDir . '/sql/*_install.mysql.tpl');
- if (is_array($files)) {
- foreach ($files as $file) {
- $this->executeSqlTemplate($file);
- }
- }
- $files = glob($this->extensionDir . '/xml/*_install.xml');
- if (is_array($files)) {
- foreach ($files as $file) {
- $this->executeCustomDataFileByAbsPath($file);
- }
- }
- if (is_callable(array($this, 'install'))) {
- $this->install();
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
- */
- public function onPostInstall() {
- $revisions = $this->getRevisions();
- if (!empty($revisions)) {
- $this->setCurrentRevision(max($revisions));
- }
- if (is_callable(array($this, 'postInstall'))) {
- $this->postInstall();
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
- */
- public function onUninstall() {
- $files = glob($this->extensionDir . '/sql/*_uninstall.mysql.tpl');
- if (is_array($files)) {
- foreach ($files as $file) {
- $this->executeSqlTemplate($file);
- }
- }
- if (is_callable(array($this, 'uninstall'))) {
- $this->uninstall();
- }
- $files = glob($this->extensionDir . '/sql/*_uninstall.sql');
- if (is_array($files)) {
- foreach ($files as $file) {
- CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
- }
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
- */
- public function onEnable() {
- // stub for possible future use
- if (is_callable(array($this, 'enable'))) {
- $this->enable();
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
- */
- public function onDisable() {
- // stub for possible future use
- if (is_callable(array($this, 'disable'))) {
- $this->disable();
- }
- }
-
- public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) {
- switch ($op) {
- case 'check':
- return array($this->hasPendingRevisions());
-
- case 'enqueue':
- return $this->enqueuePendingRevisions($queue);
-
- default:
- }
- }
-
-}
diff --git a/info.xml b/info.xml
index c26a959..740dc1c 100644
--- a/info.xml
+++ b/info.xml
@@ -17,11 +17,21 @@
2.0.0
stable
- 5.0
+ 5.45
ManageLetterheads
CRM/ManageLetterheads
+ 23.02.1
+
+ menu-xml@1.0.0
+ smarty-v2@1.0.1
+ entity-types-php@1.0.0
+
+
+
+
+
+ CRM_ManageLetterheads_Upgrader
-
diff --git a/manageletterheads.civix.php b/manageletterheads.civix.php
index 4506e5e..562be28 100644
--- a/manageletterheads.civix.php
+++ b/manageletterheads.civix.php
@@ -7,9 +7,9 @@
* extension.
*/
class CRM_ManageLetterheads_ExtensionUtil {
- const SHORT_NAME = "manageletterheads";
- const LONG_NAME = "uk.co.compucorp.manageletterheads";
- const CLASS_PREFIX = "CRM_ManageLetterheads";
+ const SHORT_NAME = 'manageletterheads';
+ const LONG_NAME = 'uk.co.compucorp.manageletterheads';
+ const CLASS_PREFIX = 'CRM_ManageLetterheads';
/**
* Translate a string using the extension's domain.
@@ -24,7 +24,7 @@ class CRM_ManageLetterheads_ExtensionUtil {
* Translated text.
* @see ts
*/
- public static function ts($text, $params = []) {
+ public static function ts($text, $params = []): string {
if (!array_key_exists('domain', $params)) {
$params['domain'] = [self::LONG_NAME, NULL];
}
@@ -41,7 +41,7 @@ public static function ts($text, $params = []) {
* Ex: 'http://example.org/sites/default/ext/org.example.foo'.
* Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
*/
- public static function url($file = NULL) {
+ public static function url($file = NULL): string {
if ($file === NULL) {
return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
}
@@ -84,40 +84,17 @@ public static function findClass($suffix) {
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
*/
-function _manageletterheads_civix_civicrm_config(&$config = NULL) {
+function _manageletterheads_civix_civicrm_config($config = NULL) {
static $configured = FALSE;
if ($configured) {
return;
}
$configured = TRUE;
- $template =& CRM_Core_Smarty::singleton();
-
- $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
- $extDir = $extRoot . 'templates';
-
- if (is_array($template->template_dir)) {
- array_unshift($template->template_dir, $extDir);
- }
- else {
- $template->template_dir = [$extDir, $template->template_dir];
- }
-
+ $extRoot = __DIR__ . DIRECTORY_SEPARATOR;
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
set_include_path($include_path);
-}
-
-/**
- * (Delegated) Implements hook_civicrm_xmlMenu().
- *
- * @param $files array(string)
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
- */
-function _manageletterheads_civix_civicrm_xmlMenu(&$files) {
- foreach (_manageletterheads_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
- $files[] = $file;
- }
+ // Based on , this does not currently require mixin/polyfill.php.
}
/**
@@ -127,35 +104,7 @@ function _manageletterheads_civix_civicrm_xmlMenu(&$files) {
*/
function _manageletterheads_civix_civicrm_install() {
_manageletterheads_civix_civicrm_config();
- if ($upgrader = _manageletterheads_civix_upgrader()) {
- $upgrader->onInstall();
- }
-}
-
-/**
- * Implements hook_civicrm_postInstall().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
- */
-function _manageletterheads_civix_civicrm_postInstall() {
- _manageletterheads_civix_civicrm_config();
- if ($upgrader = _manageletterheads_civix_upgrader()) {
- if (is_callable([$upgrader, 'onPostInstall'])) {
- $upgrader->onPostInstall();
- }
- }
-}
-
-/**
- * Implements hook_civicrm_uninstall().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
- */
-function _manageletterheads_civix_civicrm_uninstall() {
- _manageletterheads_civix_civicrm_config();
- if ($upgrader = _manageletterheads_civix_upgrader()) {
- $upgrader->onUninstall();
- }
+ // Based on , this does not currently require mixin/polyfill.php.
}
/**
@@ -163,210 +112,9 @@ function _manageletterheads_civix_civicrm_uninstall() {
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
*/
-function _manageletterheads_civix_civicrm_enable() {
- _manageletterheads_civix_civicrm_config();
- if ($upgrader = _manageletterheads_civix_upgrader()) {
- if (is_callable([$upgrader, 'onEnable'])) {
- $upgrader->onEnable();
- }
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_disable().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
- * @return mixed
- */
-function _manageletterheads_civix_civicrm_disable() {
+function _manageletterheads_civix_civicrm_enable(): void {
_manageletterheads_civix_civicrm_config();
- if ($upgrader = _manageletterheads_civix_upgrader()) {
- if (is_callable([$upgrader, 'onDisable'])) {
- $upgrader->onDisable();
- }
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_upgrade().
- *
- * @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
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
- */
-function _manageletterheads_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
- if ($upgrader = _manageletterheads_civix_upgrader()) {
- return $upgrader->onUpgrade($op, $queue);
- }
-}
-
-/**
- * @return CRM_ManageLetterheads_Upgrader
- */
-function _manageletterheads_civix_upgrader() {
- if (!file_exists(__DIR__ . '/CRM/ManageLetterheads/Upgrader.php')) {
- return NULL;
- }
- else {
- return CRM_ManageLetterheads_Upgrader_Base::instance();
- }
-}
-
-/**
- * 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 string $dir base dir
- * @param string $pattern , glob pattern, eg "*.txt"
- *
- * @return array(string)
- */
-function _manageletterheads_civix_find_files($dir, $pattern) {
- if (is_callable(['CRM_Utils_File', 'findFiles'])) {
- return CRM_Utils_File::findFiles($dir, $pattern);
- }
-
- $todos = [$dir];
- $result = [];
- while (!empty($todos)) {
- $subdir = array_shift($todos);
- foreach (_manageletterheads_civix_glob("$subdir/$pattern") as $match) {
- if (!is_dir($match)) {
- $result[] = $match;
- }
- }
- if ($dh = opendir($subdir)) {
- while (FALSE !== ($entry = readdir($dh))) {
- $path = $subdir . DIRECTORY_SEPARATOR . $entry;
- if ($entry[0] == '.') {
- }
- elseif (is_dir($path)) {
- $todos[] = $path;
- }
- }
- closedir($dh);
- }
- }
- return $result;
-}
-/**
- * (Delegated) Implements hook_civicrm_managed().
- *
- * Find any *.mgd.php files, merge their content, and return.
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
- */
-function _manageletterheads_civix_civicrm_managed(&$entities) {
- $mgdFiles = _manageletterheads_civix_find_files(__DIR__, '*.mgd.php');
- sort($mgdFiles);
- foreach ($mgdFiles as $file) {
- $es = include $file;
- foreach ($es as $e) {
- if (empty($e['module'])) {
- $e['module'] = E::LONG_NAME;
- }
- if (empty($e['params']['version'])) {
- $e['params']['version'] = '3';
- }
- $entities[] = $e;
- }
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_caseTypes().
- *
- * Find any and return any files matching "xml/case/*.xml"
- *
- * Note: This hook only runs in CiviCRM 4.4+.
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
- */
-function _manageletterheads_civix_civicrm_caseTypes(&$caseTypes) {
- if (!is_dir(__DIR__ . '/xml/case')) {
- return;
- }
-
- foreach (_manageletterheads_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
- $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));
- throw new CRM_Core_Exception($errorMessage);
- }
- $caseTypes[$name] = [
- 'module' => E::LONG_NAME,
- 'name' => $name,
- 'file' => $file,
- ];
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_angularModules().
- *
- * Find any and return any files matching "ang/*.ang.php"
- *
- * Note: This hook only runs in CiviCRM 4.5+.
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
- */
-function _manageletterheads_civix_civicrm_angularModules(&$angularModules) {
- if (!is_dir(__DIR__ . '/ang')) {
- return;
- }
-
- $files = _manageletterheads_civix_glob(__DIR__ . '/ang/*.ang.php');
- foreach ($files as $file) {
- $name = preg_replace(':\.ang\.php$:', '', basename($file));
- $module = include $file;
- if (empty($module['ext'])) {
- $module['ext'] = E::LONG_NAME;
- }
- $angularModules[$name] = $module;
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_themes().
- *
- * Find any and return any files matching "*.theme.php"
- */
-function _manageletterheads_civix_civicrm_themes(&$themes) {
- $files = _manageletterheads_civix_glob(__DIR__ . '/*.theme.php');
- foreach ($files as $file) {
- $themeMeta = include $file;
- if (empty($themeMeta['name'])) {
- $themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
- }
- if (empty($themeMeta['ext'])) {
- $themeMeta['ext'] = E::LONG_NAME;
- }
- $themes[$themeMeta['name']] = $themeMeta;
- }
-}
-
-/**
- * Glob wrapper which is guaranteed to return an array.
- *
- * The documentation for glob() says, "On some systems it is impossible to
- * distinguish between empty match and an error." Anecdotally, the return
- * result for an empty match is sometimes array() and sometimes FALSE.
- * This wrapper provides consistency.
- *
- * @link http://php.net/glob
- * @param string $pattern
- *
- * @return array, possibly empty
- */
-function _manageletterheads_civix_glob($pattern) {
- $result = glob($pattern);
- return is_array($result) ? $result : [];
+ // Based on , this does not currently require mixin/polyfill.php.
}
/**
@@ -385,8 +133,8 @@ function _manageletterheads_civix_insert_navigation_menu(&$menu, $path, $item) {
if (empty($path)) {
$menu[] = [
'attributes' => array_merge([
- 'label' => CRM_Utils_Array::value('name', $item),
- 'active' => 1,
+ 'label' => $item['name'] ?? NULL,
+ 'active' => 1,
], $item),
];
return TRUE;
@@ -450,40 +198,3 @@ function _manageletterheads_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $p
}
}
}
-
-/**
- * (Delegated) Implements hook_civicrm_alterSettingsFolders().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
- */
-function _manageletterheads_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
- $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
- if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
- $metaDataFolders[] = $settingsDir;
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_entityTypes().
- *
- * Find any *.entityType.php files, merge their content, and return.
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
- */
-
-function _manageletterheads_civix_civicrm_entityTypes(&$entityTypes) {
- $entityTypes = array_merge($entityTypes, array (
- 'CRM_ManageLetterheads_DAO_Letterhead' =>
- array (
- 'name' => 'Letterhead',
- 'class' => 'CRM_ManageLetterheads_DAO_Letterhead',
- 'table' => 'civicrm_manageletterheads_letterhead',
- ),
- 'CRM_ManageLetterheads_DAO_LetterheadAvailability' =>
- array (
- 'name' => 'LetterheadAvailability',
- 'class' => 'CRM_ManageLetterheads_DAO_LetterheadAvailability',
- 'table' => 'civicrm_manageletterheads_letterhead_availability',
- ),
- ));
-}
diff --git a/manageletterheads.php b/manageletterheads.php
index c5fe8f7..ad441f8 100644
--- a/manageletterheads.php
+++ b/manageletterheads.php
@@ -20,15 +20,6 @@ function manageletterheads_civicrm_config(&$config) {
);
}
-/**
- * Implements hook_civicrm_xmlMenu().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
- */
-function manageletterheads_civicrm_xmlMenu(&$files) {
- _manageletterheads_civix_civicrm_xmlMenu($files);
-}
-
/**
* Implements hook_civicrm_install().
*
@@ -38,24 +29,6 @@ function manageletterheads_civicrm_install() {
_manageletterheads_civix_civicrm_install();
}
-/**
- * Implements hook_civicrm_postInstall().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
- */
-function manageletterheads_civicrm_postInstall() {
- _manageletterheads_civix_civicrm_postInstall();
-}
-
-/**
- * Implements hook_civicrm_uninstall().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
- */
-function manageletterheads_civicrm_uninstall() {
- _manageletterheads_civix_civicrm_uninstall();
-}
-
/**
* Implements hook_civicrm_enable().
*
@@ -65,83 +38,6 @@ function manageletterheads_civicrm_enable() {
_manageletterheads_civix_civicrm_enable();
}
-/**
- * Implements hook_civicrm_disable().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
- */
-function manageletterheads_civicrm_disable() {
- _manageletterheads_civix_civicrm_disable();
-}
-
-/**
- * Implements hook_civicrm_upgrade().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
- */
-function manageletterheads_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
- return _manageletterheads_civix_civicrm_upgrade($op, $queue);
-}
-
-/**
- * Implements hook_civicrm_managed().
- *
- * Generate a list of entities to create/deactivate/delete when this module
- * is installed, disabled, uninstalled.
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
- */
-function manageletterheads_civicrm_managed(&$entities) {
- _manageletterheads_civix_civicrm_managed($entities);
-}
-
-/**
- * Implements hook_civicrm_caseTypes().
- *
- * Generate a list of case-types.
- *
- * Note: This hook only runs in CiviCRM 4.4+.
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
- */
-function manageletterheads_civicrm_caseTypes(&$caseTypes) {
- _manageletterheads_civix_civicrm_caseTypes($caseTypes);
-}
-
-/**
- * Implements hook_civicrm_angularModules().
- *
- * Generate a list of Angular modules.
- *
- * Note: This hook only runs in CiviCRM 4.5+. It may
- * use features only available in v4.6+.
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules
- */
-function manageletterheads_civicrm_angularModules(&$angularModules) {
- _manageletterheads_civix_civicrm_angularModules($angularModules);
-}
-
-/**
- * Implements hook_civicrm_alterSettingsFolders().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
- */
-function manageletterheads_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
- _manageletterheads_civix_civicrm_alterSettingsFolders($metaDataFolders);
-}
-
-/**
- * Implements hook_civicrm_entityTypes().
- *
- * Declare entity types provided by this module.
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes
- */
-function manageletterheads_civicrm_entityTypes(&$entityTypes) {
- _manageletterheads_civix_civicrm_entityTypes($entityTypes);
-}
-
/**
* Implements hook_civicrm_permission().
*/
diff --git a/mixin/entity-types-php@1.0.0.mixin.php b/mixin/entity-types-php@1.0.0.mixin.php
new file mode 100644
index 0000000..8ec4203
--- /dev/null
+++ b/mixin/entity-types-php@1.0.0.mixin.php
@@ -0,0 +1,36 @@
+addListener('hook_civicrm_entityTypes', function ($e) use ($mixInfo) {
+ // When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically.
+ if (!$mixInfo->isActive() || !is_dir($mixInfo->getPath('xml/schema/CRM'))) {
+ return;
+ }
+
+ $files = (array) glob($mixInfo->getPath('xml/schema/CRM/*/*.entityType.php'));
+ foreach ($files as $file) {
+ $entities = include $file;
+ foreach ($entities as $entity) {
+ $e->entityTypes[$entity['class']] = $entity;
+ }
+ }
+ });
+
+};
diff --git a/mixin/smarty-v2@1.0.1.mixin.php b/mixin/smarty-v2@1.0.1.mixin.php
new file mode 100644
index 0000000..5972dbd
--- /dev/null
+++ b/mixin/smarty-v2@1.0.1.mixin.php
@@ -0,0 +1,51 @@
+getPath('templates');
+ if (!file_exists($dir)) {
+ return;
+ }
+
+ $register = function() use ($dir) {
+ // This implementation has a theoretical edge-case bug on older versions of CiviCRM where a template could
+ // be registered more than once.
+ CRM_Core_Smarty::singleton()->addTemplateDir($dir);
+ };
+
+ // Let's figure out what environment we're in -- so that we know the best way to call $register().
+
+ if (!empty($GLOBALS['_CIVIX_MIXIN_POLYFILL'])) {
+ // Polyfill Loader (v<=5.45): We're already in the middle of firing `hook_config`.
+ if ($mixInfo->isActive()) {
+ $register();
+ }
+ return;
+ }
+
+ if (CRM_Extension_System::singleton()->getManager()->extensionIsBeingInstalledOrEnabled($mixInfo->longName)) {
+ // New Install, Standard Loader: The extension has just been enabled, and we're now setting it up.
+ // System has already booted. New templates may be needed for upcoming installation steps.
+ $register();
+ return;
+ }
+
+ // Typical Pageview, Standard Loader: Defer the actual registration for a moment -- to ensure that Smarty is online.
+ \Civi::dispatcher()->addListener('hook_civicrm_config', function() use ($mixInfo, $register) {
+ if ($mixInfo->isActive()) {
+ $register();
+ }
+ });
+
+};
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
index 0f9f25d..fc8f870 100644
--- a/phpunit.xml.dist
+++ b/phpunit.xml.dist
@@ -1,5 +1,5 @@
-
+
./tests/phpunit
diff --git a/tests/phpunit/BaseHeadlessTest.php b/tests/phpunit/BaseHeadlessTest.php
index deadb3b..566cac3 100644
--- a/tests/phpunit/BaseHeadlessTest.php
+++ b/tests/phpunit/BaseHeadlessTest.php
@@ -2,8 +2,9 @@
use Civi\Test\HeadlessInterface;
use Civi\Test\TransactionalInterface;
+use PHPUnit\Framework\TestCase;
-abstract class BaseHeadlessTest extends PHPUnit_Framework_TestCase implements HeadlessInterface, TransactionalInterface {
+abstract class BaseHeadlessTest extends TestCase implements HeadlessInterface, TransactionalInterface {
public function setUpHeadless() {
return \Civi\Test::headless()
From 0b7cc8aa6cd466f84e4ee791c3a91bf631342bd2 Mon Sep 17 00:00:00 2001
From: Muhammad Shahrukh <>
Date: Mon, 29 Jul 2024 14:58:07 +0500
Subject: [PATCH 2/2] COMCL-635: Fix tests
---
.github/workflows/unit-test.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
index acc8348..37851af 100644
--- a/.github/workflows/unit-test.yml
+++ b/.github/workflows/unit-test.yml
@@ -6,7 +6,7 @@ jobs:
run-unit-tests:
runs-on: ubuntu-latest
- container: compucorp/civicrm-buildkit:1.3.0-php8.0-chrome
+ container: compucorp/civicrm-buildkit:1.3.1-php8.0-chrome
env:
CIVICRM_EXTENSIONS_DIR: site/web/sites/all/modules/civicrm/tools/extensions