Add string type declarations to global API functions.
authormark burdett <mfburdett@gmail.com>
Fri, 15 Nov 2019 22:37:45 +0000 (14:37 -0800)
committermark burdett <mfburdett@gmail.com>
Tue, 19 Nov 2019 04:13:40 +0000 (20:13 -0800)
api/api.php

index 2efc6ee659ab6e6da6be279732c10eb42ae3f4b4..3eec1a669514d17375fff3b6801f43d200718fae 100644 (file)
@@ -19,7 +19,7 @@
  *
  * @return array|int
  */
-function civicrm_api($entity, $action, array $params, $extra = NULL) {
+function civicrm_api(string $entity, string $action, array $params, $extra = NULL) {
   return \Civi::service('civi_api_kernel')->runSafe($entity, $action, $params, $extra);
 }
 
@@ -37,7 +37,7 @@ function civicrm_api($entity, $action, array $params, $extra = NULL) {
  * @throws \API_Exception
  * @throws \Civi\API\Exception\NotImplementedException
  */
-function civicrm_api4($entity, $action, array $params = [], $index = NULL) {
+function civicrm_api4(string $entity, string $action, array $params = [], $index = NULL) {
   $apiCall = \Civi\Api4\Utils\ActionUtil::getAction($entity, $action);
   foreach ($params as $name => $param) {
     $setter = 'set' . ucfirst($name);
@@ -81,7 +81,7 @@ function civicrm_api4($entity, $action, array $params = [], $index = NULL) {
  *
  * @return array
  */
-function civicrm_api3($entity, $action, array $params = []) {
+function civicrm_api3(string $entity, string $action, array $params = []) {
   $params['version'] = 3;
   $result = \Civi::service('civi_api_kernel')->runSafe($entity, $action, $params);
   if (is_array($result) && !empty($result['is_error'])) {