Merge pull request #26208 from colemanw/extensionComponentApi

dev/core#3961 - Move component Api4 files to component extensions

Civi/API/Request.php

@@ -48,12 +48,7 @@ public static function create(string $entity, string $action, array $params) {
         $className = CoreUtil::getApiClass($entity);
         $callable = [$className, $action];
         if (!$className || !is_callable($callable)) {
-          throw new \Civi\API\Exception\NotImplementedException("API ($entity, $action) does not exist (join the API team and implement it!)");
-        }
-        // Check enabled components
-        $daoName = \CRM_Core_DAO_AllCoreTables::getFullName($entity);
-        if ($daoName && !$daoName::isComponentEnabled()) {
-          throw new \Civi\API\Exception\NotImplementedException("$entity API is not available because " . $daoName::COMPONENT . " component is disabled");
+          throw new \Civi\API\Exception\NotImplementedException("API ($entity, $action) does not exist (or the extension it belongs to is not enabled).");
         }
         // Extra arguments used e.g. by dynamic entities like Multi-Record custom groups & the ECK extension
         $args = (array) CoreUtil::getInfoItem($entity, 'class_args');

Civi/Api4/Action/Entity/Get.php

@@ -15,7 +15,7 @@
 /**
  * Get the names & docblocks of all APIv4 entities.
  *
- * Scans for api entities in core, enabled components & enabled extensions.
+ * Scans for api entities in core & enabled extensions.
  *
  * Also includes pseudo-entities from multi-record custom groups.
  */
@@ -28,15 +28,11 @@ class Get extends \Civi\Api4\Generic\BasicGetAction {
   protected $includeCustom;
 
   /**
-   * Returns all APIv4 entities from core, enabled components and enabled extensions.
+   * Returns all APIv4 entities from core & enabled extensions.
    */
   protected function getRecords() {
     $provider = \Civi::service('action_object_provider');
     return array_filter($provider->getEntities(), function($entity) {
-      // Only include DAO entities from enabled components
-      if (!empty($entity['dao']) && !$entity['dao']::isComponentEnabled()) {
-        return FALSE;
-      }
       // Check custom group permissions
       if ($this->checkPermissions && in_array('CustomValue', $entity['type']) && !\CRM_Core_Permission::customGroupAdmin()) {
         // Hack to get the id from the "view" url. If that url changes tests should catch it and we'll think of a better way to get that id

ext/civi_campaign/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Campaign</namespace>
     <format>23.02.1</format>

ext/civi_case/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Case</namespace>
     <format>23.02.1</format>

ext/civi_contribute/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Contribute</namespace>
     <format>23.02.1</format>

ext/civi_event/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Event</namespace>
     <format>23.02.1</format>

ext/civi_mail/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Mailing</namespace>
     <format>23.02.1</format>

ext/civi_member/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Member</namespace>
     <format>23.02.1</format>

ext/civi_pledge/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Pledge</namespace>
     <format>23.02.1</format>

ext/civi_report/info.xml

@@ -24,6 +24,9 @@
     <psr0 prefix="CRM_" path="."/>
     <psr4 prefix="Civi\" path="Civi"/>
   </classloader>
+  <mixins>
+    <mixin>scan-classes@1.0.0</mixin>
+  </mixins>
   <civix>
     <namespace>CRM/Report</namespace>
     <format>23.02.1</format>

tests/phpunit/api/v4/Entity/ConformanceTest.php

@@ -85,10 +85,6 @@ public function tearDown(): void {
    * @throws \CRM_Core_Exception
    */
   public function getEntitiesHitech(): array {
-    // Ensure all components are enabled so their entities show up
-    foreach (array_keys(\CRM_Core_Component::getComponents()) as $component) {
-      \CRM_Core_BAO_ConfigSetting::enableComponent($component);
-    }
     return $this->toDataProviderArray(Entity::get(FALSE)->execute()->column('name'));
   }
 
@@ -102,20 +98,22 @@ public function getEntitiesHitech(): array {
    * @return array
    */
   public function getEntitiesLotech(): array {
-    // TODO: Auto-scan required core extensions like search_kit
-    $manual['add'] = ['SearchDisplay', 'SearchSegment'];
-    $manual['remove'] = ['CustomValue'];
+    // Core + required core extensions
+    $directores = ['', 'ext/search_kit/', 'ext/civi_*/'];
+    $manual['remove'] = ['CustomValue', 'SKEntity'];
     $manual['transform'] = ['CiviCase' => 'Case'];
 
     $scanned = [];
-    $srcDir = dirname(__DIR__, 5);
-    foreach ((array) glob("$srcDir/Civi/Api4/*.php") as $name) {
-      $fileName = basename($name, '.php');
-      $scanned[] = $manual['transform'][$fileName] ?? $fileName;
+    $baseDir = dirname(__DIR__, 5);
+    foreach ($directores as $directory) {
+      foreach ((array) glob("$baseDir/{$directory}Civi/Api4/*.php") as $name) {
+        $fileName = basename($name, '.php');
+        $scanned[] = $manual['transform'][$fileName] ?? $fileName;
+      }
     }
 
     $names = array_diff(
-      array_unique(array_merge($scanned, $manual['add'])),
+      $scanned,
       $manual['remove']
     );
 

tests/phpunit/api/v4/Entity/EntityTest.php

@@ -19,7 +19,6 @@
 
 namespace api\v4\Entity;
 
-use Civi\API\Exception\NotImplementedException;
 use Civi\Api4\Entity;
 use api\v4\Api4TestBase;
 
@@ -29,14 +28,11 @@
 class EntityTest extends Api4TestBase {
 
   public function testEntityGet() {
-    \CRM_Core_BAO_ConfigSetting::enableComponent('CiviEvent');
     $result = Entity::get(FALSE)
       ->execute()
       ->indexBy('name');
     $this->assertArrayHasKey('Entity', $result,
       "Entity::get missing itself");
-    $this->assertArrayHasKey('Participant', $result,
-      "Entity::get missing Participant");
 
     $this->assertEquals('CRM_Contact_DAO_Contact', $result['Contact']['dao']);
     $this->assertEquals(['DAOEntity'], $result['Contact']['type']);
@@ -63,15 +59,6 @@ public function testEntityComponent() {
     $this->assertArrayNotHasKey('Participant', $result,
       "Entity::get should not have Participant when CiviEvent disabled");
 
-    // Trying to use a CiviEvent API will fail when component is disabled
-    try {
-      \Civi\Api4\Participant::get(FALSE)->execute();
-      $this->fail();
-    }
-    catch (NotImplementedException $e) {
-      $this->assertStringContainsString('CiviEvent', $e->getMessage());
-    }
-
     \CRM_Core_BAO_ConfigSetting::enableComponent('CiviEvent');
     $result = Entity::get(FALSE)
       ->execute()