Merge pull request #27262 from colemanw/phpstormApi4

[NFC] PhpStorm - Add more APIv4 function argument hints
civicrm · Sep 2, 2023 · 09b8113 · 09b8113
2 parents 4337d38 + 8bb9a88
commit 09b8113
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php b/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php
@@ -2,6 +2,7 @@
 
 namespace Civi\PhpStorm;
 
+use Civi\Api4\Entity;
 use Civi\Core\Service\AutoService;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
@@ -30,14 +31,28 @@ public function generate() {
      * but for now there's no point.
      */
 
-    $entities = \Civi\Api4\Entity::get(FALSE)->addSelect('name')->execute()->column('name');
+    $entities = Entity::get(FALSE)->addSelect('name')->execute()->column('name');
     $actions = ['get', 'save', 'create', 'update', 'delete', 'replace', 'revert', 'export', 'autocomplete', 'getFields', 'getActions', 'checkAccess'];
+    $properties = Entity::getFields(FALSE)->addOrderBy('name')->execute()->column('name');
 
     $builder = new PhpStormMetadata('api4', __CLASS__);
     $builder->registerArgumentsSet('api4Entities', ...$entities);
     $builder->registerArgumentsSet('api4Actions', ...$actions);
+    $builder->registerArgumentsSet('api4Properties', ...$properties);
     $builder->addExpectedArguments('\civicrm_api4()', 0, 'api4Entities');
     $builder->addExpectedArguments('\civicrm_api4()', 1, 'api4Actions');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getBAOFromApiName()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getApiClass()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getInfoItem()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getInfoItem()', 1, 'api4Properties');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getIdFieldName()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getSearchFields()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getTableName()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getCustomGroupExtends()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::getRefCount()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::checkAccessDelegated()', 0, 'api4Entities');
+    $builder->addExpectedArguments('\Civi\Api4\Utils\CoreUtil::checkAccessDelegated()', 1, 'api4Actions');
+    $builder->addExpectedArguments('\Civi\API\EntityLookupTrait::define()', 0, 'api4Entities');
     $builder->write();
   }