API client class v1.1.79

- updated README to reflect support for 7.X
- `get_last_error_message()` now always returns a string which is empty if no message is available
- applied PR #151 in slightly different way for consistency with other similar code sections, contributed by @banakito
- changed default argument values in several methods/functions from null to an empty string

.gitignore

@@ -10,4 +10,7 @@
 .phpdoc-md
 
 # ignore XML files
-*.xml
+*.xml
+
+# ignore PHPStorm files
+.idea/*

README.md

@@ -1,40 +1,61 @@
 ## UniFi Controller API client class
 
-A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API, versions 4.X.X, 5.X.X and 6.0.X of the UniFi Network Controller software are supported (version 6.0.43 has been confirmed to work) as well as UniFi OS-based controllers (version 5.12.59 has been confirmed to work). This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
+A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API.
 
-The package can be installed manually or by using composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for easy inclusion in your projects.
+UniFi Network Controller software versions 4.X.X, 5.X.X, 6.X.X, and 7.X.X (version 7.0.23 has been confirmed to work)
+are supported as well as UniFi OS-based controllers. This class is used by our API browser tool which can be found
+[here](https://github.com/Art-of-WiFi/UniFi-API-browser).
 
+The package can be installed manually or by using
+composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for
+easy inclusion in your projects.
 
 ## Requirements
 
-- a server with PHP, version 5.5.0 or higher, and the PHP cURL module installed (tested on Apache 2.4 with PHP Version 5.6.1 and cURL 7.42.1 and with PHP 7.2.24 and cURL 7.58.0)
-- direct network connectivity between this server and the host and port (normally TCP port 8443) where the UniFi Controller is running
-- you must use **local accounts**, not UniFi Cloud accounts, to access the UniFi Controller API through this class
-
+- a server with:
+  - PHP 5.5.0 or higher 
+  - PHP json and PHP cURL modules
+  - tested on Apache 2.4 with PHP 5.6.1 and cURL 7.42.1 and with PHP 7.4.9 and cURL 7.68.0
+- direct network connectivity between this server and the host and port (usually TCP port 8443 or port 443 for 
+  UniFi OS) where the UniFi Controller is running
+- you must use **accounts with local access**, not UniFi Cloud accounts, to access the UniFi Controller API 
+  through this class
 
 ## UniFi OS Support
 
-Support for UniFi OS-based controllers (UniFi Dream Machine Pro or Cloud Key Gen2/Cloud Key Gen2 Plus with firmware version 2.0.24 or higher) has been added as of version 1.1.47. The class automatically detects UniFi OS devices and adjusts URLs and several functions/methods accordingly. If your own code applies strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix when dealing with a UniFi OS-based controller.
+Support for UniFi OS-based controllers has been added as of version 1.1.47:
+- UniFi Dream Router (UDR)
+- UniFi Dream Machine (UDM)
+- UniFi Dream Machine Pro (UDM PRO)
+- Cloud Key Gen2 (UCK G2), firmware version 2.0.24 or higher
+- Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
 
-Please test all methods you plan on using thoroughly before using the API Client with UniFi OS devices in a production environment.
+The class automatically detects UniFi OS-based controllers and adjusts URLs and several functions/methods accordingly.
+If your own code implements strict validation of the URL that is passed to the constructor, please adapt your
+logic to allow URLs without a port suffix or with port 443 when working with a UniFi OS-based controller.
 
+Please test all methods you plan on using thoroughly before using the API Client with
+UniFi OS devices in a production environment.
 
 ## Installation
 
-Use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the API client class.
-
+Use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the 
+API client class.
 
 ### Composer
 
-The preferred installation method is through [composer](https://getcomposer.org). Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have composer installed.
+The preferred installation method is through [composer](https://getcomposer.org). 
+Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you don't have composer
+installed already.
 
-Once composer is installed, simply execute this command from the shell in your project directory:
+Once composer is installed, simply execute this command from the shell in your project
+directory:
 
 ```sh
 composer require art-of-wifi/unifi-api-client
 ```
 
- Or manually add the package to your composer.json file:
+Or manually add the package to your composer.json file:
 
 ```javascript
 {
@@ -50,7 +71,6 @@ Finally, be sure to include the autoloader in your code:
 require_once 'vendor/autoload.php';
 ```
 
-
 ### Git
 
 Execute the following `git` command from the shell in your project directory:
@@ -65,16 +85,16 @@ When git is done cloning, include the file containing the class like so in your
 require_once 'path/to/src/Client.php';
 ```
 
-
 ### Download the Release
 
-If you prefer not to use composer or git, simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), uncompress the zip file, then include the file containing the class in your code like so:
+If you prefer not to use composer or git,
+simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), unpack the zip
+file, then include the file containing the class in your code like so:
 
 ```php
 require_once 'path/to/src/Client.php';
 ```
 
-
 ## Example usage
 
 A basic example how to use the class:
@@ -86,7 +106,7 @@ A basic example how to use the class:
 require_once 'vendor/autoload.php';
 
 /**
- * initialize the Unifi API connection class, log in to the controller and request the alarms collection
+ * initialize the UniFi API connection class, log in to the controller and request the alarms collection
  * (this example assumes you have already assigned the correct values to the variables used)
  */
 $unifi_connection = new UniFi_API\Client($controller_user, $controller_password, $controller_url, $site_id, $controller_version, true);
