API client class v1.1.57

- increased minimum required PHP version to 5.5.0
- minor syntax improvement based on Scrutinizer feedback
- added create_dynamicdns() and set_dynamicdns() methods, "borrowed" routes from @smos
- added set_element_adoption() method, contributed by @VWT-Dan
- made a start at changing the function/method comments to PHPDoc format (PSR-5) which will support auto-generated class documentation (https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#5-the-phpdoc-format)
- added check to throw an error when the $baseurl ends with a / character, thanks to @infraweavers for submitting #66
- fixed issue with logout() on UDM PROs, thanks go to @Olivier6767 for providing access to a UDM PRO, addresses #63
- applied several code styling improvements

README.md

@@ -1,13 +1,13 @@
 ## UniFi Controller API client class
 
-A PHP class that provides access to Ubiquiti's [**UniFi SDN Controller**](https://unifi-sdn.ui.com/) API, versions 4.X.X and 5.X.X of the UniFi SDN Controller software are supported (version 5.12.66 has been confirmed to work) as well as UbiOS-based controllers (version 5.12.59 has been confirmed to work). This class is used in 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 SDN Controller**](https://unifi-sdn.ui.com/) API, versions 4.X.X and 5.X.X of the UniFi SDN Controller software are supported (version 5.12.72 has been confirmed to work) as well as UbiOS-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).
 
 The package can be installed manually or using composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for easy inclusion in your projects.
 
 ## Requirements
 
-- a server with PHP and cURL modules 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)
-- network connectivity between this server and the host and port (normally TCP port 8443) where the UniFi Controller is running
+- 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
 
 
@@ -23,7 +23,7 @@ You can use [Composer](#composer), [Git](#git) or simply [Download the Release](
 
 ### Composer
 
-The preferred method is via [composer](https://getcomposer.org). Follow the [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 do not already have composer installed.
 
 Once composer is installed, simply execute this command from the shell in your project directory:
 
@@ -108,16 +108,20 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - logout()
 - adopt_device()
 - archive_alarm()
+- assign_existing_admin()
 - authorize_guest()
 - block_sta()
+- cancel_rolling_upgrade()
+- cmd_stat()
 - count_alarms()
+- create_dynamicdns()
 - create_firewallgroup()
 - create_hotspotop()
 - create_network()
 - create_radius_account()
 - create_site()
-- create_usergroup()
 - create_user()
+- create_usergroup()
 - create_voucher()
 - create_wlan()
 - custom_api_request()
@@ -135,12 +139,10 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - extend_guest_validity()
 - forget_sta() (supported on controller version 5.9.X and higher)
 - invite_admin()
-- assign_existing_admin()
-- revoke_admin()
 - led_override()
 - list_admins()
-- list_all_admins()
 - list_alarms()
+- list_all_admins()
 - list_aps() (deprecated but still available as alias)
 - list_backups()
 - list_clients()
@@ -177,14 +179,17 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - locate_ap()
 - move_device()
 - power_cycle_switch_port()
+- reboot_cloudkey()
 - reconnect_sta()
 - rename_ap()
 - restart_ap() (deprecated but still available as alias)
 - restart_device()
-- reboot_cloudkey()
+- revoke_admin()
 - revoke_voucher()
 - set_ap_radiosettings()
 - set_device_settings_base()
+- set_dynamicdns()
+- set_element_adoption() (supported on controller version 5.13.X and higher)
 - set_guestlogin_settings()
 - set_guestlogin_settings_base()
 - set_ips_settings_base() (supported on controller version 5.9.10 and higher)
@@ -199,11 +204,11 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - set_site_name()
 - set_site_ntp()
 - set_site_snmp()
-- set_super_mgmt_settings_base()
-- set_super_smtp_settings_base()
-- set_super_identity_settings_base()
 - set_sta_name()
 - set_sta_note()
+- set_super_identity_settings_base()
+- set_super_mgmt_settings_base()
+- set_super_smtp_settings_base()
 - set_usergroup()
 - set_wlan_mac_filter()
 - set_wlansettings()
@@ -213,26 +218,27 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - site_ledson() (deprecated but still available as alias)
 - spectrum_scan()
 - spectrum_scan_state()
+- start_rolling_upgrade()
+- stat_5minutes_aps() (supported on controller version 5.5.X and higher)
+- stat_5minutes_gateway() (supported on controller version 5.7.X and higher)
+- stat_5minutes_site() (supported on controller version 5.5.X and higher)
+- stat_5minutes_user (supported on controller version 5.7.X and higher)
 - stat_allusers()
 - stat_auths()
 - stat_client()
-- stat_5minutes_aps() (supported on controller version 5.5.X and higher)
-- stat_hourly_aps()
 - stat_daily_aps()
-- stat_5minutes_gateway() (supported on controller version 5.7.X and higher)
-- stat_hourly_gateway() (supported on controller version 5.7.X and higher)
 - stat_daily_gateway() (supported on controller version 5.7.X and higher)
-- stat_5minutes_site() (supported on controller version 5.5.X and higher)
-- stat_hourly_site()
 - stat_daily_site()
-- stat_5minutes_user (supported on controller version 5.7.X and higher)
-- stat_hourly_user() (supported on controller version 5.7.X and higher)
 - stat_daily_user() (supported on controller version 5.7.X and higher)
+- 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_payment()
 - stat_sessions()
 - stat_sites()
 - stat_speedtest_results()
-- stat_ips_events() (supported on controller version 5.9.10 and higher)
 - stat_sta_sessions_latest()
 - stat_status()
 - stat_sysinfo()
@@ -242,32 +248,29 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - unset_locate_ap() (deprecated but still available as alias)
 - upgrade_device()
 - upgrade_device_external()
-- start_rolling_upgrade()
-- cancel_rolling_upgrade()
-- cmd_stat()
 
 Other functions, getters/setters:
 
-- set_debug()
-- get_debug()
-- set_site()
-- get_site()
-- set_cookies()
-- get_cookies()
-- get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
-- get_last_results_raw()
-- get_last_error_message()
-- set_request_type()
-- get_request_type()
-- set_ssl_verify_peer()
-- get_ssl_verify_peer()
-- set_ssl_verify_host()
-- get_ssl_verify_host()
-- set_connection_timeout()
-- get_connection_timeout()
-- set_is_unifi_os()
-- get_is_unifi_os()
 - get_class_version()
+- get_connection_timeout()
+- get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
+- get_cookies()
+- get_debug()
+- get_is_unifi_os()
+- get_last_error_message()
+- get_last_results_raw()
+- get_request_type()
+- get_site()
+- get_ssl_verify_host()
+- get_ssl_verify_peer()
+- set_connection_timeout()
+- set_cookies()
+- set_debug()
+- set_is_unifi_os()
+- set_request_type()
+- set_site()
+- set_ssl_verify_host()
+- set_ssl_verify_peer()
 
 
 ## Need help or have suggestions?

composer.json

@@ -1,27 +1,28 @@
 {
-    "name": 		"art-of-wifi/unifi-api-client",
-    "type": 		"library",
-    "description": 	"API client class for use with Ubiquiti's UniFi controller",
+    "name":        "art-of-wifi/unifi-api-client",
+    "type":        "library",
+    "description": "API client class for use with Ubiquiti's UniFi controller",
     "keywords": [
-		"ubnt",
-		"ubiquiti",
-		"unifi",
-		"controller",
-		"api",
-		"client"
-	],
-    "homepage": 	"https://github.com/Art-of-WiFi/UniFi-API-client",
-    "license": 		"MIT",
+        "ubnt",
+        "ubiquiti",
+        "unifi",
+        "controller",
+        "api",
+        "client"
+    ],
+    "homepage":    "https://github.com/Art-of-WiFi/UniFi-API-client",
+    "license":     "MIT",
     "authors": [
         {
-            "name": 	"Art of WiFi",
-            "email": 	"info@artofowifi.net",
+            "name":     "Art of WiFi",
+            "email":    "info@artofowifi.net",
             "homepage": "http://artofwifi.net"
         }
     ],
     "require": {
-        "php": ">=5.4.0",
-		"ext-curl": "*"
+        "php": ">=5.5.0",
+        "ext-curl": "*",
+        "ext-json": "*"
     },
     "autoload": {
         "psr-4": {