From ca5770c0e3f3b668b9da2bfcd7f0e1a840aecfa2 Mon Sep 17 00:00:00 2001
From: colemanw <coleman@civicrm.org>
Date: Sat, 20 May 2023 21:33:50 -0400
Subject: [PATCH] Add deprecation warning to functions in renamed classes

Targeting these particular functions because a universe search shows they are used outside of core.
---
 CRM/ACL/BAO/EntityRole.php         |  2 --
 CRM/Dedupe/BAO/DedupeRuleGroup.php |  4 ++--
 CRM/Dedupe/BAO/Exception.php       |  2 +-
 CRM/Dedupe/BAO/Rule.php            | 32 ++++++++++++++++++++++--------
 CRM/Dedupe/BAO/RuleGroup.php       | 21 ++++++++++++--------
 5 files changed, 40 insertions(+), 21 deletions(-)

diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php
index 3bacbf7639..5620f6f55e 100644
--- a/CRM/ACL/BAO/EntityRole.php
+++ b/CRM/ACL/BAO/EntityRole.php
@@ -16,8 +16,6 @@
  */
 
 /**
- *  Access Control EntityRole.
- *
  * @deprecated
  */
 class CRM_ACL_BAO_EntityRole extends CRM_ACL_BAO_ACLEntityRole {}
diff --git a/CRM/Dedupe/BAO/DedupeRuleGroup.php b/CRM/Dedupe/BAO/DedupeRuleGroup.php
index b15000917c..c45e90560a 100644
--- a/CRM/Dedupe/BAO/DedupeRuleGroup.php
+++ b/CRM/Dedupe/BAO/DedupeRuleGroup.php
@@ -555,10 +555,10 @@ class CRM_Dedupe_BAO_DedupeRuleGroup extends CRM_Dedupe_DAO_DedupeRuleGroup {
    *   Individual, Household or Organization.
    *
    *
-   * @return array
+   * @return array|string[]
    *   id => "nice name" of rule group
    */
-  public static function getByType($contactType = NULL) {
+  public static function getByType($contactType = NULL): array {
     $dao = new CRM_Dedupe_DAO_DedupeRuleGroup();
 
     if ($contactType) {
diff --git a/CRM/Dedupe/BAO/Exception.php b/CRM/Dedupe/BAO/Exception.php
index e3777e7fe6..ef4081c8a9 100644
--- a/CRM/Dedupe/BAO/Exception.php
+++ b/CRM/Dedupe/BAO/Exception.php
@@ -16,6 +16,6 @@
  */
 
 /**
- * Manages dedupe exceptions - ie pairs marked as non-duplicates.
+ * @deprecated
  */
 class CRM_Dedupe_BAO_Exception extends CRM_Dedupe_BAO_DedupeException {}
diff --git a/CRM/Dedupe/BAO/Rule.php b/CRM/Dedupe/BAO/Rule.php
index 0e4d31f948..980b473150 100644
--- a/CRM/Dedupe/BAO/Rule.php
+++ b/CRM/Dedupe/BAO/Rule.php
@@ -10,13 +10,29 @@
  */
 
 /**
- *
- * @package CRM
- * @copyright CiviCRM LLC https://civicrm.org/licensing
+ * @deprecated
  */
+class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_BAO_DedupeRule {
 
-/**
- * The CiviCRM duplicate discovery engine is based on an
- * algorithm designed by David Strauss <david@fourkitchens.com>.
- */
-class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_BAO_DedupeRule {}
+  /**
+   * @param int $cid
+   * @param int $oid
+   * @deprecated
+   * @return bool
+   */
+  public static function validateContacts($cid, $oid) {
+    CRM_Core_Error::deprecatedFunctionWarning('CRM_Dedupe_BAO_DedupeRule::validateContacts');
+    return parent::validateContacts($cid, $oid);
+  }
+
+  /**
+   * @param array $params
+   * @deprecated
+   * @return array
+   */
+  public static function dedupeRuleFields($params) {
+    CRM_Core_Error::deprecatedFunctionWarning('CRM_Dedupe_BAO_DedupeRule::dedupeRuleFields');
+    return parent::dedupeRuleFields($params);
+  }
+
+}
diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php
index 1b70dcbffe..2caf833505 100644
--- a/CRM/Dedupe/BAO/RuleGroup.php
+++ b/CRM/Dedupe/BAO/RuleGroup.php
@@ -10,13 +10,18 @@
  */
 
 /**
- *
- * @package CRM
- * @copyright CiviCRM LLC https://civicrm.org/licensing
+ * @deprecated
  */
+class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_BAO_DedupeRuleGroup {
 
-/**
- * The CiviCRM duplicate discovery engine is based on an
- * algorithm designed by David Strauss <david@fourkitchens.com>.
- */
-class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_BAO_DedupeRuleGroup {}
+  /**
+   * @deprecated
+   * @param string $contactType
+   * @return array|string[]
+   */
+  public static function getByType($contactType = NULL): array {
+    CRM_Core_Error::deprecatedFunctionWarning('APIv4 DedupeRuleGroup::get');
+    return parent::getByType($contactType);
+  }
+
+}
-- 
2.25.1