@@ -94,23 +114,34 @@ $login            = $unifi_connection->login();
 $results          = $unifi_connection->list_alarms(); // returns a PHP array containing alarm objects
 ```
 
-Please refer to the `examples/` directory for some more detailed examples which can be used as a starting point for your own PHP code.
-
+Please refer to the `examples/` directory for some more detailed examples which can be used as a starting point for your
+own PHP code.
 
 #### IMPORTANT NOTES:
 
-1. In the above example, `$site_id` is the short site "name" (usually 8 characters long) that is visible in the URL when managing the site in the UniFi Network Controller. For example with this URL:
+1. In the above example, `$site_id` is the short site "name" (usually 8 characters long) that is visible in the URL when
+   managing the site in the UniFi Network Controller. For example with this URL:
 
    `https://<controller IP address or FQDN>:8443/manage/site/jl3z2shm/dashboard`
 
    `jl3z2shm` is the short site "name" and the value to assign to $site_id.
 
-2. The last optional parameter that is passed to the constructor in the above example (`true`), enables validation of the controller's SSL certificate which is otherwise **disabled** by default. It is **highly recommended** to enable this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
+2. The 6th optional parameter that is passed to the constructor in the above example (`true`), enables validation of
+   the controller's SSL certificate which is otherwise **disabled** by default. It is **highly recommended** to enable
+   this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is
+   associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
 
+3. Using an administrator account (`$controller_user` in the above example) with **read-only** permissions can limit 
+   visibility on certain collection/object properties. See this
+   [issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129) and this 
+   [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94) for an example where the WPA2 password isn't
+   visible for **read-only** administrator accounts.
 
 ## Functions/methods supported
 
-The class currently supports the following functions/methods to GET/POST/PUT/DELETE data through the UniFi Controller API. Please refer to the comments in the source code for more details on the functions/methods and their respective parameters.
+The class currently supports the following functions/methods to GET/POST/PUT/DELETE data
+through the UniFi Controller API. Please refer to the comments in the source code for
+more details on each of the functions/methods and their respective parameters.
 
 - login()
 - logout()
@@ -120,10 +151,10 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - authorize_guest()
 - block_sta()
 - cancel_rolling_upgrade()
-- cmd_stat()
-- count_alarms()
 - check_controller_update()
 - check_firmware_update()
+- cmd_stat()
+- count_alarms()
 - create_apgroup() (supported with controller versions 6.0.X and higher)
 - create_dynamicdns()
 - create_firewallgroup()
@@ -147,6 +178,7 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - disable_ap()
 - edit_apgroup() (supported with controller versions 6.0.X and higher)
 - edit_client_fixedip()
+- edit_client_name()
 - edit_firewallgroup()
 - edit_usergroup()
 - extend_guest_validity()
@@ -163,8 +195,8 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - list_country_codes()
 - list_current_channels()
 - list_dashboard()
-- list_devices()
 - list_device_name_mappings()
+- list_devices()
 - list_dpi_stats()
 - list_dynamicdns()
 - list_events()
@@ -245,24 +277,24 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - stat_daily_gateway() (supported on controller version 5.7.X and higher)
 - stat_daily_site()
 - stat_daily_user() (supported on controller version 5.7.X and higher)
+- stat_full_status()
 - stat_hourly_aps()
 - stat_hourly_gateway() (supported on controller version 5.7.X and higher)
 - stat_hourly_site()
 - stat_hourly_user() (supported on controller version 5.7.X and higher)
 - stat_ips_events() (supported on controller version 5.9.10 and higher)
