[#51] Update civix-generated code

This commit is contained in:
Jens Schuppe 2021-11-09 11:55:22 +01:00
parent 7ff5d18dc0
commit facf71e3cd

View file

@ -7,9 +7,9 @@
* extension. * extension.
*/ */
class CRM_Twingle_ExtensionUtil { class CRM_Twingle_ExtensionUtil {
const SHORT_NAME = "twingle"; const SHORT_NAME = 'twingle';
const LONG_NAME = "de.systopia.twingle"; const LONG_NAME = 'de.systopia.twingle';
const CLASS_PREFIX = "CRM_Twingle"; const CLASS_PREFIX = 'CRM_Twingle';
/** /**
* Translate a string using the extension's domain. * Translate a string using the extension's domain.
@ -24,9 +24,9 @@ class CRM_Twingle_ExtensionUtil {
* Translated text. * Translated text.
* @see ts * @see ts
*/ */
public static function ts($text, $params = array()) { public static function ts($text, $params = []) {
if (!array_key_exists('domain', $params)) { if (!array_key_exists('domain', $params)) {
$params['domain'] = array(self::LONG_NAME, NULL); $params['domain'] = [self::LONG_NAME, NULL];
} }
return ts($text, $params); return ts($text, $params);
} }
@ -82,7 +82,7 @@ use CRM_Twingle_ExtensionUtil as E;
/** /**
* (Delegated) Implements hook_civicrm_config(). * (Delegated) Implements hook_civicrm_config().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
*/ */
function _twingle_civix_civicrm_config(&$config = NULL) { function _twingle_civix_civicrm_config(&$config = NULL) {
static $configured = FALSE; static $configured = FALSE;
@ -100,7 +100,7 @@ function _twingle_civix_civicrm_config(&$config = NULL) {
array_unshift($template->template_dir, $extDir); array_unshift($template->template_dir, $extDir);
} }
else { else {
$template->template_dir = array($extDir, $template->template_dir); $template->template_dir = [$extDir, $template->template_dir];
} }
$include_path = $extRoot . PATH_SEPARATOR . get_include_path(); $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
@ -112,7 +112,7 @@ function _twingle_civix_civicrm_config(&$config = NULL) {
* *
* @param $files array(string) * @param $files array(string)
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
*/ */
function _twingle_civix_civicrm_xmlMenu(&$files) { function _twingle_civix_civicrm_xmlMenu(&$files) {
foreach (_twingle_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { foreach (_twingle_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
@ -123,7 +123,7 @@ function _twingle_civix_civicrm_xmlMenu(&$files) {
/** /**
* Implements hook_civicrm_install(). * Implements hook_civicrm_install().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
*/ */
function _twingle_civix_civicrm_install() { function _twingle_civix_civicrm_install() {
_twingle_civix_civicrm_config(); _twingle_civix_civicrm_config();
@ -135,12 +135,12 @@ function _twingle_civix_civicrm_install() {
/** /**
* Implements hook_civicrm_postInstall(). * Implements hook_civicrm_postInstall().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
*/ */
function _twingle_civix_civicrm_postInstall() { function _twingle_civix_civicrm_postInstall() {
_twingle_civix_civicrm_config(); _twingle_civix_civicrm_config();
if ($upgrader = _twingle_civix_upgrader()) { if ($upgrader = _twingle_civix_upgrader()) {
if (is_callable(array($upgrader, 'onPostInstall'))) { if (is_callable([$upgrader, 'onPostInstall'])) {
$upgrader->onPostInstall(); $upgrader->onPostInstall();
} }
} }
@ -149,7 +149,7 @@ function _twingle_civix_civicrm_postInstall() {
/** /**
* Implements hook_civicrm_uninstall(). * Implements hook_civicrm_uninstall().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
*/ */
function _twingle_civix_civicrm_uninstall() { function _twingle_civix_civicrm_uninstall() {
_twingle_civix_civicrm_config(); _twingle_civix_civicrm_config();
@ -161,12 +161,12 @@ function _twingle_civix_civicrm_uninstall() {
/** /**
* (Delegated) Implements hook_civicrm_enable(). * (Delegated) Implements hook_civicrm_enable().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
*/ */
function _twingle_civix_civicrm_enable() { function _twingle_civix_civicrm_enable() {
_twingle_civix_civicrm_config(); _twingle_civix_civicrm_config();
if ($upgrader = _twingle_civix_upgrader()) { if ($upgrader = _twingle_civix_upgrader()) {
if (is_callable(array($upgrader, 'onEnable'))) { if (is_callable([$upgrader, 'onEnable'])) {
$upgrader->onEnable(); $upgrader->onEnable();
} }
} }
@ -175,13 +175,13 @@ function _twingle_civix_civicrm_enable() {
/** /**
* (Delegated) Implements hook_civicrm_disable(). * (Delegated) Implements hook_civicrm_disable().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
* @return mixed * @return mixed
*/ */
function _twingle_civix_civicrm_disable() { function _twingle_civix_civicrm_disable() {
_twingle_civix_civicrm_config(); _twingle_civix_civicrm_config();
if ($upgrader = _twingle_civix_upgrader()) { if ($upgrader = _twingle_civix_upgrader()) {
if (is_callable(array($upgrader, 'onDisable'))) { if (is_callable([$upgrader, 'onDisable'])) {
$upgrader->onDisable(); $upgrader->onDisable();
} }
} }
@ -193,10 +193,11 @@ function _twingle_civix_civicrm_disable() {
* @param $op string, the type of operation being performed; 'check' or 'enqueue' * @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 * @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) * @return mixed
* based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void * for 'enqueue', returns void
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
*/ */
function _twingle_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { function _twingle_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
if ($upgrader = _twingle_civix_upgrader()) { if ($upgrader = _twingle_civix_upgrader()) {
@ -217,49 +218,27 @@ function _twingle_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: Dot-directories (like "..", ".git", or ".svn") will be ignored.
* Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() * Note: Delegate to CRM_Utils_File::findFiles(), this function kept only
* for backward compatibility of extension code that uses it.
* *
* @param $dir string, base dir * @param string $dir base dir
* @param $pattern string, glob pattern, eg "*.txt" * @param string $pattern , glob pattern, eg "*.txt"
* @return array(string) *
* @return array
*/ */
function _twingle_civix_find_files($dir, $pattern) { function _twingle_civix_find_files($dir, $pattern) {
if (is_callable(array('CRM_Utils_File', 'findFiles'))) {
return CRM_Utils_File::findFiles($dir, $pattern); return CRM_Utils_File::findFiles($dir, $pattern);
} }
$todos = array($dir);
$result = array();
while (!empty($todos)) {
$subdir = array_shift($todos);
foreach (_twingle_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(). * (Delegated) Implements hook_civicrm_managed().
* *
* Find any *.mgd.php files, merge their content, and return. * Find any *.mgd.php files, merge their content, and return.
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
*/ */
function _twingle_civix_civicrm_managed(&$entities) { function _twingle_civix_civicrm_managed(&$entities) {
$mgdFiles = _twingle_civix_find_files(__DIR__, '*.mgd.php'); $mgdFiles = _twingle_civix_find_files(__DIR__, '*.mgd.php');
@ -285,7 +264,7 @@ function _twingle_civix_civicrm_managed(&$entities) {
* *
* Note: This hook only runs in CiviCRM 4.4+. * Note: This hook only runs in CiviCRM 4.4+.
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
*/ */
function _twingle_civix_civicrm_caseTypes(&$caseTypes) { function _twingle_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) { if (!is_dir(__DIR__ . '/xml/case')) {
@ -296,14 +275,13 @@ function _twingle_civix_civicrm_caseTypes(&$caseTypes) {
$name = preg_replace('/\.xml$/', '', basename($file)); $name = preg_replace('/\.xml$/', '', basename($file));
if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
$errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $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, 'module' => E::LONG_NAME,
'name' => $name, 'name' => $name,
'file' => $file, 'file' => $file,
); ];
} }
} }
@ -314,7 +292,7 @@ function _twingle_civix_civicrm_caseTypes(&$caseTypes) {
* *
* Note: This hook only runs in CiviCRM 4.5+. * Note: This hook only runs in CiviCRM 4.5+.
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
*/ */
function _twingle_civix_civicrm_angularModules(&$angularModules) { function _twingle_civix_civicrm_angularModules(&$angularModules) {
if (!is_dir(__DIR__ . '/ang')) { if (!is_dir(__DIR__ . '/ang')) {
@ -332,6 +310,25 @@ function _twingle_civix_civicrm_angularModules(&$angularModules) {
} }
} }
/**
* (Delegated) Implements hook_civicrm_themes().
*
* Find any and return any files matching "*.theme.php"
*/
function _twingle_civix_civicrm_themes(&$themes) {
$files = _twingle_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. * Glob wrapper which is guaranteed to return an array.
* *
@ -342,11 +339,12 @@ function _twingle_civix_civicrm_angularModules(&$angularModules) {
* *
* @link http://php.net/glob * @link http://php.net/glob
* @param string $pattern * @param string $pattern
* @return array, possibly empty *
* @return array
*/ */
function _twingle_civix_glob($pattern) { function _twingle_civix_glob($pattern) {
$result = glob($pattern); $result = glob($pattern);
return is_array($result) ? $result : array(); return is_array($result) ? $result : [];
} }
/** /**
@ -357,16 +355,18 @@ function _twingle_civix_glob($pattern) {
* 'Mailing', or 'Administer/System Settings' * 'Mailing', or 'Administer/System Settings'
* @param array $item - the item to insert (parent/child attributes will be * @param array $item - the item to insert (parent/child attributes will be
* filled for you) * filled for you)
*
* @return bool
*/ */
function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) { function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) {
// If we are done going down the path, insert menu // If we are done going down the path, insert menu
if (empty($path)) { if (empty($path)) {
$menu[] = array( $menu[] = [
'attributes' => array_merge(array( 'attributes' => array_merge([
'label' => CRM_Utils_Array::value('name', $item), 'label' => CRM_Utils_Array::value('name', $item),
'active' => 1, 'active' => 1,
), $item), ], $item),
); ];
return TRUE; return TRUE;
} }
else { else {
@ -377,9 +377,9 @@ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) {
foreach ($menu as $key => &$entry) { foreach ($menu as $key => &$entry) {
if ($entry['attributes']['name'] == $first) { if ($entry['attributes']['name'] == $first) {
if (!isset($entry['child'])) { if (!isset($entry['child'])) {
$entry['child'] = array(); $entry['child'] = [];
} }
$found = _twingle_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); $found = _twingle_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
} }
} }
return $found; return $found;
@ -390,7 +390,7 @@ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) {
* (Delegated) Implements hook_civicrm_navigationMenu(). * (Delegated) Implements hook_civicrm_navigationMenu().
*/ */
function _twingle_civix_navigationMenu(&$nodes) { function _twingle_civix_navigationMenu(&$nodes) {
if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
_twingle_civix_fixNavigationMenu($nodes); _twingle_civix_fixNavigationMenu($nodes);
} }
} }
@ -432,17 +432,11 @@ function _twingle_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
/** /**
* (Delegated) Implements hook_civicrm_alterSettingsFolders(). * (Delegated) Implements hook_civicrm_alterSettingsFolders().
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
*/ */
function _twingle_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { function _twingle_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
static $configured = FALSE;
if ($configured) {
return;
}
$configured = TRUE;
$settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
if (is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) { if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
$metaDataFolders[] = $settingsDir; $metaDataFolders[] = $settingsDir;
} }
} }
@ -452,10 +446,8 @@ function _twingle_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
* *
* Find any *.entityType.php files, merge their content, and return. * Find any *.entityType.php files, merge their content, and return.
* *
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
*/ */
function _twingle_civix_civicrm_entityTypes(&$entityTypes) { function _twingle_civix_civicrm_entityTypes(&$entityTypes) {
$entityTypes = array_merge($entityTypes, array ( $entityTypes = array_merge($entityTypes, []);
));
} }