From 2f6eafdd167650024d87050f63d5d770ae083574 Mon Sep 17 00:00:00 2001 From: Justin Freeman Date: Fri, 8 Oct 2021 17:10:37 +1100 Subject: [PATCH] Regenerate civix --- info.xml | 4 +- scheduledccrecipients.civix.php | 177 ++++++++++++++++++-------------- 2 files changed, 101 insertions(+), 80 deletions(-) diff --git a/info.xml b/info.xml index 4398072..32370ce 100644 --- a/info.xml +++ b/info.xml @@ -14,8 +14,8 @@ https://agileware.com.au/contact http://www.gnu.org/licenses/agpl-3.0.html - 2018-03-27 - 1.0 + 2021-10-08 + 1.1 stable 4.6 diff --git a/scheduledccrecipients.civix.php b/scheduledccrecipients.civix.php index e20f3c2..321cabe 100644 --- a/scheduledccrecipients.civix.php +++ b/scheduledccrecipients.civix.php @@ -7,9 +7,9 @@ * extension. */ class CRM_Scheduledccrecipients_ExtensionUtil { - const SHORT_NAME = "scheduledccrecipients"; - const LONG_NAME = "au.com.agileware.scheduledccrecipients"; - const CLASS_PREFIX = "CRM_Scheduledccrecipients"; + const SHORT_NAME = 'scheduledccrecipients'; + const LONG_NAME = 'au.com.agileware.scheduledccrecipients'; + const CLASS_PREFIX = 'CRM_Scheduledccrecipients'; /** * Translate a string using the extension's domain. @@ -24,9 +24,9 @@ class CRM_Scheduledccrecipients_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); } @@ -35,11 +35,16 @@ public static function ts($text, $params = array()) { * Get the URL of a resource file (in this extension). * * @param string|NULL $file + * Ex: NULL. * Ex: 'css/foo.css'. * @return string + * 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) { + if ($file === NULL) { + return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/'); + } return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file); } @@ -47,13 +52,15 @@ public static function url($file = NULL) { * Get the path of a resource file (in this extension). * * @param string|NULL $file + * Ex: NULL. * Ex: 'css/foo.css'. * @return string + * Ex: '/var/www/example.org/sites/default/ext/org.example.foo'. * Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'. */ public static function path($file = NULL) { // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file); - return __DIR__ . ($path === NULL ? '' : (DIRECTORY_SEPARATOR . $file)); + return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file)); } /** @@ -75,7 +82,7 @@ public static function findClass($suffix) { /** * (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 _scheduledccrecipients_civix_civicrm_config(&$config = NULL) { static $configured = FALSE; @@ -93,7 +100,7 @@ function _scheduledccrecipients_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(); @@ -105,7 +112,7 @@ function _scheduledccrecipients_civix_civicrm_config(&$config = NULL) { * * @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 _scheduledccrecipients_civix_civicrm_xmlMenu(&$files) { foreach (_scheduledccrecipients_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { @@ -116,7 +123,7 @@ function _scheduledccrecipients_civix_civicrm_xmlMenu(&$files) { /** * 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 _scheduledccrecipients_civix_civicrm_install() { _scheduledccrecipients_civix_civicrm_config(); @@ -128,12 +135,12 @@ function _scheduledccrecipients_civix_civicrm_install() { /** * 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 _scheduledccrecipients_civix_civicrm_postInstall() { _scheduledccrecipients_civix_civicrm_config(); if ($upgrader = _scheduledccrecipients_civix_upgrader()) { - if (is_callable(array($upgrader, 'onPostInstall'))) { + if (is_callable([$upgrader, 'onPostInstall'])) { $upgrader->onPostInstall(); } } @@ -142,7 +149,7 @@ function _scheduledccrecipients_civix_civicrm_postInstall() { /** * 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 _scheduledccrecipients_civix_civicrm_uninstall() { _scheduledccrecipients_civix_civicrm_config(); @@ -154,12 +161,12 @@ function _scheduledccrecipients_civix_civicrm_uninstall() { /** * (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 _scheduledccrecipients_civix_civicrm_enable() { _scheduledccrecipients_civix_civicrm_config(); if ($upgrader = _scheduledccrecipients_civix_upgrader()) { - if (is_callable(array($upgrader, 'onEnable'))) { + if (is_callable([$upgrader, 'onEnable'])) { $upgrader->onEnable(); } } @@ -168,13 +175,13 @@ function _scheduledccrecipients_civix_civicrm_enable() { /** * (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 */ function _scheduledccrecipients_civix_civicrm_disable() { _scheduledccrecipients_civix_civicrm_config(); if ($upgrader = _scheduledccrecipients_civix_upgrader()) { - if (is_callable(array($upgrader, 'onDisable'))) { + if (is_callable([$upgrader, 'onDisable'])) { $upgrader->onDisable(); } } @@ -186,10 +193,11 @@ function _scheduledccrecipients_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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade */ function _scheduledccrecipients_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { if ($upgrader = _scheduledccrecipients_civix_upgrader()) { @@ -210,62 +218,41 @@ function _scheduledccrecipients_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() + * 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" * - * @param $dir string, base dir - * @param $pattern string, glob pattern, eg "*.txt" - * @return array(string) + * @return array */ function _scheduledccrecipients_civix_find_files($dir, $pattern) { - if (is_callable(array('CRM_Utils_File', 'findFiles'))) { - return CRM_Utils_File::findFiles($dir, $pattern); - } - - $todos = array($dir); - $result = array(); - while (!empty($todos)) { - $subdir = array_shift($todos); - foreach (_scheduledccrecipients_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; + return CRM_Utils_File::findFiles($dir, $pattern); } + /** * (Delegated) Implements hook_civicrm_managed(). * * 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 _scheduledccrecipients_civix_civicrm_managed(&$entities) { $mgdFiles = _scheduledccrecipients_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; } - $entities[] = $e; if (empty($e['params']['version'])) { $e['params']['version'] = '3'; } + $entities[] = $e; } } } @@ -277,7 +264,7 @@ function _scheduledccrecipients_civix_civicrm_managed(&$entities) { * * 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 _scheduledccrecipients_civix_civicrm_caseTypes(&$caseTypes) { if (!is_dir(__DIR__ . '/xml/case')) { @@ -288,14 +275,13 @@ function _scheduledccrecipients_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, - ); + ]; } } @@ -306,7 +292,7 @@ function _scheduledccrecipients_civix_civicrm_caseTypes(&$caseTypes) { * * 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 _scheduledccrecipients_civix_civicrm_angularModules(&$angularModules) { if (!is_dir(__DIR__ . '/ang')) { @@ -324,6 +310,25 @@ function _scheduledccrecipients_civix_civicrm_angularModules(&$angularModules) { } } +/** + * (Delegated) Implements hook_civicrm_themes(). + * + * Find any and return any files matching "*.theme.php" + */ +function _scheduledccrecipients_civix_civicrm_themes(&$themes) { + $files = _scheduledccrecipients_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. * @@ -334,29 +339,34 @@ function _scheduledccrecipients_civix_civicrm_angularModules(&$angularModules) { * * @link http://php.net/glob * @param string $pattern - * @return array, possibly empty + * + * @return array */ function _scheduledccrecipients_civix_glob($pattern) { $result = glob($pattern); - return is_array($result) ? $result : array(); + return is_array($result) ? $result : []; } /** * Inserts a navigation menu item at a given place in the hierarchy. * * @param array $menu - menu hierarchy - * @param string $path - path where insertion should happen (ie. Administer/System Settings) - * @param array $item - menu you need to insert (parent/child attributes will be filled for you) + * @param string $path - path to parent of this item, e.g. 'my_extension/submenu' + * 'Mailing', or 'Administer/System Settings' + * @param array $item - the item to insert (parent/child attributes will be + * filled for you) + * + * @return bool */ function _scheduledccrecipients_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 { @@ -367,9 +377,9 @@ function _scheduledccrecipients_civix_insert_navigation_menu(&$menu, $path, $ite foreach ($menu as $key => &$entry) { if ($entry['attributes']['name'] == $first) { if (!isset($entry['child'])) { - $entry['child'] = array(); + $entry['child'] = []; } - $found = _scheduledccrecipients_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + $found = _scheduledccrecipients_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); } } return $found; @@ -380,7 +390,7 @@ function _scheduledccrecipients_civix_insert_navigation_menu(&$menu, $path, $ite * (Delegated) Implements hook_civicrm_navigationMenu(). */ function _scheduledccrecipients_civix_navigationMenu(&$nodes) { - if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { + if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { _scheduledccrecipients_civix_fixNavigationMenu($nodes); } } @@ -422,17 +432,28 @@ function _scheduledccrecipients_civix_fixNavigationMenuItems(&$nodes, &$maxNavID /** * (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 _scheduledccrecipients_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - static $configured = FALSE; - if ($configured) { - return; - } - $configured = TRUE; - $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; - if (is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) { + 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 _scheduledccrecipients_civix_civicrm_entityTypes(&$entityTypes) { + $entityTypes = array_merge($entityTypes, [ + 'CRM_Scheduledccrecipients_DAO_ScheduledReminderData' => [ + 'name' => 'ScheduledReminderData', + 'class' => 'CRM_Scheduledccrecipients_DAO_ScheduledReminderData', + 'table' => 'civicrm_scheduledreminderdata', + ], + ]); +}