+- stat_monthly_aps()
+- stat_monthly_gateway()
+- stat_monthly_site()
+- stat_monthly_user()
 - stat_payment()
 - stat_sessions()
 - stat_sites()
 - stat_speedtest_results()
 - stat_sta_sessions_latest()
 - stat_status()
-- stat_full_status()
 - stat_sysinfo()
 - stat_voucher()
-- stat_monthly_aps()
-- stat_monthly_gateway()
-- stat_monthly_site()
-- stat_monthly_user()
 - unauthorize_guest()
 - unblock_sta()
 - unset_locate_ap() (deprecated but still available as alias)
@@ -272,49 +304,57 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 Other functions, getters/setters:
 
 - get_class_version()
-- get_connection_timeout()
 - get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
 - get_cookies()
+- get_curl_connection_timeout()
+- get_curl_http_version()
+- get_curl_method()
+- get_curl_request_timeout()
+- get_curl_request_timeout()
+- get_curl_ssl_verify_host()
+- get_curl_ssl_verify_peer()
 - get_debug()
 - get_is_unifi_os()
 - get_last_error_message()
 - get_last_results_raw()
-- get_request_method()
 - get_site()
-- get_ssl_verify_host()
-- get_ssl_verify_peer()
 - set_connection_timeout()
 - set_cookies()
+- set_curl_http_version()
+- set_curl_request_timeout()
+- set_curl_ssl_verify_host()
+- set_curl_ssl_verify_peer()
 - set_debug()
 - set_is_unifi_os()
 - set_request_method()
+- set_request_timeout()
 - set_site()
-- set_ssl_verify_host()
-- set_ssl_verify_peer()
-
 
 ## Need help or have suggestions?
 
