APIv4 - Emit notices about deprecated join aliases

civicrm · Jun 27, 2021 · 0408d32 · 0408d32
1 parent 2b145b8
commit 0408d32
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 17 deletions.
diff --git a/Civi/Api4/Service/Schema/Joiner.php b/Civi/Api4/Service/Schema/Joiner.php
@@ -70,6 +70,9 @@ public function autoJoin(Api4SelectQuery $query, array $joinPath, $side = 'LEFT'
       if ($joinEntity && !$query->checkEntityAccess($joinEntity)) {
         throw new UnauthorizedException('Cannot join to ' . $joinEntity);
       }
+      if ($link->isDeprecated()) {
+        \CRM_Core_Error::deprecatedWarning("Deprecated join alias '$alias' used in APIv4 get. Should be changed to '{$alias}_id'");
+      }
 
       $bao = $joinEntity ? CoreUtil::getBAOFromApiName($joinEntity) : NULL;
       $conditions = $link->getConditionsForJoin($baseTableAlias);

diff --git a/tests/phpunit/api/v4/Entity/ContactJoinTest.php b/tests/phpunit/api/v4/Entity/ContactJoinTest.php
@@ -46,23 +46,6 @@ public function setUpHeadless() {
     return parent::setUpHeadless();
   }
 
-  public function testContactJoinDeprecated() {
-    $contact = $this->getReference('test_contact_1');
-    $entitiesToTest = ['Address', 'OpenID', 'IM', 'Website', 'Email', 'Phone'];
-
-    foreach ($entitiesToTest as $entity) {
-      $results = civicrm_api4($entity, 'get', [
-        'where' => [['contact_id', '=', $contact['id']]],
-        // Deprecated syntax (new syntax is `contact_id.*` not `contact.*`)
-        'select' => ['contact.*_name', 'contact.id'],
-      ]);
-      foreach ($results as $result) {
-        $this->assertEquals($contact['id'], $result['contact.id']);
-        $this->assertEquals($contact['display_name'], $result['contact.display_name']);
-      }
-    }
-  }
-
   public function testContactJoin() {
     $contact = $this->getReference('test_contact_1');
     $entitiesToTest = ['Address', 'OpenID', 'IM', 'Website', 'Email', 'Phone'];