API client class v1.1.71

- modified `create_radius_account()` method to make Tunnel Type and Medium optional parameters, contributed by @mreho
- added `advanced_adopt_device()` method for more advanced adoption capabilities, contributed by @Sarrus
- refactored several code sections
- updated connection test script

.gitignore

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

README.md

@@ -1,29 +1,42 @@
 ## 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.37 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).
+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.X.X of the UniFi Network Controller software are supported (version 6.3.51 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).
 
-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.
+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
+- 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
 
+## UniFi OS Support
 
-## UbiOS 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 UbiOS-based controllers (UniFi Dream Machine Pro) has been added as of version 1.1.47. The class automatically detects UbiOS 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 UbiOS-based controller.
-
-Please test all methods you plan on using thoroughly before using the API Client with UbiOS devices in a production environment.
+Please test all methods you plan on using thoroughly before using the API Client with UniFi OS devices in a production
+environment.
 
 ## Installation
 
-You can 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 do not already have composer
+installed.
 
 Once composer is installed, simply execute this command from the shell in your project directory:
 
@@ -31,7 +44,7 @@ Once composer is installed, simply execute this command from the shell in your p
 composer require art-of-wifi/unifi-api-client
 ```
 
- Or you can manually add the package to your composer.json file:
+Or manually add the package to your composer.json file:
 
 ```javascript
 {
@@ -44,7 +57,7 @@ composer require art-of-wifi/unifi-api-client
 Finally, be sure to include the autoloader in your code:
 
 ```php
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 ```
 
 ### Git
@@ -58,15 +71,17 @@ git clone https://github.com/Art-of-WiFi/UniFi-API-client.git
 When git is done cloning, include the file containing the class like so in your code:
 
 ```php
-require_once('path/to/src/Client.php');
+require_once 'path/to/src/Client.php';
 ```
 
 ### Download the Release
 
-If you prefer not to use composer or git, you can 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), uncompress the zip
+file, then include the file containing the class in your code like so:
 
 ```php
-require_once('path/to/src/Client.php');
+require_once 'path/to/src/Client.php';
 ```
 
 ## Example usage
@@ -77,10 +92,10 @@ A basic example how to use the class:
 /**
  * load the class using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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);
@@ -88,21 +103,28 @@ $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 you can use 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 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.
 
 ## 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 the functions/methods and their respective
+parameters.
 
 - login()
 - logout()
@@ -156,6 +178,7 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - list_current_channels()
 - list_dashboard()
 - list_devices()
+- list_device_name_mappings()
 - list_dpi_stats()
 - list_dynamicdns()
 - list_events()
@@ -247,8 +270,13 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - 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)
@@ -265,7 +293,7 @@ Other functions, getters/setters:
 - get_is_unifi_os()
 - get_last_error_message()
 - get_last_results_raw()
-- get_request_type()
+- get_request_method()
 - get_site()
 - get_ssl_verify_host()
 - get_ssl_verify_peer()
@@ -273,31 +301,36 @@ Other functions, getters/setters:
 - set_cookies()
 - set_debug()
 - set_is_unifi_os()
-- set_request_type()
+- set_request_method()
 - 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/5.12.35/unifi_sh_api
+- https://dl.ui.com/unifi/6.2.26/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.

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/ap_scanning_state.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to fetch an Access Point's scanning state/results
+ * description:    example basic PHP script to fetch an Access Point's scanning state/results
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * site id and MAC address of AP to query

examples/ap_upgrade_firmware.php

@@ -3,11 +3,11 @@
  * PHP API usage example
  *
  * contributed by: @4oo4
- * description: example script to upgrade device firmware (can be scheduled with systemd/cron)
- *              to the most current version
+ * description:    example script to upgrade device firmware (can be scheduled with systemd/cron)
+ *                 to the most current version
  */
-require_once('vendor/autoload.php');
-require_once('config.php');
+require_once 'vendor/autoload.php';
+require_once 'config.php';
 
 /**
  * site id of the AP to update

examples/auth_guest_basic.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example PHP script to perform a basic auth of a guest device
+ * description:    example PHP script to perform a basic auth of a guest device
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the MAC address of the device to authorize

examples/auth_guest_with_note.php

@@ -3,21 +3,21 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to auth a guest device and attach a note to it,
- *              this requires the device to be connected to the WLAN/LAN at moment of
- *              authorization
+ * description:    example basic PHP script to auth a guest device and attach a note to it,
+ *                 this requires the device to be connected to the WLAN/LAN at moment of
+ *                 authorization
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the MAC address of the device to authorize

examples/block_list.php

@@ -3,27 +3,26 @@
  * PHP API usage example
  *
  * contributed by: @malcolmcif, based on another Art of WiFi example
- * description: basic PHP script to block a list of mac addresses passed in via command line,
- *              output is to console in non json format
+ * description:    basic PHP script to block a list of mac addresses passed in via command line,
+ *                 output is to console in non json format
  *
  * usage:
  *  php block_list.php <list of comma seperated mac addresses>
  *
  * example:
  *  php block_list.php 09:09:09:09:09:09,10:10:10:10:10:10
- *
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 $debug = false;
 
 /**

examples/change_super_mgmt.php

@@ -3,14 +3,14 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to modify the super_mgmt settings for UniFi controller and output results
- *              in json format
+ * description:    example basic PHP script to modify the super_mgmt settings for UniFi controller and output results
+ *                 in json format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * UniFi controller credentials and the site to use, in this case since we are modifying global settings you can select
@@ -18,7 +18,7 @@ require_once('vendor/autoload.php');
  *
  * NOTE: in this case you need to enter Super Administrator account credentials in config.php
  */