-There is still work to be done to add functionality and further improve the usability of this class, so all suggestions/comments are welcome. Please use the GitHub [issue list](https://github.com/Art-of-WiFi/UniFi-API-client/issues) or the Ubiquiti Community forums (https://community.ubnt.com/t5/UniFi-Wireless/PHP-class-to-access-the-UniFi-controller-API-updates-and/td-p/1512870) to share your suggestions and questions.
-
+There is still work to be done to add functionality and further improve the usability of
+this class, so all suggestions/comments are welcome. Please use the GitHub
+[issue list](https://github.com/Art-of-WiFi/UniFi-API-client/issues) or the Ubiquiti
+Community forums (https://community.ubnt.com/t5/UniFi-Wireless/PHP-class-to-access-the-UniFi-controller-API-updates-and/td-p/1512870)
+to share your suggestions and questions.
 
 ## Contribute
 
-If you would like to contribute code (improvements), please open an issue and include your code there or else create a pull request.
-
+If you would like to contribute code (improvements), please open an issue and include
+your code there or else create a pull request.
 
 ## Credits
 
 This class is based on the initial work by the following developers:
 
-- domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
+- domwo: https://community.ui.com/questions/little-php-class-for-unifi-api/933d3fb3-b401-4499-993a-f9af079a4a3a
 - fbagnol: https://github.com/fbagnol/class.unifi.php
 
 and the API as published by Ubiquiti:
 
-- https://dl.ui.com/unifi/6.0.41/unifi_sh_api
-
+- https://dl.ui.com/unifi/7.0.23/unifi_sh_api
 
 ## Important Disclaimer
 
-Many of the functions in this API client class are not officially supported by UBNT and as such, may not be supported in future versions of the UniFi Controller API.
+Many of the functions in this API client class are not officially supported by Ubiquiti
+and as such, may not be supported in future versions of the UniFi Controller API.

composer.json

@@ -1,6 +1,6 @@
 {
-    "name":        "art-of-wifi/unifi-api-client",
-    "type":        "library",
+    "name": "art-of-wifi/unifi-api-client",
+    "type": "library",
     "description": "API client class for use with Ubiquiti's UniFi controller",
     "keywords": [
         "ubnt",
@@ -10,13 +10,13 @@
         "api",
         "client"
     ],
-    "homepage":    "https://github.com/Art-of-WiFi/UniFi-API-client",
-    "license":     "MIT",
+    "homepage": "https://github.com/Art-of-WiFi/UniFi-API-client",
+    "license": "MIT",
     "authors": [
         {
-            "name":     "Art of WiFi",
-            "email":    "info@artofowifi.net",
-            "homepage": "http://artofwifi.net"
+            "name": "Art of WiFi",
+            "email": "info@artofowifi.net",
+            "homepage": "https://artofwifi.net"
         }
     ],
     "require": {
@@ -29,4 +29,4 @@
             "UniFi_API\\": "src/"
         }
     }
-}
+}

examples/README.md

@@ -1,18 +1,21 @@
 ## API client class usage examples
 
-This directory contains some PHP code examples which demonstrate usage of the PHP API client class and can be used as a good starting point for your own custom code.
+This directory contains some PHP code examples which demonstrate usage of the PHP API client class and can be used as a
+good starting point for your own custom code.
 
 ### Usage
 
-Copy the appropriate example file to your working directory together with a copy of the config.template.php file which should be renamed to config.php.
-Then update the contents of your new config.php with your controller details and credentials and modify the example file as required to fit your needs.
+Copy the appropriate example file to your working directory together with a copy of the config.template.php file which
+should be renamed to config.php. Then update the contents of your new config.php with your controller details and
+credentials and modify the example file as required to fit your needs.
 
-Also make sure to update the path for the composer autoloader file (`vendor/autoload.php`) or the file containing the Class itself (`src/Client.php`) in your `require_once()` statement as required.
+Also make sure to update the path for the composer autoloader file (`vendor/autoload.php`) or the file containing the
+Class itself (`src/Client.php`) in your `require_once()` statement as required.
 
 #### Executing scripts from the CLI
 
-Most of the included example scripts can be run from the CLI or shell as follows after the necessary credentials and parameters have been added or updated:
-
+Most of the included example scripts can be run from the CLI or shell as follows after the necessary credentials and
+parameters have been added or updated:
 
 ```sh
 $ php list_site_health.php
@@ -22,7 +25,8 @@ NOTE: this does require the `php-cli` module to be installed
 
 ### Contribute
 
-If you would like to share your own example file(s), please open an issue and include your code there or else create a pull request.
+If you would like to share your own example file(s), please open an issue and include your code there or else create a
+pull request.
 
 ## Important Disclaimer
 

examples/test_connection.php

@@ -15,8 +15,9 @@ require_once 'config.php';
 
 /**
  * Check whether the cURL module supports SSL
+ * http://www.php.net/manual/en/function.curl-version.php
  */
-if (!curl_version()['features'] & CURL_VERSION_SSL) {
+if (!(curl_version()['features'] & CURL_VERSION_SSL)) {
     print PHP_EOL . 'SSL is not supported with this cURL installation!' . PHP_EOL;
 }
 
@@ -25,27 +26,28 @@ if (!curl_version()['features'] & CURL_VERSION_SSL) {
  */
 $ch = curl_init();
 
-if (is_resource($ch)) {
+if (is_resource($ch) || is_object($ch)) {
     /**
-     * If we have a resource, we proceed and set the required cURL options
-     */
-    curl_setopt($ch, CURLOPT_URL, $controllerurl);
-    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
-    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
-    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
-
-    /**
-     * This cURL option can have a value of 0-6
+     * If we have a resource or object (for PHP > 8.0), we proceed and set the required cURL options
+     *
+     * NOTES:
+     * The cURL option CURLOPT_SSLVERSION can have a value of 0-6
      * see this URL for more details:
      * http://php.net/manual/en/function.curl-setopt.php
      * 0 is the default value and is used by the PHP API client class
      */
-    curl_setopt($ch, CURLOPT_SSLVERSION, 0);
+    $curl_options = [
+        CURLOPT_PROTOCOLS      => CURLPROTO_HTTPS,
+        CURLOPT_URL            => $controllerurl,
+        CURLOPT_CUSTOMREQUEST  => 'GET',
+        CURLOPT_SSL_VERIFYPEER => false,
+        CURLOPT_SSL_VERIFYHOST => false,
+        CURLOPT_VERBOSE        => true,
+        CURLOPT_SSLVERSION     => 0,
+        CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
+    ];
 
-    /**
-     * Be more verbose
-     */
-    curl_setopt($ch, CURLOPT_VERBOSE, true);
+    curl_setopt_array($ch, $curl_options);
 
     /**
      * $results contains the output as returned by the cURL request,
@@ -64,9 +66,13 @@ if (is_resource($ch)) {
         print PHP_EOL . 'cURL error: ' . curl_error($ch) . PHP_EOL;
     }
 
-    print PHP_EOL . '$results:' . PHP_EOL;
-    print_r($results);
-    print PHP_EOL;
+    print PHP_EOL . 'test result:' . PHP_EOL;
+    if ($results) {
+        print 'Controller connection success' . PHP_EOL;
+        die;
+    }
+
+    print 'Controller connection failed' . PHP_EOL;
 } else {
     print PHP_EOL . 'ERROR: cURL could not be initialized!' . PHP_EOL;
 }