hooks migrate - adding ability to differentiate between deprecated and

non-deprecated hooks

content-migration/hooks/fetch-wiki-caches

@@ -10,12 +10,13 @@ chdir($cache_dir);
 
 foreach ($hooks_by_category as $category => $hooks) {
   foreach ($hooks as $hook) {
-    if ( file_exists($hook) ) {
-      echo "SKIPPING: $hook (already cached)" . PHP_EOL;
+    $hook_name = $hook['name'];
+    if ( file_exists($hook_name) ) {
+      echo "SKIPPING: $hook_name (already cached)" . PHP_EOL;
     }
     else {
-      echo "DOWNLOADING: $hook" . PHP_EOL;
-      system("curl '$wiki_url/$hook' > '$hook'");
+      echo "DOWNLOADING: $hook_name" . PHP_EOL;
+      system("curl '$wiki_url/$hook_name' > '$hook_name'");
     }
     echo PHP_EOL;
   }

content-migration/hooks/hooks-by-category.php

@@ -2,132 +2,132 @@
 
 $hooks_by_category = [
   "Database" => [
-    "hook_civicrm_copy",
-    "hook_civicrm_custom",
-    "hook_civicrm_managed",
-    "hook_civicrm_merge",
-    "hook_civicrm_post",
-    "hook_civicrm_pre",
-    "hook_civicrm_trigger_info",
-    "hook_civicrm_referenceCounts",
-    "hook_civicrm_postSave_table_name",
+    [name => "hook_civicrm_copy", is_deprecated => false],
+    [name => "hook_civicrm_custom", is_deprecated => false],
+    [name => "hook_civicrm_managed", is_deprecated => false],
+    [name => "hook_civicrm_merge", is_deprecated => false],
+    [name => "hook_civicrm_post", is_deprecated => false],
+    [name => "hook_civicrm_pre", is_deprecated => false],
+    [name => "hook_civicrm_trigger_info", is_deprecated => false],
+    [name => "hook_civicrm_referenceCounts", is_deprecated => false],
+    [name => "hook_civicrm_postSave_table_name", is_deprecated => false],
   ],
   "Extension lifecycle" => [
-    "hook_civicrm_disable",
-    "hook_civicrm_enable",
-    "hook_civicrm_install",
-    "hook_civicrm_uninstall",
-    "hook_civicrm_upgrade",
-    "hook_civicrm_postInstall",
+    [name => "hook_civicrm_disable", is_deprecated => false],
+    [name => "hook_civicrm_enable", is_deprecated => false],
+    [name => "hook_civicrm_install", is_deprecated => false],
+    [name => "hook_civicrm_uninstall", is_deprecated => false],
+    [name => "hook_civicrm_upgrade", is_deprecated => false],
+    [name => "hook_civicrm_postInstall", is_deprecated => false],
   ],
   "Form" => [
-    "hook_civicrm_alterContent",
-    "hook_civicrm_buildForm",
-    "hook_civicrm_postProcess",
-    "hook_civicrm_validateForm",
-    "hook_civicrm_alterTemplateFile",
-    "hook_civicrm_preProcess",
-    "hook_civicrm_idsException",
+    [name => "hook_civicrm_alterContent", is_deprecated => false],
+    [name => "hook_civicrm_buildForm", is_deprecated => false],
+    [name => "hook_civicrm_postProcess", is_deprecated => false],
+    [name => "hook_civicrm_validateForm", is_deprecated => false],
+    [name => "hook_civicrm_alterTemplateFile", is_deprecated => false],
+    [name => "hook_civicrm_preProcess", is_deprecated => false],
+    [name => "hook_civicrm_idsException", is_deprecated => false],
   ],
   "GUI" => [
-    "hook_civicrm_buildAmount",
-    "hook_civicrm_caseSummary",
-    "hook_civicrm_customFieldOptions",
-    "hook_civicrm_dashboard",
-    "hook_civicrm_links",
-    "hook_civicrm_navigationMenu",
-    "hook_civicrm_pageRun",
-    "hook_civicrm_searchColumns",
-    "hook_civicrm_searchTasks",
-    "hook_civicrm_summary",
-    "hook_civicrm_summaryActions",
-    "hook_civicrm_tabs",
-    "hook_civicrm_xmlMenu",
-    "hook_civicrm_tabset",
-    "hook_civicrm_dashboard_defaults",
-    "hook_civicrm_contact_get_displayname",
-    "hook_civicrm_fieldOptions",
-    "hook_civicrm_alterMenu",
+    [name => "hook_civicrm_buildAmount", is_deprecated => false],
+    [name => "hook_civicrm_caseSummary", is_deprecated => false],
+    [name => "hook_civicrm_customFieldOptions", is_deprecated => true],
+    [name => "hook_civicrm_dashboard", is_deprecated => false],
+    [name => "hook_civicrm_links", is_deprecated => false],
+    [name => "hook_civicrm_navigationMenu", is_deprecated => false],
+    [name => "hook_civicrm_pageRun", is_deprecated => false],
+    [name => "hook_civicrm_searchColumns", is_deprecated => false],
+    [name => "hook_civicrm_searchTasks", is_deprecated => false],
+    [name => "hook_civicrm_summary", is_deprecated => false],
+    [name => "hook_civicrm_summaryActions", is_deprecated => false],
+    [name => "hook_civicrm_tabs", is_deprecated => true],
+    [name => "hook_civicrm_xmlMenu", is_deprecated => false],
+    [name => "hook_civicrm_tabset", is_deprecated => false],
+    [name => "hook_civicrm_dashboard_defaults", is_deprecated => false],
+    [name => "hook_civicrm_contact_get_displayname", is_deprecated => false],
+    [name => "hook_civicrm_fieldOptions", is_deprecated => false],
+    [name => "hook_civicrm_alterMenu", is_deprecated => false],
   ],
   "Mail" => [
-    "hook_civicrm_alterMailParams",
-    "hook_civicrm_emailProcessor",
-    "hook_civicrm_emailProcessorContact",
-    "hook_civicrm_mailingGroups",
-    "hook_civicrm_postEmailSend",
-    "hook_civicrm_alterMailer",
-    "hook_civicrm_unsubscribeGroups",
-    "hook_civicrm_alterMailContent",
-    "hook_civicrm_postMailing",
+    [name => "hook_civicrm_alterMailParams", is_deprecated => false],
+    [name => "hook_civicrm_emailProcessor", is_deprecated => false],
+    [name => "hook_civicrm_emailProcessorContact", is_deprecated => false],
+    [name => "hook_civicrm_mailingGroups", is_deprecated => false],
+    [name => "hook_civicrm_postEmailSend", is_deprecated => false],
+    [name => "hook_civicrm_alterMailer", is_deprecated => false],
+    [name => "hook_civicrm_unsubscribeGroups", is_deprecated => false],
+    [name => "hook_civicrm_alterMailContent", is_deprecated => false],
+    [name => "hook_civicrm_postMailing", is_deprecated => false],
   ],
   "Permission" => [
-    "hook_civicrm_aclGroup",
-    "hook_civicrm_aclWhereClause",
-    "hook_civicrm_alterAPIPermissions",
-    "hook_civicrm_permission_check",
-    "hook_civicrm_permission",
-    "hook_civicrm_selectWhereClause",
+    [name => "hook_civicrm_aclGroup", is_deprecated => false],
+    [name => "hook_civicrm_aclWhereClause", is_deprecated => false],
+    [name => "hook_civicrm_alterAPIPermissions", is_deprecated => false],
+    [name => "hook_civicrm_permission_check", is_deprecated => false],
+    [name => "hook_civicrm_permission", is_deprecated => false],
+    [name => "hook_civicrm_selectWhereClause", is_deprecated => false],
   ],
   "Uncategorized" => [
-    "hook_civicrm_alterCalculatedMembershipStatus",
-    "hook_civicrm_alterBarcode",
-    "hook_civicrm_alterBadge",
-    "hook_civicrm_alterPaymentProcessorParams",
-    "hook_civicrm_alterSettingsFolders",
-    "hook_civicrm_alterSettingsMetaData",
-    "hook_civicrm_apiWrappers",
-    "hook_civicrm_buildStateProvinceForCountry",
-    "hook_civicrm_config",
-    "hook_civicrm_contactListQuery",
-    "hook_civicrm_cron",
-    "hook_civicrm_dupeQuery",
-    "hook_civicrm_export",
-    "hook_civicrm_import",
-    "hook_civicrm_membershipTypeValues",
-    "hook_civicrm_tokens",
-    "hook_civicrm_tokenValues",
-    "hook_civicrm_queryObjects",
-    "hook_civicrm_check",
-    "hook_civicrm_optionValues",
-    "hook_civicrm_coreResourceList",
-    "hook_civicrm_angularModules",
-    "hook_civicrm_container",
-    "hook_civicrm_crudLink",
-    "hook_civicrm_fileSearches",
-    "hook_civicrm_notePrivacy",
-    "hook_civicrm_eventDiscount",
-    "hook_civicrm_recent",
-    "hook_civicrm_unhandledException",
-    "hook_civicrm_alterMailingLabelParams",
-    "hook_civicrm_geocoderFormat",
-    "hook_civicrm_alterLogTables",
+    [name => "hook_civicrm_alterCalculatedMembershipStatus", is_deprecated => false],
+    [name => "hook_civicrm_alterBarcode", is_deprecated => false],
+    [name => "hook_civicrm_alterBadge", is_deprecated => false],
+    [name => "hook_civicrm_alterPaymentProcessorParams", is_deprecated => false],
+    [name => "hook_civicrm_alterSettingsFolders", is_deprecated => false],
+    [name => "hook_civicrm_alterSettingsMetaData", is_deprecated => false],
+    [name => "hook_civicrm_apiWrappers", is_deprecated => false],
+    [name => "hook_civicrm_buildStateProvinceForCountry", is_deprecated => false],
+    [name => "hook_civicrm_config", is_deprecated => false],
+    [name => "hook_civicrm_contactListQuery", is_deprecated => true],
+    [name => "hook_civicrm_cron", is_deprecated => false],
+    [name => "hook_civicrm_dupeQuery", is_deprecated => false],
+    [name => "hook_civicrm_export", is_deprecated => false],
+    [name => "hook_civicrm_import", is_deprecated => false],
+    [name => "hook_civicrm_membershipTypeValues", is_deprecated => false],
+    [name => "hook_civicrm_tokens", is_deprecated => false],
+    [name => "hook_civicrm_tokenValues", is_deprecated => false],
+    [name => "hook_civicrm_queryObjects", is_deprecated => false],
+    [name => "hook_civicrm_check", is_deprecated => false],
+    [name => "hook_civicrm_optionValues", is_deprecated => true],
+    [name => "hook_civicrm_coreResourceList", is_deprecated => false],
+    [name => "hook_civicrm_angularModules", is_deprecated => false],
+    [name => "hook_civicrm_container", is_deprecated => false],
+    [name => "hook_civicrm_crudLink", is_deprecated => false],
+    [name => "hook_civicrm_fileSearches", is_deprecated => false],
+    [name => "hook_civicrm_notePrivacy", is_deprecated => false],
+    [name => "hook_civicrm_eventDiscount", is_deprecated => false],
+    [name => "hook_civicrm_recent", is_deprecated => false],
+    [name => "hook_civicrm_unhandledException", is_deprecated => false],
+    [name => "hook_civicrm_alterMailingLabelParams", is_deprecated => false],
+    [name => "hook_civicrm_geocoderFormat", is_deprecated => false],
+    [name => "hook_civicrm_alterLogTables", is_deprecated => false],
   ],
   "Case" => [
-    "hook_civicrm_caseChange",
-    "hook_civicrm_caseTypes",
-    "hook_civicrm_post_case_merge",
-    "hook_civicrm_pre_case_merge",
+    [name => "hook_civicrm_caseChange", is_deprecated => false],
+    [name => "hook_civicrm_caseTypes", is_deprecated => false],
+    [name => "hook_civicrm_post_case_merge", is_deprecated => false],
+    [name => "hook_civicrm_pre_case_merge", is_deprecated => false],
   ],
   "Batch" => [
-    "hook_civicrm_batchItems",
-    "hook_civicrm_batchQuery",
+    [name => "hook_civicrm_batchItems", is_deprecated => false],
+    [name => "hook_civicrm_batchQuery", is_deprecated => false],
   ],
   "Entity" => [
-    "hook_civicrm_entityTypes",
+    [name => "hook_civicrm_entityTypes", is_deprecated => false],
   ],
   "CiviRules" => [
-    "hook_civirules_alter_trigger_data",
-    "hook_civirules_logger",
+    [name => "hook_civirules_alter_trigger_data", is_deprecated => false],
+    [name => "hook_civirules_logger", is_deprecated => false],
   ],
   "Profile" => [
-    "hook_civicrm_buildProfile",
-    "hook_civicrm_buildUFGroupsForModule",
-    "hook_civicrm_processProfile",
-    "hook_civicrm_searchProfile",
-    "hook_civicrm_validateProfile",
-    "hook_civicrm_viewProfile",
+    [name => "hook_civicrm_buildProfile", is_deprecated => false],
+    [name => "hook_civicrm_buildUFGroupsForModule", is_deprecated => false],
+    [name => "hook_civicrm_processProfile", is_deprecated => false],
+    [name => "hook_civicrm_searchProfile", is_deprecated => false],
+    [name => "hook_civicrm_validateProfile", is_deprecated => false],
+    [name => "hook_civicrm_viewProfile", is_deprecated => false],
   ],
   "Report" => [
-    "hook_civicrm_alterReportVar",
+    [name => "hook_civicrm_alterReportVar", is_deprecated => false],
   ],
 ];
\ No newline at end of file

content-migration/hooks/migrate-hooks

@@ -16,20 +16,21 @@ chdir($hooks_dir);
 
 foreach ($hooks_by_category as $category => $hooks) {
   foreach ($hooks as $hook) {
-    $html = "$cache_dir/$hook";
+    $hook_name = $hook['name'];
+    $html = "$cache_dir/$hook_name";
     if ( file_exists($html) ) {
-      echo "converting $hook ... ";
+      echo "converting $hook_name ... ";
       $conversion_status = 1;
-      system("webpage2md $html > $hook.md", $conversion_status);
+      system("webpage2md $html > $hook_name.md", $conversion_status);
       if( $conversion_status == 0 ) {
         echo "done" . PHP_EOL;
       }
       else {
-        echo "ERROR CONVERTING $hook" . PHP_EOL;
+        echo "ERROR CONVERTING $hook_name" . PHP_EOL;
       }
     }
     else {
-      echo "WARNING: $hook not yet fetched" . PHP_EOL;
+      echo "WARNING: $hook_name not yet fetched" . PHP_EOL;
     }
   }
 }

content-migration/hooks/print-nav-yaml

@@ -6,6 +6,7 @@ include __DIR__ . '/hooks-by-category.php';
 foreach ($hooks_by_category as $category => $hooks) {
   echo "  - $category hooks:" . PHP_EOL;
   foreach ($hooks as $hook) {
-    echo "    - $hook: hooks/$hook.md" . PHP_EOL;
+    $hook_name = $hook['name'];
+    echo "    - $hook_name: hooks/$hook_name.md" . PHP_EOL;
   }
 }

content-migration/hooks/print-redirects

@@ -5,6 +5,7 @@ include __DIR__ . '/hooks-by-category.php';
 
 foreach ($hooks_by_category as $category => $hooks) {
   foreach ($hooks as $hook) {
-    echo "$hook hooks/$hook" . PHP_EOL;
+    $hook_name = $hook['name'];
+    echo "$hook_name hooks/$hook_name" . PHP_EOL;
   }
 }