From 76e83c21da001176e36bb68b73f9ea17571b5b2e Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <emcnaughton@wikimedia.org>
Date: Thu, 2 Mar 2023 10:49:40 +1300
Subject: [PATCH] Stricter typing in Apiv4

---
 Civi/Api4/Service/Spec/RequestSpec.php  | 2 +-
 Civi/Api4/Service/Spec/SpecGatherer.php | 6 ++++--
 Civi/Api4/Utils/CoreUtil.php            | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/Civi/Api4/Service/Spec/RequestSpec.php b/Civi/Api4/Service/Spec/RequestSpec.php
index ac711c6aa8ba..64c259b3cf68 100644
--- a/Civi/Api4/Service/Spec/RequestSpec.php
+++ b/Civi/Api4/Service/Spec/RequestSpec.php
@@ -53,7 +53,7 @@ public function getEntityTableName(): ?string {
    * @param string $action
    * @param array $values
    */
-  public function __construct($entity, $action, $values = []) {
+  public function __construct(string $entity, string $action, array $values = []) {
     $this->entity = $entity;
     $this->action = $action;
     $this->entityTableName = CoreUtil::getTableName($entity);
diff --git a/Civi/Api4/Service/Spec/SpecGatherer.php b/Civi/Api4/Service/Spec/SpecGatherer.php
index 849f90b75857..9433a1b11ede 100644
--- a/Civi/Api4/Service/Spec/SpecGatherer.php
+++ b/Civi/Api4/Service/Spec/SpecGatherer.php
@@ -32,7 +32,6 @@ class SpecGatherer extends AutoService {
   /**
    * Returns a RequestSpec with all the fields available. Uses spec providers
    * to add or modify field specifications.
-   * @see \Civi\Api4\Service\Spec\Provider\CustomFieldCreationSpecProvider
    *
    * @param string $entity
    * @param string $action
@@ -40,8 +39,11 @@ class SpecGatherer extends AutoService {
    * @param array $values
    *
    * @return \Civi\Api4\Service\Spec\RequestSpec
+   * @throws \CRM_Core_Exception
+   * @see \Civi\Api4\Service\Spec\Provider\CustomFieldCreationSpecProvider
+   *
    */
-  public function getSpec($entity, $action, $includeCustom, $values = []) {
+  public function getSpec(string $entity, string $action, bool $includeCustom, array $values = []): RequestSpec {
     $specification = new RequestSpec($entity, $action, $values);
 
     // Real entities
diff --git a/Civi/Api4/Utils/CoreUtil.php b/Civi/Api4/Utils/CoreUtil.php
index 630c9e7137dd..a50543de89fd 100644
--- a/Civi/Api4/Utils/CoreUtil.php
+++ b/Civi/Api4/Utils/CoreUtil.php
@@ -74,7 +74,7 @@ public static function getIdFieldName(string $entityName): string {
    *
    * @return string
    */
-  public static function getTableName($entityName) {
+  public static function getTableName(string $entityName) {
     return self::getInfoItem($entityName, 'table_name');
   }