Api4 - Improve Entity::get

Ensure that every php file found by the scanner is_a class inheriting from AbstractEntity.
Remove the CustomValue class by virtue of its class type instead of manually remove it.
Improve performance when fetching entities by name.

diff --git a/Civi/Api4/Action/Entity/Get.php b/Civi/Api4/Action/Entity/Get.php
index 457e11f67f7de756f7558c2e986e7b1773b5833c..bf7fd148c6b33a978e3d1212f63c95cefc9da765 100644 (file)
--- a/Civi/Api4/Action/Entity/Get.php
+++ b/Civi/Api4/Action/Entity/Get.php
@@ -44,6 +44,7 @@ class Get extends \Civi\Api4\Generic\BasicGetAction {
    */
   protected function getRecords() {
     $entities = [];
+    $toGet = $this->_itemsToGet('name');
     $locations = array_merge([\Civi::paths()->getPath('[civicrm.root]/Civi.php')],
       array_column(\CRM_Extension_System::singleton()->getMapper()->getActiveModuleFiles(), 'filePath')
     );
@@ -53,17 +54,22 @@ class Get extends \Civi\Api4\Generic\BasicGetAction {
         foreach (glob("$dir/*.php") as $file) {
           $matches = [];
           preg_match('/(\w*).php/', $file, $matches);
-          $entity = ['name' => $matches[1]];
-          if ($this->_isFieldSelected('description') || $this->_isFieldSelected('comment')) {
-            $this->addDocs($entity);
+          if (
+            (!$toGet || in_array($matches[1], $toGet))
+            && is_a('\Civi\Api4\\' . $matches[1], '\Civi\Api4\Generic\AbstractEntity', TRUE)
+          ) {
+            $entity = ['name' => $matches[1]];
+            if ($this->_isFieldSelected('description') || $this->_isFieldSelected('comment')) {
+              $this->addDocs($entity);
+            }
+            $entities[$matches[1]] = $entity;
           }
-          $entities[$matches[1]] = $entity;
         }
       }
     }
-    unset($entities['CustomValue']);
 
-    if ($this->includeCustom) {
+    // Fetch custom entities unless we've already fetched everything requested
+    if ($this->includeCustom && (!$toGet || array_diff($toGet, array_keys($entities)))) {
       $this->addCustomEntities($entities);
     }
 

diff --git a/Civi/Api4/CustomValue.php b/Civi/Api4/CustomValue.php
index 764c8e49a42a953af99df824f47fef9cc18b0b62..3ed03a8d61a0e263d9d25cca8e86ea5798952865 100644 (file)
--- a/Civi/Api4/CustomValue.php
+++ b/Civi/Api4/CustomValue.php
@@ -32,9 +32,10 @@ namespace Civi\Api4;
  * Ex. OOP: \Civi\Api4\CustomValue::get('MyStuff')->addWhere('id', '=', 123)
  * Non-OOP: civicrm_api4('Custom_MyStuff', 'get', ['where' => [['id', '=', 123]]]);
  *
+ * Note: This class does NOT extend AbstractEntity so it doesn't get mistaken for a "real" entity.
  * @package Civi\Api4
  */
-class CustomValue extends Generic\AbstractEntity {
+class CustomValue {
 
   /**
    * @param string $customGroup