Rename afform_gui -> afform_admin
[civicrm-core.git] / ext / afform / admin / afform_admin.civix.php
similarity index 78%
rename from ext/afform/gui/afform_gui.civix.php
rename to ext/afform/admin/afform_admin.civix.php
index b384f42b276ce31c6760cec925d1ccb4e5d65afb..9db46b2caab539d6d0a53773d953166c6631cd73 100644 (file)
@@ -6,10 +6,10 @@
  * The ExtensionUtil class provides small stubs for accessing resources of this
  * extension.
  */
-class CRM_AfformGui_ExtensionUtil {
-  const SHORT_NAME = "afform_gui";
-  const LONG_NAME = "org.civicrm.afform-gui";
-  const CLASS_PREFIX = "CRM_AfformGui";
+class CRM_AfformAdmin_ExtensionUtil {
+  const SHORT_NAME = "afform_admin";
+  const LONG_NAME = "org.civicrm.afform_admin";
+  const CLASS_PREFIX = "CRM_AfformAdmin";
 
   /**
    * Translate a string using the extension's domain.
@@ -77,14 +77,14 @@ class CRM_AfformGui_ExtensionUtil {
 
 }
 
-use CRM_AfformGui_ExtensionUtil as E;
+use CRM_AfformAdmin_ExtensionUtil as E;
 
 /**
  * (Delegated) Implements hook_civicrm_config().
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
  */
-function _afform_gui_civix_civicrm_config(&$config = NULL) {
+function _afform_admin_civix_civicrm_config(&$config = NULL) {
   static $configured = FALSE;
   if ($configured) {
     return;
@@ -114,8 +114,8 @@ function _afform_gui_civix_civicrm_config(&$config = NULL) {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
  */
-function _afform_gui_civix_civicrm_xmlMenu(&$files) {
-  foreach (_afform_gui_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
+function _afform_admin_civix_civicrm_xmlMenu(&$files) {
+  foreach (_afform_admin_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
     $files[] = $file;
   }
 }
@@ -125,9 +125,9 @@ function _afform_gui_civix_civicrm_xmlMenu(&$files) {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
  */
-function _afform_gui_civix_civicrm_install() {
-  _afform_gui_civix_civicrm_config();
-  if ($upgrader = _afform_gui_civix_upgrader()) {
+function _afform_admin_civix_civicrm_install() {
+  _afform_admin_civix_civicrm_config();
+  if ($upgrader = _afform_admin_civix_upgrader()) {
     $upgrader->onInstall();
   }
 }
@@ -137,9 +137,9 @@ function _afform_gui_civix_civicrm_install() {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
  */
-function _afform_gui_civix_civicrm_postInstall() {
-  _afform_gui_civix_civicrm_config();
-  if ($upgrader = _afform_gui_civix_upgrader()) {
+function _afform_admin_civix_civicrm_postInstall() {
+  _afform_admin_civix_civicrm_config();
+  if ($upgrader = _afform_admin_civix_upgrader()) {
     if (is_callable([$upgrader, 'onPostInstall'])) {
       $upgrader->onPostInstall();
     }
@@ -151,9 +151,9 @@ function _afform_gui_civix_civicrm_postInstall() {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
  */
-function _afform_gui_civix_civicrm_uninstall() {
-  _afform_gui_civix_civicrm_config();
-  if ($upgrader = _afform_gui_civix_upgrader()) {
+function _afform_admin_civix_civicrm_uninstall() {
+  _afform_admin_civix_civicrm_config();
+  if ($upgrader = _afform_admin_civix_upgrader()) {
     $upgrader->onUninstall();
   }
 }
@@ -163,9 +163,9 @@ function _afform_gui_civix_civicrm_uninstall() {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
  */
-function _afform_gui_civix_civicrm_enable() {
-  _afform_gui_civix_civicrm_config();
-  if ($upgrader = _afform_gui_civix_upgrader()) {
+function _afform_admin_civix_civicrm_enable() {
+  _afform_admin_civix_civicrm_config();
+  if ($upgrader = _afform_admin_civix_upgrader()) {
     if (is_callable([$upgrader, 'onEnable'])) {
       $upgrader->onEnable();
     }
@@ -178,9 +178,9 @@ function _afform_gui_civix_civicrm_enable() {
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
  * @return mixed
  */
-function _afform_gui_civix_civicrm_disable() {
-  _afform_gui_civix_civicrm_config();
-  if ($upgrader = _afform_gui_civix_upgrader()) {
+function _afform_admin_civix_civicrm_disable() {
+  _afform_admin_civix_civicrm_config();
+  if ($upgrader = _afform_admin_civix_upgrader()) {
     if (is_callable([$upgrader, 'onDisable'])) {
       $upgrader->onDisable();
     }
@@ -199,21 +199,21 @@ function _afform_gui_civix_civicrm_disable() {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
  */
-function _afform_gui_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
-  if ($upgrader = _afform_gui_civix_upgrader()) {
+function _afform_admin_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
+  if ($upgrader = _afform_admin_civix_upgrader()) {
     return $upgrader->onUpgrade($op, $queue);
   }
 }
 
 /**
- * @return CRM_AfformGui_Upgrader
+ * @return CRM_AfformAdmin_Upgrader
  */
-function _afform_gui_civix_upgrader() {
-  if (!file_exists(__DIR__ . '/CRM/AfformGui/Upgrader.php')) {
+function _afform_admin_civix_upgrader() {
+  if (!file_exists(__DIR__ . '/CRM/AfformAdmin/Upgrader.php')) {
     return NULL;
   }
   else {
-    return CRM_AfformGui_Upgrader_Base::instance();
+    return CRM_AfformAdmin_Upgrader_Base::instance();
   }
 }
 
@@ -228,7 +228,7 @@ function _afform_gui_civix_upgrader() {
  *
  * @return array
  */
-function _afform_gui_civix_find_files($dir, $pattern) {
+function _afform_admin_civix_find_files($dir, $pattern) {
   if (is_callable(['CRM_Utils_File', 'findFiles'])) {
     return CRM_Utils_File::findFiles($dir, $pattern);
   }
@@ -237,7 +237,7 @@ function _afform_gui_civix_find_files($dir, $pattern) {
   $result = [];
   while (!empty($todos)) {
     $subdir = array_shift($todos);
-    foreach (_afform_gui_civix_glob("$subdir/$pattern") as $match) {
+    foreach (_afform_admin_civix_glob("$subdir/$pattern") as $match) {
       if (!is_dir($match)) {
         $result[] = $match;
       }
@@ -264,8 +264,8 @@ function _afform_gui_civix_find_files($dir, $pattern) {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
  */
-function _afform_gui_civix_civicrm_managed(&$entities) {
-  $mgdFiles = _afform_gui_civix_find_files(__DIR__, '*.mgd.php');
+function _afform_admin_civix_civicrm_managed(&$entities) {
+  $mgdFiles = _afform_admin_civix_find_files(__DIR__, '*.mgd.php');
   sort($mgdFiles);
   foreach ($mgdFiles as $file) {
     $es = include $file;
@@ -290,12 +290,12 @@ function _afform_gui_civix_civicrm_managed(&$entities) {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
  */
-function _afform_gui_civix_civicrm_caseTypes(&$caseTypes) {
+function _afform_admin_civix_civicrm_caseTypes(&$caseTypes) {
   if (!is_dir(__DIR__ . '/xml/case')) {
     return;
   }
 
-  foreach (_afform_gui_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
+  foreach (_afform_admin_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));
@@ -318,12 +318,12 @@ function _afform_gui_civix_civicrm_caseTypes(&$caseTypes) {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
  */
-function _afform_gui_civix_civicrm_angularModules(&$angularModules) {
+function _afform_admin_civix_civicrm_angularModules(&$angularModules) {
   if (!is_dir(__DIR__ . '/ang')) {
     return;
   }
 
-  $files = _afform_gui_civix_glob(__DIR__ . '/ang/*.ang.php');
+  $files = _afform_admin_civix_glob(__DIR__ . '/ang/*.ang.php');
   foreach ($files as $file) {
     $name = preg_replace(':\.ang\.php$:', '', basename($file));
     $module = include $file;
@@ -339,8 +339,8 @@ function _afform_gui_civix_civicrm_angularModules(&$angularModules) {
  *
  * Find any and return any files matching "*.theme.php"
  */
-function _afform_gui_civix_civicrm_themes(&$themes) {
-  $files = _afform_gui_civix_glob(__DIR__ . '/*.theme.php');
+function _afform_admin_civix_civicrm_themes(&$themes) {
+  $files = _afform_admin_civix_glob(__DIR__ . '/*.theme.php');
   foreach ($files as $file) {
     $themeMeta = include $file;
     if (empty($themeMeta['name'])) {
@@ -366,7 +366,7 @@ function _afform_gui_civix_civicrm_themes(&$themes) {
  *
  * @return array
  */
-function _afform_gui_civix_glob($pattern) {
+function _afform_admin_civix_glob($pattern) {
   $result = glob($pattern);
   return is_array($result) ? $result : [];
 }
@@ -382,7 +382,7 @@ function _afform_gui_civix_glob($pattern) {
  *
  * @return bool
  */
-function _afform_gui_civix_insert_navigation_menu(&$menu, $path, $item) {
+function _afform_admin_civix_insert_navigation_menu(&$menu, $path, $item) {
   // If we are done going down the path, insert menu
   if (empty($path)) {
     $menu[] = [
@@ -403,7 +403,7 @@ function _afform_gui_civix_insert_navigation_menu(&$menu, $path, $item) {
         if (!isset($entry['child'])) {
           $entry['child'] = [];
         }
-        $found = _afform_gui_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
+        $found = _afform_admin_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
       }
     }
     return $found;
@@ -413,9 +413,9 @@ function _afform_gui_civix_insert_navigation_menu(&$menu, $path, $item) {
 /**
  * (Delegated) Implements hook_civicrm_navigationMenu().
  */
-function _afform_gui_civix_navigationMenu(&$nodes) {
+function _afform_admin_civix_navigationMenu(&$nodes) {
   if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
-    _afform_gui_civix_fixNavigationMenu($nodes);
+    _afform_admin_civix_fixNavigationMenu($nodes);
   }
 }
 
@@ -423,17 +423,17 @@ function _afform_gui_civix_navigationMenu(&$nodes) {
  * Given a navigation menu, generate navIDs for any items which are
  * missing them.
  */
-function _afform_gui_civix_fixNavigationMenu(&$nodes) {
+function _afform_admin_civix_fixNavigationMenu(&$nodes) {
   $maxNavID = 1;
   array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
     if ($key === 'navID') {
       $maxNavID = max($maxNavID, $item);
     }
   });
-  _afform_gui_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
+  _afform_admin_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
 }
 
-function _afform_gui_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
+function _afform_admin_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
   $origKeys = array_keys($nodes);
   foreach ($origKeys as $origKey) {
     if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
@@ -448,7 +448,7 @@ function _afform_gui_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID
       $origKey = $newKey;
     }
     if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
-      _afform_gui_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
+      _afform_admin_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
     }
   }
 }
@@ -458,7 +458,7 @@ function _afform_gui_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
  */
-function _afform_gui_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
+function _afform_admin_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
   $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
   if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
     $metaDataFolders[] = $settingsDir;
@@ -472,6 +472,6 @@ function _afform_gui_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
  */
-function _afform_gui_civix_civicrm_entityTypes(&$entityTypes) {
+function _afform_admin_civix_civicrm_entityTypes(&$entityTypes) {
   $entityTypes = array_merge($entityTypes, []);
 }