From 36cf2d7eecbc466b5725e7de164397a012107af2 Mon Sep 17 00:00:00 2001
From: Aidan Saunders <aidan.saunders@squiffle.uk>
Date: Fri, 28 Aug 2020 15:45:59 +0100
Subject: [PATCH] Use !empty() instead of isset() in constructor so that empty
 strings don't confuse the logic Update array syntax in comments Add test for
 class.api.php

---
 api/class.api.php                     | 24 +++++++-------
 tests/phpunit/api/v3/ClassAPITest.php | 48 +++++++++++++++++++++++++++
 2 files changed, 60 insertions(+), 12 deletions(-)
 create mode 100644 tests/phpunit/api/v3/ClassAPITest.php

diff --git a/api/class.api.php b/api/class.api.php
index 4ba61dd30b..df6ef1283f 100644
--- a/api/class.api.php
+++ b/api/class.api.php
@@ -14,15 +14,15 @@
  * ```
  *   require_once('/your/civi/folder/api/class.api.php');
  *   // the path to civicrm.settings.php
- *   $api = new civicrm_api3 (array('conf_path'=> '/your/path/to/your/civicrm/or/joomla/site));
+ *   $api = new civicrm_api3 (['conf_path'=> '/your/path/to/your/civicrm/or/joomla/site']);
  * ```
  *
  * or to query a remote server via the rest api
  *
  * ```
- *   $api = new civicrm_api3 (array ('server' => 'http://example.org',
- *                                   'api_key'=>'theusersecretkey',
- *                                   'key'=>'thesitesecretkey'));
+ *   $api = new civicrm_api3 (['server' => 'http://example.org',
+ *                             'api_key'=>'theusersecretkey',
+ *                             'key'=>'thesitesecretkey']);
  * ```
  *
  * No matter how initialised and if civicrm is local or remote, you use the class the same way.
@@ -34,7 +34,7 @@
  * So, to get the individual contacts:
  *
  * ```
- *   if ($api->Contact->Get(array('contact_type'=>'Individual','return'=>'sort_name,current_employer')) {
+ *   if ($api->Contact->Get(['contact_type'=>'Individual','return'=>'sort_name,current_employer']) {
  *     // each key of the result array is an attribute of the api
  *     echo "\n contacts found " . $api->count;
  *     foreach ($api->values as $c) {
@@ -49,7 +49,7 @@
  * Or, to create an event:
  *
  * ```
- *   if ($api->Event->Create(array('title'=>'Test','event_type_id' => 1,'is_public' => 1,'start_date' => 19430429))) {
+ *   if ($api->Event->Create(['title'=>'Test','event_type_id' => 1,'is_public' => 1,'start_date' => 19430429])) {
  *     echo "created event id:". $api->id;
  *   } else {
  *     echo $api->errorMsg();
@@ -62,7 +62,7 @@
  *
  * ```
  *   $api->Activity->Get (42);
- *   $api->Activity->Get (array('id'=>42));
+ *   $api->Activity->Get (['id'=>42]);
  * ```
  *
  *
@@ -87,23 +87,23 @@ class civicrm_api3 {
     $this->local      = TRUE;
     $this->input      = [];
     $this->lastResult = [];
-    if (isset($config) && isset($config['server'])) {
+    if (!empty($config) && !empty($config['server'])) {
       // we are calling a remote server via REST
       $this->local = FALSE;
       $this->uri = $config['server'];
-      if (isset($config['path'])) {
+      if (!empty($config['path'])) {
         $this->uri .= "/" . $config['path'];
       }
       else {
         $this->uri .= '/sites/all/modules/civicrm/extern/rest.php';
       }
-      if (isset($config['key'])) {
+      if (!empty($config['key'])) {
         $this->key = $config['key'];
       }
       else {
         die("\nFATAL:param['key] missing\n");
       }
-      if (isset($config['api_key'])) {
+      if (!empty($config['api_key'])) {
         $this->api_key = $config['api_key'];
       }
       else {
@@ -111,7 +111,7 @@ class civicrm_api3 {
       }
       return;
     }
-    if (isset($config) && isset($config['conf_path'])) {
+    if (!empty($config) && !empty($config['conf_path'])) {
       if (!defined('CIVICRM_SETTINGS_PATH')) {
         define('CIVICRM_SETTINGS_PATH', $config['conf_path'] . '/civicrm.settings.php');
       }
diff --git a/tests/phpunit/api/v3/ClassAPITest.php b/tests/phpunit/api/v3/ClassAPITest.php
new file mode 100644
index 0000000000..0bd35bb766
--- /dev/null
+++ b/tests/phpunit/api/v3/ClassAPITest.php
@@ -0,0 +1,48 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Test class for class.api.php
+ *
+ * @package CiviCRM_APIv3
+ * @group headless
+ */
+class class_api_test extends CiviUnitTestCase {
+
+  /**
+   * Test that error doesn't occur for non-existent file.
+   */
+  public function testConstructor() {
+    require_once 'api/class.api.php';
+
+    // Check no params is local
+    $api = new civicrm_api3();
+    $this->assertEquals(TRUE, $api->local);
+
+    // Be sure to include keys otherwise these calls die()
+    $keys = ['key' => 'my_site_key', 'api_key' => 'my_api_key'];
+
+    // Check empty server string is local
+    $api = new civicrm_api3(['server' => ''] + $keys);
+    $this->assertEquals(TRUE, $api->local);
+
+    // Check non-empty server string is remote, check default uri
+    $api = new civicrm_api3(['server' => 'http://my_server'] + $keys);
+    $this->assertEquals(FALSE, $api->local);
+    $this->assertEquals('http://my_server/sites/all/modules/civicrm/extern/rest.php', $api->uri);
+
+    // Check path in uri
+    $api = new civicrm_api3(['server' => 'http://my_server', 'path' => 'wibble'] + $keys);
+    $this->assertEquals('http://my_server/wibble', $api->uri);
+
+  }
+
+}
-- 
2.25.1