-require_once('config.php');
+require_once 'config.php';
 $site_id = 'default';
 $debug   = false;
 

examples/change_wlan_password.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to change the WPA2 password/PSK of a WLAN, returns true on success
+ * description:    example basic PHP script to change the WPA2 password/PSK of a WLAN, returns true on success
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * The site to which the WLAN you want to modify belongs

examples/config.template.php

@@ -1,10 +1,8 @@
 <?php
 /**
- * Copyright (c) 2017, Art of WiFi
- *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
+ * Copyright (c) 2021, Art of WiFi
  *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**

examples/create_site.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to create a new site, returns true upon success
+ * description:    example basic PHP script to create a new site, returns true upon success
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/create_voucher.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to create a set of vouchers, returns an array containing the newly created vouchers
+ * description:    example basic PHP script to create a set of vouchers, returns an array containing the newly created vouchers
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * minutes the voucher is valid after activation (expiration time)

examples/delete_site.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to delete a site, returns true upon success
+ * description:    example basic PHP script to delete a site, returns true upon success
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/disable_device.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to disable/enable a device, returns true upon success
+ * description:    example basic PHP script to disable/enable a device, returns true upon success
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the 24 character id of the device to disable/enable

examples/disable_switch_port.php

@@ -12,13 +12,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/execute_custom_api_request.php

@@ -3,20 +3,20 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to execute a custom API request using the
- *              custom_api_request() function/method
+ * description:    example basic PHP script to execute a custom API request using the
+ *                 custom_api_request() function/method
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * The site to authorize the device with
@@ -27,10 +27,10 @@ $site_id = '<enter your site id here>';
 /**
  * parameters
  */
-$url          = '/api/s/' . $site_id . '/stat/fwupdate/latest-version';
-$request_type = 'GET';
-$payload      = null;
-$return       = 'array';
+$url            = '/api/s/' . $site_id . '/stat/fwupdate/latest-version';
+$request_method = 'GET';
+$payload        = null;
+$return         = 'array';
 
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
@@ -38,7 +38,7 @@ $return       = 'array';
 $unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode   = $unifi_connection->set_debug($debug);
 $loginresults     = $unifi_connection->login();
-$results          = $unifi_connection->custom_api_request($url, $request_type, $payload, $return);
+$results          = $unifi_connection->custom_api_request($url, $request_method, $payload, $return);
 
 /**
  * provide feedback in JSON format or as PHP Object

examples/extend_guest_auth.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: mtotone
- * description: example of how to extend validity of guest authorizations
+ * description:    example of how to extend validity of guest authorizations
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * must be adapted to your site!

examples/list_alarms.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to pull current alarms from the UniFi controller and output in json format
+ * description:    example basic PHP script to pull current alarms from the UniFi controller and output in json format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use

examples/list_ap_connected_users.php

@@ -3,20 +3,20 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example to pull connected user numbers for Access Points from the UniFi controller and output the results
- *              in raw HTML format
+ * description:    example to pull connected user numbers for Access Points from the UniFi controller and output the results
+ *                 in raw HTML format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the short name of the site which you wish to query

examples/list_connected_users.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: @gahujipo
- * description: example to pull connected users and their details from the UniFi controller and output the results
- *              in JSON format
+ * description:    example to pull connected users and their details from the UniFi controller and output the results
+ *                 in JSON format
  */
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the short name of the site which you wish to query

examples/list_site_health.php

@@ -3,20 +3,20 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example to pull site health metrics from the UniFi controller and output the results
- *              in json format
+ * description:    example to pull site health metrics from the UniFi controller and output the results
+ *                 in json format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the short name of the site you wish to query

