Merge pull request #24285 from eileenmcnaughton/import_dec

Add 'Entity' to the information import parser classes provide
civicrm · Aug 17, 2022 · d437098 · d437098
2 parents 4035fca + f956dae
commit d437098
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 4 deletions.
diff --git a/CRM/Activity/Import/Parser/Activity.php b/CRM/Activity/Import/Parser/Activity.php
@@ -37,6 +37,7 @@ public static function getUserJobInfo(): array {
         'id' => 'activity_import',
         'name' => 'activity_import',
         'label' => ts('Activity Import'),
+        'entity' => 'Activity',
       ],
     ];
   }

diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php
@@ -100,6 +100,7 @@ public static function getUserJobInfo(): array {
         'id' => 'contact_import',
         'name' => 'contact_import',
         'label' => ts('Contact Import'),
+        'entity' => 'Contact',
       ],
     ];
   }

diff --git a/CRM/Contribute/Import/Parser/Contribution.php b/CRM/Contribute/Import/Parser/Contribution.php
@@ -58,6 +58,7 @@ public static function getUserJobInfo(): array {
         'id' => 'contribution_import',
         'name' => 'contribution_import',
         'label' => ts('Contribution Import'),
+        'entity' => 'Contribution',
       ],
     ];
   }

diff --git a/CRM/Core/BAO/UserJob.php b/CRM/Core/BAO/UserJob.php
@@ -135,10 +135,12 @@ public static function getStatuses(): array {
   /**
    * Get the types Import Jobs.
    *
-   * This is largely a placeholder at this stage. It will likely wind
-   * up as an option value so extensions can add different types.
-   *
-   * However, for now it just holds the one type being worked on.
+   * Each type is keyed by it's id and has
+   *   -id
+   *   -name
+   *   -label
+   *   -class
+   *   -entity
    *
    * @return array
    */
@@ -148,6 +150,7 @@ public static function getTypes(): array {
       $types = [];
       $classes = ClassScanner::get(['interface' => UserJobInterface::class]);
       foreach ($classes as $class) {
+        /* @var UserJobInterface $class */
         $declaredTypes = $class::getUserJobInfo();
         foreach ($declaredTypes as $index => $declaredType) {
           $declaredTypes[$index]['class'] = $class;

diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php
@@ -25,6 +25,7 @@ public static function getUserJobInfo(): array {
         'id' => 'custom_field_import',
         'name' => 'custom_field_import',
         'label' => ts('Multiple Value Custom Field Import'),
+        'entity' => 'Contact',
       ],
     ];
   }

diff --git a/CRM/Event/Import/Parser/Participant.php b/CRM/Event/Import/Parser/Participant.php
@@ -84,6 +84,7 @@ public static function getUserJobInfo(): array {
         'id' => 'participant_import',
         'name' => 'participant_import',
         'label' => ts('Participant Import'),
+        'entity' => 'Participant',
       ],
     ];
   }

diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php
@@ -70,6 +70,7 @@ public static function getUserJobInfo(): array {
         'id' => 'membership_import',
         'name' => 'membership_import',
         'label' => ts('Membership Import'),
+        'entity' => 'Membership',
       ],
     ];
   }