Merge pull request #20283 from colemanw/afformEnabledEntities

Afform - hide disabled contact types & entities from disabled components/extensions
civicrm · May 13, 2021 · 69cc131 · 69cc131
2 parents 175b0a0 + 7ed57b0
commit 69cc131
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 26 deletions.
diff --git a/ext/afform/admin/Civi/AfformAdmin/AfformAdminMeta.php b/ext/afform/admin/Civi/AfformAdmin/AfformAdminMeta.php
@@ -51,21 +51,27 @@ public static function getAfformEntity($entityName) {
   }
 
   /**
-   * @param $entityName
-   * @return array
+   * Get info about an api entity, with special handling for contact types
+   * @param string $entityName
+   * @return array|null
    */
-  public static function getApiEntity($entityName) {
-    if (in_array($entityName, ['Individual', 'Household', 'Organization'])) {
-      $contactTypes = \CRM_Contact_BAO_ContactType::basicTypeInfo();
+  public static function getApiEntity(string $entityName) {
+    $contactTypes = \CRM_Contact_BAO_ContactType::basicTypeInfo();
+    if (isset($contactTypes[$entityName])) {
       return [
         'entity' => 'Contact',
+        'contact_type' => $entityName,
         'label' => $contactTypes[$entityName]['label'],
       ];
     }
     $info = \Civi\Api4\Entity::get(FALSE)
       ->addWhere('name', '=', $entityName)
       ->addSelect('title', 'icon')
       ->execute()->first();
+    if (!$info) {
+      // Disabled contact type or nonexistent api entity
+      return NULL;
+    }
     return [
       'entity' => $entityName,
       'label' => $info['title'],
@@ -127,21 +133,15 @@ public static function getGuiSettings() {
       if (is_dir($dir)) {
         // Scan for entities
         foreach (glob($dir . 'afformEntities/*.php') as $file) {
-          $entity = include $file;
-          $afformEntity = basename($file, '.php');
-          // Contact pseudo-entities (Individual, Organization, Household) get special treatment,
-          // notably their fields are pre-loaded since they are both commonly-used and nonstandard
-          if (!empty($entity['contact_type'])) {
-            // Skip disabled contact types
-            if (!isset($contactTypes[$entity['contact_type']])) {
-              continue;
-            }
-            $entity['label'] = $contactTypes[$entity['contact_type']]['label'];
-          }
-          elseif (empty($entity['label']) || empty($entity['icon'])) {
-            $entity += self::getApiEntity($entity['entity']);
+          $entityInfo = include $file;
+          $entityName = basename($file, '.php');
+          $apiInfo = self::getApiEntity($entityInfo['entity'] ?? $entityName);
+          // Skip disabled contact types & entities from disabled components/extensions
+          if (!$apiInfo) {
+            continue;
           }
-          $data['entities'][$afformEntity] = $entity;
+          $entityInfo += $apiInfo;
+          $data['entities'][$entityName] = $entityInfo;
         }
         // Scan for input types
         foreach (glob($dir . 'ang/afGuiEditor/inputType/*.html') as $file) {

diff --git a/ext/afform/admin/afformEntities/Activity.php b/ext/afform/admin/afformEntities/Activity.php
@@ -1,6 +1,5 @@
 <?php
 return [
-  'entity' => 'Activity',
   'defaults' => "{'url-autofill': '1'}",
   'boilerplate' => [
     ['#tag' => 'af-field', 'name' => 'subject'],

diff --git a/ext/afform/admin/afformEntities/Household.php b/ext/afform/admin/afformEntities/Household.php
@@ -1,7 +1,5 @@
 <?php
 return [
-  'entity' => 'Contact',
-  'contact_type' => 'Household',
   'defaults' => "{
     data: {
       contact_type: 'Household',

diff --git a/ext/afform/admin/afformEntities/Individual.php b/ext/afform/admin/afformEntities/Individual.php
@@ -1,7 +1,5 @@
 <?php
 return [
-  'entity' => 'Contact',
-  'contact_type' => 'Individual',
   'defaults' => "{
     data: {
       contact_type: 'Individual',

diff --git a/ext/afform/admin/afformEntities/Organization.php b/ext/afform/admin/afformEntities/Organization.php
@@ -1,7 +1,5 @@
 <?php
 return [
-  'entity' => 'Contact',
-  'contact_type' => 'Organization',
   'defaults' => "{
     data: {
       contact_type: 'Organization',