bij1
/
crm-bij1migratie
19
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

civix upgrade: 22.10.0
ci/woodpecker/push/woodpecker Pipeline failed Details

This commit is contained in:
Kiara Grouwstra 2022-11-14 22:09:17 +01:00
parent 70c9a71fbf
commit 95c9b480b8
6 changed files with 156 additions and 227 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -17,6 +17,7 @@ The extension is licensed under [AGPL-3.0](LICENSE.txt).
* PHP v7.2+
* CiviCRM (tested: 5.48.0)
* [CiviCRM CLI](https://github.com/civicrm/cv)
* [CiviCRM Extension CLI](https://github.com/totten/civix/)
* [PHPUnit](https://phpunit.de/)
* [PHPStan](https://phpstan.org/)
* CiviCRM extensions:

179
bij1migratie.civix.php
View File

@ -24,7 +24,7 @@ class CRM_Bij1migratie_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 @@ class CRM_Bij1migratie_ExtensionUtil {
* 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), '/');
}
@ -79,6 +79,13 @@ class CRM_Bij1migratie_ExtensionUtil {
use CRM_Bij1migratie_ExtensionUtil as E;
function _bij1migratie_civix_mixin_polyfill() {
if (!class_exists('CRM_Extension_MixInfo')) {
$polyfill = __DIR__ . '/mixin/polyfill.php';
(require $polyfill)(E::LONG_NAME, E::SHORT_NAME, E::path());
}
}
/**
* (Delegated) Implements hook_civicrm_config().
*
@ -91,9 +98,9 @@ function _bij1migratie_civix_civicrm_config(&$config = NULL) {
}
$configured = TRUE;
$template =& CRM_Core_Smarty::singleton();
$template = CRM_Core_Smarty::singleton();
$extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
$extRoot = __DIR__ . DIRECTORY_SEPARATOR;
$extDir = $extRoot . 'templates';
if (is_array($template->template_dir)) {
@ -105,19 +112,7 @@ function _bij1migratie_civix_civicrm_config(&$config = NULL) {
$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 _bij1migratie_civix_civicrm_xmlMenu(&$files) {
foreach (_bij1migratie_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
$files[] = $file;
}
_bij1migratie_civix_mixin_polyfill();
}
/**
@ -130,6 +125,7 @@ function _bij1migratie_civix_civicrm_install() {
if ($upgrader = _bij1migratie_civix_upgrader()) {
$upgrader->onInstall();
}
_bij1migratie_civix_mixin_polyfill();
}
/**
@ -151,7 +147,7 @@ function _bij1migratie_civix_civicrm_postInstall() {
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
*/
function _bij1migratie_civix_civicrm_uninstall() {
function _bij1migratie_civix_civicrm_uninstall(): void {
_bij1migratie_civix_civicrm_config();
if ($upgrader = _bij1migratie_civix_upgrader()) {
$upgrader->onUninstall();
@ -163,13 +159,14 @@ function _bij1migratie_civix_civicrm_uninstall() {
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
*/
function _bij1migratie_civix_civicrm_enable() {
function _bij1migratie_civix_civicrm_enable(): void {
_bij1migratie_civix_civicrm_config();
if ($upgrader = _bij1migratie_civix_upgrader()) {
if (is_callable([$upgrader, 'onEnable'])) {
$upgrader->onEnable();
}
}
_bij1migratie_civix_mixin_polyfill();
}
/**
@ -178,7 +175,7 @@ function _bij1migratie_civix_civicrm_enable() {
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
* @return mixed
*/
function _bij1migratie_civix_civicrm_disable() {
function _bij1migratie_civix_civicrm_disable(): void {
_bij1migratie_civix_civicrm_config();
if ($upgrader = _bij1migratie_civix_upgrader()) {
if (is_callable([$upgrader, 'onDisable'])) {
@ -217,136 +214,6 @@ function _bij1migratie_civix_upgrader() {
}
}
/**
* Search directory tree for files which match a glob pattern.
*
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
* Note: Delegate to CRM_Utils_File::findFiles(), this function kept only
* for backward compatibility of extension code that uses it.
*
* @param string $dir base dir
* @param string $pattern , glob pattern, eg "*.txt"
*
* @return array
*/
function _bij1migratie_civix_find_files($dir, $pattern) {
return CRM_Utils_File::findFiles($dir, $pattern);
}
/**
* (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 _bij1migratie_civix_civicrm_managed(&$entities) {
$mgdFiles = _bij1migratie_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 _bij1migratie_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) {
return;
}
foreach (_bij1migratie_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 _bij1migratie_civix_civicrm_angularModules(&$angularModules) {
if (!is_dir(__DIR__ . '/ang')) {
return;
}
$files = _bij1migratie_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 _bij1migratie_civix_civicrm_themes(&$themes) {
$files = _bij1migratie_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
*/
function _bij1migratie_civix_glob($pattern) {
$result = glob($pattern);
return is_array($result) ? $result : [];
}
/**
* Inserts a navigation menu item at a given place in the hierarchy.
*
@ -429,18 +296,6 @@ function _bij1migratie_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parent
}
}
/**
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
*/
function _bij1migratie_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().
*

64
bij1migratie.php
View File

@ -41,15 +41,6 @@ function bij1migratie_civicrm_config(&$config) {
_bij1migratie_civix_civicrm_config($config);
}
/**
* Implements hook_civicrm_xmlMenu().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
*/
function bij1migratie_civicrm_xmlMenu(&$files) {
_bij1migratie_civix_civicrm_xmlMenu($files);
}
/**
* Implements hook_civicrm_install().
*
@ -104,54 +95,6 @@ function bij1migratie_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _bij1migratie_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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
*/
function bij1migratie_civicrm_managed(&$entities) {
_bij1migratie_civix_civicrm_managed($entities);
}
/**
* Implements hook_civicrm_caseTypes().
*
* Generate a list of case-types.
*
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
*/
function bij1migratie_civicrm_caseTypes(&$caseTypes) {
_bij1migratie_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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
*/
function bij1migratie_civicrm_angularModules(&$angularModules) {
_bij1migratie_civix_civicrm_angularModules($angularModules);
}
/**
* Implements hook_civicrm_alterSettingsFolders().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
*/
function bij1migratie_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_bij1migratie_civix_civicrm_alterSettingsFolders($metaDataFolders);
}
/**
* Implements hook_civicrm_entityTypes().
*
@ -163,13 +106,6 @@ function bij1migratie_civicrm_entityTypes(&$entityTypes) {
_bij1migratie_civix_civicrm_entityTypes($entityTypes);
}
/**
* Implements hook_civicrm_themes().
*/
function bij1migratie_civicrm_themes(&$themes) {
_bij1migratie_civix_civicrm_themes($themes);
}
// --- Functions below this ship commented out. Uncomment as required. ---
/**

7
info.xml
View File

@ -23,13 +23,18 @@
<requires>
<ext>bij1algemeen</ext>
<ext>de.systopia.identitytracker</ext>
<ext>org.project60.banking</ext>>
<ext>org.project60.banking</ext>
</requires>
<comments>Specifieke migratie extensie</comments>
<classloader>
<psr4 prefix="Civi\" path="Civi"/>
<psr0 prefix="CRM_" path="."/>
</classloader>
<civix>
<namespace>CRM/Bij1migratie</namespace>
<format>22.10.0</format>
</civix>
<mixins>
<mixin>menu-xml@1.0.0</mixin>
</mixins>
</extension>

31
mixin/menu-xml@1.0.0.mixin.php Normal file
View File

@ -0,0 +1,31 @@
<?php
/**
* Auto-register "xml/Menu/*.xml" files.
*
* @mixinName menu-xml
* @mixinVersion 1.0.0
*
* @param CRM_Extension_MixInfo $mixInfo
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
* @param \CRM_Extension_BootCache $bootCache
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
*/
return function ($mixInfo, $bootCache) {
/**
* @param \Civi\Core\Event\GenericHookEvent $e
* @see CRM_Utils_Hook::xmlMenu()
*/
Civi::dispatcher()->addListener('hook_civicrm_xmlMenu', function ($e) use ($mixInfo) {
if (!$mixInfo->isActive()) {
return;
}
$files = (array) glob($mixInfo->getPath('xml/Menu/*.xml'));
foreach ($files as $file) {
$e->files[] = $file;
}
});
};

101
mixin/polyfill.php Normal file
View File

@ -0,0 +1,101 @@
<?php
/**
* When deploying on systems that lack mixin support, fake it.
*
* @mixinFile polyfill.php
*
* This polyfill does some (persnickity) deduplication, but it doesn't allow upgrades or shipping replacements in core.
*
* Note: The polyfill.php is designed to be copied into extensions for interoperability. Consequently, this file is
* not used 'live' by `civicrm-core`. However, the file does need a canonical home, and it's convenient to keep it
* adjacent to the actual mixin files.
*
* @param string $longName
* @param string $shortName
* @param string $basePath
*/
return function ($longName, $shortName, $basePath) {
// Construct imitations of the mixin services. These cannot work as well (e.g. with respect to
// number of file-reads, deduping, upgrading)... but they should be OK for a few months while
// the mixin services become available.
// List of active mixins; deduped by version
$mixinVers = [];
foreach ((array) glob($basePath . '/mixin/*.mixin.php') as $f) {
[$name, $ver] = explode('@', substr(basename($f), 0, -10));
if (!isset($mixinVers[$name]) || version_compare($ver, $mixinVers[$name], '>')) {
$mixinVers[$name] = $ver;
}
}
$mixins = [];
foreach ($mixinVers as $name => $ver) {
$mixins[] = "$name@$ver";
}
// Imitate CRM_Extension_MixInfo.
$mixInfo = new class() {
/**
* @var string
*/
public $longName;
/**
* @var string
*/
public $shortName;
public $_basePath;
public function getPath($file = NULL) {
return $this->_basePath . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
}
public function isActive() {
return \CRM_Extension_System::singleton()->getMapper()->isActiveModule($this->shortName);
}
};
$mixInfo->longName = $longName;
$mixInfo->shortName = $shortName;
$mixInfo->_basePath = $basePath;
// Imitate CRM_Extension_BootCache.
$bootCache = new class() {
public function define($name, $callback) {
$envId = \CRM_Core_Config_Runtime::getId();
$oldExtCachePath = \Civi::paths()->getPath("[civicrm.compile]/CachedExtLoader.{$envId}.php");
$stat = stat($oldExtCachePath);
$file = Civi::paths()->getPath('[civicrm.compile]/CachedMixin.' . md5($name . ($stat['mtime'] ?? 0)) . '.php');
if (file_exists($file)) {
return include $file;
}
else {
$data = $callback();
file_put_contents($file, '<' . "?php\nreturn " . var_export($data, 1) . ';');
return $data;
}
}
};
// Imitate CRM_Extension_MixinLoader::run()
// Parse all live mixins before trying to scan any classes.
global $_CIVIX_MIXIN_POLYFILL;
foreach ($mixins as $mixin) {
// If the exact same mixin is defined by multiple exts, just use the first one.
if (!isset($_CIVIX_MIXIN_POLYFILL[$mixin])) {
$_CIVIX_MIXIN_POLYFILL[$mixin] = include_once $basePath . '/mixin/' . $mixin . '.mixin.php';
}
}
foreach ($mixins as $mixin) {
// If there's trickery about installs/uninstalls/resets, then we may need to register a second time.
if (!isset(\Civi::$statics[__FUNCTION__][$mixin])) {
\Civi::$statics[__FUNCTION__][$mixin] = 1;
$func = $_CIVIX_MIXIN_POLYFILL[$mixin];
$func($mixInfo, $bootCache);
}
}
};