examples/list_sites.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example basic PHP script to list all site on the controller that are
+ *                 available to the admin account defined in config.php
+ */
+
+/**
+ * using the composer autoloader
+ */
+require_once 'vendor/autoload.php';
+
+/**
+ * include the config file (place your credentials etc. there if not already present)
+ * see the config.template.php file for an example
+ */
+require_once 'config.php';
+
+/**
+ * we use the default site in the initial connection
+ */
+$site_id = 'default';
+
+/**
+ * initialize the UniFi API connection class and log in to the controller and do our thing
+ */
+$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$set_debug_mode   = $unifi_connection->set_debug($debug);
+$loginresults     = $unifi_connection->login();
+$data             = $unifi_connection->list_sites();
+
+/**
+ * we can render the full results in json format
+ */
+//echo json_encode($data, JSON_PRETTY_PRINT);
+
+/**
+ * or we print each site name and site id
+ */
+foreach ($data as $site) {
+    echo 'Site name: ' . $site->desc . ', site id: ' . $site->name . PHP_EOL;
+}
+
+echo PHP_EOL;

examples/list_social_auth_details.php

@@ -3,20 +3,20 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to pull Facebook social auth details from the UniFi controller and output
- *              them in basic HTML format
+ * description:    example basic PHP script to pull Facebook social auth details from the UniFi controller and output
+ *                 them in basic HTML format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use

examples/list_user_stats.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to pull stats for s epcific user/client device from the UniFi controller and output in json format
+ * description:    example basic PHP script to pull stats for s epcific user/client device from the UniFi controller and output in json format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use

examples/modify_smartpower_pdu_outlet.php

@@ -12,7 +12,7 @@ require 'vendor/autoload.php';
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use
@@ -55,6 +55,9 @@ $loginresults     = $unifi_connection->login();
 if ($loginresults) {
     $pdu_details = $unifi_connection->list_devices($pdu_mac);
 
+    /**
+     * change the model below from USPPDUP to UP1 when using a USP-Plug (thanks to @thesohoguy for contributing this)
+     */
     if (!empty($pdu_details) && property_exists($pdu_details[0], 'model') && $pdu_details[0]->model === 'USPPDUP' && property_exists($pdu_details[0], 'outlet_overrides')) {
         $device_id        = $pdu_details[0]->_id;
         $outlet_overrides = $pdu_details[0]->outlet_overrides;

examples/reconnect_client.php

@@ -3,19 +3,19 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to force a client device to reconnect
+ * description:    example basic PHP script to force a client device to reconnect
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the MAC address to reconnect

examples/test_connection.php

@@ -3,7 +3,7 @@
  * Test the connection to your UniFi controller
  *
  * contributed by: Art of WiFi
- * description: PHP script to check/debug the connection to your controller using PHP and cURL
+ * description:    PHP script to check/debug the connection to your controller using PHP and cURL
  */
 
 /**
@@ -11,12 +11,13 @@
  * see the config.template.php file for an example.
  * (will only be used here to get the URL to the controller)
  */
-require_once('config.php');
+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,9 +26,9 @@ 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
+     * If we have a resource or object (for PHP > 8.0), we proceed and set the required cURL options
      */
     curl_setopt($ch, CURLOPT_URL, $controllerurl);
     curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
@@ -64,9 +65,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;
 }

examples/toggle_led.php

@@ -3,20 +3,20 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example to toggle the locate function (flashing LED) on an Access Point and
- *              output the response in json format
+ * description:    example to toggle the locate function (flashing LED) on an Access Point and
+ *                 output the response in json format
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * site id to use

examples/unblock_list.php

@@ -3,8 +3,8 @@
  * PHP API usage example
  *
  * contributed by: @malcolmcif, based on another Art of WiFi example
- * description: basic PHP script to unblock a list of mac addresses passed in via command line,
- *              output is to console in non json format
+ * description:    basic PHP script to unblock a list of mac addresses passed in via command line,
+ *                 output is to console in non json format
  *
  * usage:
  *  php unblock_list.php <list of comma seperated mac addresses>
@@ -17,13 +17,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 $debug = false;
 
 /**

examples/update_ac-iw_ports.php

@@ -3,21 +3,21 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to update the port settings of an AC-IW device
- *              FYI: the AC-IW device has three ports, one for the wired uplink and two with external connectors
- * note: requires controller version 5.5.X or higher (to be verified)
+ * description:    example basic PHP script to update the port settings of an AC-IW device
+ *                 FYI: the AC-IW device has three ports, one for the wired uplink and two with external connectors
+ * note:           requires controller version 5.5.X or higher (to be verified)
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/update_device_wlan_settings_5.5.X.php

@@ -3,20 +3,20 @@
  * PHP API usage example
  *
  * contributed by: Art of WiFi
- * description: example basic PHP script to update WLAN settings of a device when using a controller version 5.5.X or higher
- *              where set_ap_radiosettings() throws an error
+ * description:    example basic PHP script to update WLAN settings of a device when using a controller version 5.5.X or higher
+ *                 where set_ap_radiosettings() throws an error
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/update_switch_poe-mode.php

@@ -13,13 +13,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * include the config file (place your credentials etc. there if not already present)
  * see the config.template.php file for an example
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller