[REF] Relocate another deprecated utils function to the only class that calls it.

I removed the tests because they didn't test much & what they did test
seemed like stuff we should alter

diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php
index 20334b7f92c67d22a60b1a59116d20f1120c98e7..b35004675b33dc566f62b81028d986ddf5b68d18 100644 (file)
--- a/CRM/Contact/Import/Parser/Contact.php
+++ b/CRM/Contact/Import/Parser/Contact.php
@@ -1561,7 +1561,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser {
     // setting required check to false, CRM-2839
     // plus we do our own required check in import
     try {
-      $error = _civicrm_api3_deprecated_contact_check_params($formatted, $dupeCheck, $dedupeRuleGroupID);
+      $error = $this->deprecated_contact_check_params($formatted, $dupeCheck, $dedupeRuleGroupID);
       if ($error) {
         return $error;
       }
@@ -2122,4 +2122,116 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser {
     }
   }
 
+  /**
+   * @param array $params
+   * @param bool $dupeCheck
+   * @param null|int $dedupeRuleGroupID
+   *
+   * @throws \CRM_Core_Exception
+   */
+  public function deprecated_contact_check_params(
+    &$params,
+    $dupeCheck = TRUE,
+    $dedupeRuleGroupID = NULL) {
+
+    $requiredCheck = TRUE;
+
+    if (isset($params['id']) && is_numeric($params['id'])) {
+      $requiredCheck = FALSE;
+    }
+    if ($requiredCheck) {
+      if (isset($params['id'])) {
+        $required = ['Individual', 'Household', 'Organization'];
+      }
+      $required = [
+        'Individual' => [
+          ['first_name', 'last_name'],
+          'email',
+        ],
+        'Household' => [
+          'household_name',
+        ],
+        'Organization' => [
+          'organization_name',
+        ],
+      ];
+
+      // contact_type has a limited number of valid values
+      if (empty($params['contact_type'])) {
+        throw new CRM_Core_Exception("No Contact Type");
+      }
+      $fields = $required[$params['contact_type']] ?? NULL;
+      if ($fields == NULL) {
+        throw new CRM_Core_Exception("Invalid Contact Type: {$params['contact_type']}");
+      }
+
+      if ($csType = CRM_Utils_Array::value('contact_sub_type', $params)) {
+        if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($csType, $params['contact_type']))) {
+          throw new CRM_Core_Exception("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $csType));
+        }
+      }
+
+      if (empty($params['contact_id']) && !empty($params['id'])) {
+        $valid = FALSE;
+        $error = '';
+        foreach ($fields as $field) {
+          if (is_array($field)) {
+            $valid = TRUE;
+            foreach ($field as $element) {
+              if (empty($params[$element])) {
+                $valid = FALSE;
+                $error .= $element;
+                break;
+              }
+            }
+          }
+          else {
+            if (!empty($params[$field])) {
+              $valid = TRUE;
+            }
+          }
+          if ($valid) {
+            break;
+          }
+        }
+
+        if (!$valid) {
+          throw new CRM_Core_Exception("Required fields not found for {$params['contact_type']} : $error");
+        }
+      }
+    }
+
+    if ($dupeCheck) {
+      // @todo switch to using api version
+      // $dupes = civicrm_api3('Contact', 'duplicatecheck', (array('match' => $params, 'dedupe_rule_id' => $dedupeRuleGroupID)));
+      // $ids = $dupes['count'] ? implode(',', array_keys($dupes['values'])) : NULL;
+      $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised', [], CRM_Utils_Array::value('check_permissions', $params), $dedupeRuleGroupID);
+      if ($ids != NULL) {
+        $error = CRM_Core_Error::createError("Found matching contacts: " . implode(',', $ids),
+          CRM_Core_Error::DUPLICATE_CONTACT,
+          'Fatal', $ids
+        );
+        return civicrm_api3_create_error($error->pop());
+      }
+    }
+
+    // check for organisations with same name
+    if (!empty($params['current_employer'])) {
+      $organizationParams = ['organization_name' => $params['current_employer']];
+      $dupeIds = CRM_Contact_BAO_Contact::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', [], FALSE);
+
+      // check for mismatch employer name and id
+      if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)
+      ) {
+        throw new CRM_Core_Exception('Employer name and Employer id Mismatch');
+      }
+
+      // show error if multiple organisation with same name exist
+      if (empty($params['employer_id']) && (count($dupeIds) > 1)
+      ) {
+        return civicrm_api3_create_error('Found more than one Organisation with same Name.');
+      }
+    }
+  }
+
 }

diff --git a/CRM/Utils/DeprecatedUtils.php b/CRM/Utils/DeprecatedUtils.php
index 1fe35cc8da1ed6fa345212f9e1670dbc1723cb9f..e614413bc13e7b8dca0fa040500bd6f88baf7411 100644 (file)
--- a/CRM/Utils/DeprecatedUtils.php
+++ b/CRM/Utils/DeprecatedUtils.php
@@ -568,118 +568,6 @@ function _civicrm_api3_deprecated_participant_check_params($params, $checkDuplic
   return TRUE;
 }
 
