From 7980012b9495c7041ec716462ca16a68b0bee607 Mon Sep 17 00:00:00 2001 From: Seamus Lee Date: Mon, 8 Jun 2020 09:33:47 +1000 Subject: [PATCH] dev/core#560 Replace deprecated CRM_Core_Erorr::fatal with Exceptions or status bounces as appropriate --- CRM/Contact/BAO/SearchCustom.php | 4 +- CRM/Contact/Form/Search/Custom/PriceSet.php | 2 +- CRM/Contact/Import/ImportJob.php | 2 +- CRM/Contribute/BAO/Contribution.php | 2 +- CRM/Contribute/Form/AbstractEditPayment.php | 2 +- CRM/Contribute/Form/Contribution/Main.php | 2 +- CRM/Contribute/Form/Task/Invoice.php | 2 +- CRM/Contribute/Form/Task/Status.php | 2 +- CRM/Contribute/Import/Parser.php | 2 +- CRM/Import/DataSource/CSV.php | 4 +- CRM/Report/Form.php | 2 +- CRM/Report/Form/Activity.php | 2 +- CRM/Report/Page/Options.php | 2 +- .../org.civicrm.angularex/angularex.civix.php | 314 ++++++++++++++---- 14 files changed, 260 insertions(+), 84 deletions(-) diff --git a/CRM/Contact/BAO/SearchCustom.php b/CRM/Contact/BAO/SearchCustom.php index 548ec894aa..fd18da4430 100644 --- a/CRM/Contact/BAO/SearchCustom.php +++ b/CRM/Contact/BAO/SearchCustom.php @@ -76,7 +76,7 @@ class CRM_Contact_BAO_SearchCustom { $error = include_once $customSearchFile; if ($error == FALSE) { - CRM_Core_Error::fatal('Custom search file: ' . $customSearchFile . ' does not exist. Please verify your custom search settings in CiviCRM administrative panel.'); + throw new CRM_Core_Exception('Custom search file: ' . $customSearchFile . ' does not exist. Please verify your custom search settings in CiviCRM administrative panel.'); } return [$customSearchID, $customSearchClass, $formValues]; @@ -93,7 +93,7 @@ class CRM_Contact_BAO_SearchCustom { list($customSearchID, $customSearchClass, $formValues) = self::details($csID, $ssID); if (!$customSearchID) { - CRM_Core_Error::fatal('Could not resolve custom search ID'); + throw new CRM_Core_Exception('Could not resolve custom search ID'); } // instantiate the new class diff --git a/CRM/Contact/Form/Search/Custom/PriceSet.php b/CRM/Contact/Form/Search/Custom/PriceSet.php index 327bc90045..74e5aa006e 100644 --- a/CRM/Contact/Form/Search/Custom/PriceSet.php +++ b/CRM/Contact/Form/Search/Custom/PriceSet.php @@ -225,7 +225,7 @@ AND p.entity_id = e.id if ($dao->fetch() && !$dao->price_set_id ) { - CRM_Core_Error::fatal(ts('There are no events with Price Sets')); + throw new CRM_Core_Exception(ts('There are no events with Price Sets')); } // get all the fields and all the option values associated with it diff --git a/CRM/Contact/Import/ImportJob.php b/CRM/Contact/Import/ImportJob.php index 7940288294..b598bd3cd3 100644 --- a/CRM/Contact/Import/ImportJob.php +++ b/CRM/Contact/Import/ImportJob.php @@ -93,7 +93,7 @@ class CRM_Contact_Import_ImportJob { */ public function isComplete($dropIfComplete = TRUE) { if (!$this->_statusFieldName) { - CRM_Core_Error::fatal("Could not get name of the import status field"); + throw new CRM_Core_Exception("Could not get name of the import status field"); } $query = "SELECT * FROM $this->_tableName WHERE $this->_statusFieldName = 'NEW' LIMIT 1"; diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 655a9c63ac..6ad09931c8 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -1944,7 +1944,7 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont } if (empty($clauses)) { - CRM_Core_Error::fatal(); + throw new CRM_Core_Exception('No Where clauses defined when deleting address'); } $condition = implode(' OR ', $clauses); diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index 6a328ca1e9..953c0f31cd 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -414,7 +414,7 @@ WHERE contribution_id = {$id} //get all status $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) { - CRM_Core_Error::fatal(ts("Pledge payment status should be 'Pending' or 'Overdue'.")); + CRM_Core_Error::statusBounce(ts("Pledge payment status should be 'Pending' or 'Overdue'.")); } //get the pledge values associated with given pledge payment. diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index b55883cbee..e894fa1495 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -454,7 +454,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } } if (empty($this->_values['fee']) && empty($this->_ccid)) { - CRM_Core_Error::fatal(ts('This page does not have any price fields configured or you may not have permission for them. Please contact the site administrator for more details.')); + throw new CRM_Core_Exception(ts('This page does not have any price fields configured or you may not have permission for them. Please contact the site administrator for more details.')); } //we have to load confirm contribution button in template diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 5e9bedcf07..d189158cd8 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -229,7 +229,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { $ids['event'] = $detail['event'] ?? NULL; if (!$invoiceElements['baseIPN']->validateData($input, $ids, $objects, FALSE)) { - CRM_Core_Error::fatal(); + CRM_Core_Error::statusBounce('Supplied data was not able to be validated'); } $contribution = &$objects['contribution']; diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index c8acc1e8ff..e3c2a6e7da 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -234,7 +234,7 @@ AND co.id IN ( $contribIDs )"; $ids['event'] = $details[$row['contribution_id']]['event'] ?? NULL; if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) { - CRM_Core_Error::fatal(); + CRM_Core_Error::statusBounce('Supplied data was not able to be validated'); } $contribution = &$objects['contribution']; diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index e36f742fc1..87637bb629 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -128,7 +128,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { $totalRowCount = NULL ) { if (!is_array($fileName)) { - CRM_Core_Error::fatal(); + throw new CRM_Core_Exception('Unable to determine import file'); } $fileName = $fileName['name']; diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 7f066497ed..e03b5972f7 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -118,10 +118,10 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { $result = []; $fd = fopen($file, 'r'); if (!$fd) { - CRM_Core_Error::fatal("Could not read $file"); + throw new CRM_Core_Exception("Could not read $file"); } if (filesize($file) == 0) { - CRM_Core_Error::fatal("$file is empty. Please upload a valid file."); + throw new CRM_Core_Exception("$file is empty. Please upload a valid file."); } $config = CRM_Core_Config::singleton(); diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index f09de2def6..7ea3a22179 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -612,7 +612,7 @@ class CRM_Report_Form extends CRM_Core_Form { $this->_instanceValues ); if (empty($this->_instanceValues)) { - CRM_Core_Error::fatal("Report could not be loaded."); + CRM_Core_Error::statusBounce("Report could not be loaded."); } $this->_title = $this->_instanceValues['title']; if (!empty($this->_instanceValues['permission']) && diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php index 19c6a9fc3e..e0c5b6408e 100644 --- a/CRM/Report/Form/Activity.php +++ b/CRM/Report/Form/Activity.php @@ -643,7 +643,7 @@ class CRM_Report_Form_Activity extends CRM_Report_Form { */ public function add2group($groupID) { if (CRM_Utils_Array::value("contact_target_op", $this->_params) == 'nll') { - CRM_Core_Error::fatal(ts('Current filter criteria didn\'t have any target contact to add to group')); + CRM_Core_Error::statusBounce(ts('Current filter criteria didn\'t have any target contact to add to group')); } $new_select = 'AS addtogroup_contact_id'; diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php index 71c005d679..a5852f1902 100644 --- a/CRM/Report/Page/Options.php +++ b/CRM/Report/Page/Options.php @@ -63,7 +63,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { self::$_gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gName, 'id', 'name'); } else { - CRM_Core_Error::fatal(); + CRM_Core_Error::statusBounce('Unable to determine the Option Group'); } self::$_GName = ucwords(str_replace('_', ' ', self::$_gName)); diff --git a/tools/extensions/org.civicrm.angularex/angularex.civix.php b/tools/extensions/org.civicrm.angularex/angularex.civix.php index fcb5d572b0..308a7699e5 100644 --- a/tools/extensions/org.civicrm.angularex/angularex.civix.php +++ b/tools/extensions/org.civicrm.angularex/angularex.civix.php @@ -3,10 +3,86 @@ // AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file /** - * (Delegated) Implementation of hook_civicrm_config + * The ExtensionUtil class provides small stubs for accessing resources of this + * extension. + */ +class CRM_Angularex_ExtensionUtil { + const SHORT_NAME = "angularex"; + const LONG_NAME = "org.civicrm.angularex"; + const CLASS_PREFIX = "CRM_Angularex"; + + /** + * Translate a string using the extension's domain. + * + * If the extension doesn't have a specific translation + * for the string, fallback to the default translations. + * + * @param string $text + * Canonical message text (generally en_US). + * @param array $params + * @return string + * Translated text. + * @see ts + */ + public static function ts($text, $params = []) { + if (!array_key_exists('domain', $params)) { + $params['domain'] = [self::LONG_NAME, NULL]; + } + return ts($text, $params); + } + + /** + * 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); + } + + /** + * 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__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file)); + } + + /** + * Get the name of a class within this extension. + * + * @param string $suffix + * Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'. + * @return string + * Ex: 'CRM_Foo_Page_HelloWorld'. + */ + public static function findClass($suffix) { + return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix); + } + +} + +use CRM_Angularex_ExtensionUtil as E; + +/** + * (Delegated) Implements hook_civicrm_config(). * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config - * @param null $config + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config */ function _angularex_civix_civicrm_config(&$config = NULL) { static $configured = FALSE; @@ -32,10 +108,11 @@ function _angularex_civix_civicrm_config(&$config = NULL) { } /** - * (Delegated) Implementation of hook_civicrm_xmlMenu + * (Delegated) Implements hook_civicrm_xmlMenu(). * * @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 _angularex_civix_civicrm_xmlMenu(&$files) { foreach (_angularex_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { @@ -44,59 +121,74 @@ function _angularex_civix_civicrm_xmlMenu(&$files) { } /** - * Implementation of 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 _angularex_civix_civicrm_install() { _angularex_civix_civicrm_config(); if ($upgrader = _angularex_civix_upgrader()) { - return $upgrader->onInstall(); + $upgrader->onInstall(); } } /** - * Implementation of hook_civicrm_uninstall + * Implements hook_civicrm_postInstall(). * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall + */ +function _angularex_civix_civicrm_postInstall() { + _angularex_civix_civicrm_config(); + if ($upgrader = _angularex_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 _angularex_civix_civicrm_uninstall() { _angularex_civix_civicrm_config(); if ($upgrader = _angularex_civix_upgrader()) { - return $upgrader->onUninstall(); + $upgrader->onUninstall(); } } /** - * (Delegated) Implementation of 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 _angularex_civix_civicrm_enable() { _angularex_civix_civicrm_config(); if ($upgrader = _angularex_civix_upgrader()) { if (is_callable([$upgrader, 'onEnable'])) { - return $upgrader->onEnable(); + $upgrader->onEnable(); } } } /** - * (Delegated) Implementation of 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 */ function _angularex_civix_civicrm_disable() { _angularex_civix_civicrm_config(); if ($upgrader = _angularex_civix_upgrader()) { if (is_callable([$upgrader, 'onDisable'])) { - return $upgrader->onDisable(); + $upgrader->onDisable(); } } } /** - * (Delegated) Implementation of hook_civicrm_upgrade + * (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 @@ -104,7 +196,7 @@ function _angularex_civix_civicrm_disable() { * @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 _angularex_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { if ($upgrader = _angularex_civix_upgrader()) { @@ -125,13 +217,14 @@ function _angularex_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" + * @param string $dir base dir + * @param string $pattern , glob pattern, eg "*.txt" + * * @return array(string) */ function _angularex_civix_find_files($dir, $pattern) { @@ -162,22 +255,24 @@ function _angularex_civix_find_files($dir, $pattern) { } return $result; } - /** - * (Delegated) Implementation of hook_civicrm_managed + * (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 - * @param $entities + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed */ function _angularex_civix_civicrm_managed(&$entities) { $mgdFiles = _angularex_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'] = 'org.civicrm.angularex'; + $e['module'] = E::LONG_NAME; + } + if (empty($e['params']['version'])) { + $e['params']['version'] = '3'; } $entities[] = $e; } @@ -185,15 +280,13 @@ function _angularex_civix_civicrm_managed(&$entities) { } /** - * (Delegated) Implementation of hook_civicrm_caseTypes + * (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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes - * @param $caseTypes - * @throws \Exception + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes */ function _angularex_civix_civicrm_caseTypes(&$caseTypes) { if (!is_dir(__DIR__ . '/xml/case')) { @@ -204,17 +297,60 @@ function _angularex_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] = [ - 'module' => 'org.civicrm.angularex', + '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 _angularex_civix_civicrm_angularModules(&$angularModules) { + if (!is_dir(__DIR__ . '/ang')) { + return; + } + + $files = _angularex_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 _angularex_civix_civicrm_themes(&$themes) { + $files = _angularex_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. * @@ -225,6 +361,7 @@ function _angularex_civix_civicrm_caseTypes(&$caseTypes) { * * @link http://php.net/glob * @param string $pattern + * * @return array, possibly empty */ function _angularex_civix_glob($pattern) { @@ -233,34 +370,24 @@ function _angularex_civix_glob($pattern) { } /** - * Inserts a navigation menu item at a given place in the hierarchy + * Inserts a navigation menu item at a given place in the hierarchy. + * + * @param array $menu - menu hierarchy + * @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) * - * $menu - menu hierarchy - * $path - path where insertion should happen (ie. Administer/System Settings) - * $item - menu you need to insert (parent/child attributes will be filled for you) - * $parentId - used internally to recurse in the menu structure - * @param $menu - * @param $path - * @param $item - * @param null $parentId * @return bool */ -function _angularex_civix_insert_navigation_menu(&$menu, $path, $item, $parentId = NULL) { - static $navId; - +function _angularex_civix_insert_navigation_menu(&$menu, $path, $item) { // If we are done going down the path, insert menu if (empty($path)) { - if (!$navId) { - $navId = CRM_Core_DAO::singleValueQuery("SELECT max(id) FROM civicrm_navigation"); - } - $navId++; - $menu[$navId] = [ - 'attributes' => array_merge($item, [ - 'label' => $item['name'] ?? NULL, - 'active' => 1, - 'parentID' => $parentId, - 'navID' => $navId, - ]), + $menu[] = [ + 'attributes' => array_merge([ + 'label' => CRM_Utils_Array::value('name', $item), + 'active' => 1, + ], $item), ]; return TRUE; } @@ -271,10 +398,10 @@ function _angularex_civix_insert_navigation_menu(&$menu, $path, $item, $parentId $first = array_shift($path); foreach ($menu as $key => &$entry) { if ($entry['attributes']['name'] == $first) { - if (!$entry['child']) { + if (!isset($entry['child'])) { $entry['child'] = []; } - $found = _angularex_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + $found = _angularex_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); } } return $found; @@ -282,20 +409,69 @@ function _angularex_civix_insert_navigation_menu(&$menu, $path, $item, $parentId } /** - * (Delegated) Implementation of hook_civicrm_alterSettingsFolders - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders - * @param null $metaDataFolders + * (Delegated) Implements hook_civicrm_navigationMenu(). */ -function _angularex_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - static $configured = FALSE; - if ($configured) { - return; +function _angularex_civix_navigationMenu(&$nodes) { + if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { + _angularex_civix_fixNavigationMenu($nodes); } - $configured = TRUE; +} +/** + * Given a navigation menu, generate navIDs for any items which are + * missing them. + */ +function _angularex_civix_fixNavigationMenu(&$nodes) { + $maxNavID = 1; + array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) { + if ($key === 'navID') { + $maxNavID = max($maxNavID, $item); + } + }); + _angularex_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL); +} + +function _angularex_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) { + $origKeys = array_keys($nodes); + foreach ($origKeys as $origKey) { + if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) { + $nodes[$origKey]['attributes']['parentID'] = $parentID; + } + // If no navID, then assign navID and fix key. + if (!isset($nodes[$origKey]['attributes']['navID'])) { + $newKey = ++$maxNavID; + $nodes[$origKey]['attributes']['navID'] = $newKey; + $nodes[$newKey] = $nodes[$origKey]; + unset($nodes[$origKey]); + $origKey = $newKey; + } + if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) { + _angularex_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_alterSettingsFolders(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders + */ +function _angularex_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { $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 _angularex_civix_civicrm_entityTypes(&$entityTypes) { + $entityTypes = array_merge($entityTypes, array ( + )); +} -- 2.25.1