-/**
- * @param array $params
- * @param bool $dupeCheck
- * @param null|int $dedupeRuleGroupID
- *
- * @throws \CRM_Core_Exception
- */
-function _civicrm_api3_deprecated_contact_check_params(
-  &$params,
-  $dupeCheck = TRUE,
-  $dedupeRuleGroupID = NULL) {
-
-  $requiredCheck = TRUE;
-
-  if (isset($params['id']) && is_numeric($params['id'])) {
-    $requiredCheck = FALSE;
-  }
-  if ($requiredCheck) {
-    if (isset($params['id'])) {
-      $required = ['Individual', 'Household', 'Organization'];
-    }
-    $required = [
-      'Individual' => [
-        ['first_name', 'last_name'],
-        'email',
-      ],
-      'Household' => [
-        'household_name',
-      ],
-      'Organization' => [
-        'organization_name',
-      ],
-    ];
-
-    // contact_type has a limited number of valid values
-    if (empty($params['contact_type'])) {
-      throw new CRM_Core_Exception("No Contact Type");
-    }
-    $fields = $required[$params['contact_type']] ?? NULL;
-    if ($fields == NULL) {
-      throw new CRM_Core_Exception("Invalid Contact Type: {$params['contact_type']}");
-    }
-
-    if ($csType = CRM_Utils_Array::value('contact_sub_type', $params)) {
-      if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($csType, $params['contact_type']))) {
-        throw new CRM_Core_Exception("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $csType));
-      }
-    }
-
-    if (empty($params['contact_id']) && !empty($params['id'])) {
-      $valid = FALSE;
-      $error = '';
-      foreach ($fields as $field) {
-        if (is_array($field)) {
-          $valid = TRUE;
-          foreach ($field as $element) {
-            if (empty($params[$element])) {
-              $valid = FALSE;
-              $error .= $element;
-              break;
-            }
-          }
-        }
-        else {
-          if (!empty($params[$field])) {
-            $valid = TRUE;
-          }
-        }
-        if ($valid) {
-          break;
-        }
-      }
-
-      if (!$valid) {
-        throw new CRM_Core_Exception("Required fields not found for {$params['contact_type']} : $error");
-      }
-    }
-  }
-
-  if ($dupeCheck) {
-    // @todo switch to using api version
-    // $dupes = civicrm_api3('Contact', 'duplicatecheck', (array('match' => $params, 'dedupe_rule_id' => $dedupeRuleGroupID)));
-    // $ids = $dupes['count'] ? implode(',', array_keys($dupes['values'])) : NULL;
-    $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised', [], CRM_Utils_Array::value('check_permissions', $params), $dedupeRuleGroupID);
-    if ($ids != NULL) {
-      $error = CRM_Core_Error::createError("Found matching contacts: " . implode(',', $ids),
-        CRM_Core_Error::DUPLICATE_CONTACT,
-        'Fatal', $ids
-      );
-      return civicrm_api3_create_error($error->pop());
-    }
-  }
-
-  // check for organisations with same name
-  if (!empty($params['current_employer'])) {
-    $organizationParams = ['organization_name' => $params['current_employer']];
-    $dupeIds = CRM_Contact_BAO_Contact::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', [], FALSE);
-
-    // check for mismatch employer name and id
-    if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)
-    ) {
-      throw new CRM_Core_Exception('Employer name and Employer id Mismatch');
-    }
-
-    // show error if multiple organisation with same name exist
-    if (empty($params['employer_id']) && (count($dupeIds) > 1)
-    ) {
-      return civicrm_api3_create_error('Found more than one Organisation with same Name.');
-    }
-  }
-}
-
 /**
  * @param $result
  * @param int $activityTypeID

diff --git a/tests/phpunit/CRM/Utils/DeprecatedUtilsTest.php b/tests/phpunit/CRM/Utils/DeprecatedUtilsTest.php
deleted file mode 100644 (file)
index 3091598..0000000
--- a/tests/phpunit/CRM/Utils/DeprecatedUtilsTest.php
+++ /dev/null
@@ -1,82 +0,0 @@
-<?php
-
-require_once 'CRM/Utils/DeprecatedUtils.php';
-
-/**
- * Class CRM_Utils_DeprecatedUtilsTest
- * @group headless
- */
-class CRM_Utils_DeprecatedUtilsTest extends CiviUnitTestCase {
-
-  public function setUp() {
-    parent::setUp();
-  }
-
-  public function tearDown() {
-    // truncate a few tables
-    $tablesToTruncate = [
-      'civicrm_contact',
-      'civicrm_email',
-      'civicrm_contribution',
-      'civicrm_website',
-    ];
-
-    $this->quickCleanup($tablesToTruncate);
-  }
-
-  /**
-   *  Test civicrm_contact_check_params with no contact type.
-   */
-  public function testCheckParamsWithNoContactType(): void {
-    $params = ['foo' => 'bar'];
-    try {
-      _civicrm_api3_deprecated_contact_check_params($params, FALSE);
-    }
-    catch (CRM_Core_Exception $e) {
-      return;
-    }
-    $this->fail('An exception should have been thrown');
-  }
-
-  /**
-   * Test civicrm_contact_check_params with a duplicate.
-   *
-   * @throws \CiviCRM_API3_Exception
-   */
-  public function testCheckParamsWithDuplicateContact2(): void {
-    $this->individualCreate(['first_name' => 'Test', 'last_name' => 'Contact', 'email' => 'TestContact@example.com']);
-
-    $params = [
-      'first_name' => 'Test',
-      'last_name' => 'Contact',
-      'email' => 'TestContact@example.com',
-      'contact_type' => 'Individual',
-    ];
-    try {
-      $error = _civicrm_api3_deprecated_contact_check_params($params, TRUE);
-      $this->assertEquals(1, $error['is_error']);
-    }
-    catch (CRM_Core_Exception $e) {
-      $this->assertRegexp("/matching contacts.*1/s",
-        $e->getMessage()
-      );
-      return;
-    }
-    // $this->fail('Exception was not optional');
-  }
-
-  /**
-   *  Test civicrm_contact_check_params with check for required params.
-   */
-  public function testCheckParamsWithNoParams(): void {
-    $params = [];
-    try {
-      _civicrm_api3_deprecated_contact_check_params($params, FALSE);
-    }
-    catch (CRM_Core_Exception $e) {
-      return;
-    }
-    $this->fail('Exception required');
-  }
-
-}