- applied changes from PR #258 , contributed by @mvarian

consistent use of "PHP DocBlocks"
minor tweak to example
2024-12-19 11:52:19 +01:00 · 2024-11-28 12:24:35 +01:00 · 2024-11-28 12:21:42 +01:00 · 2024-11-28 12:19:33 +01:00 · 2024-11-28 12:11:08 +01:00 · 2024-11-26 12:04:10 +01:00
49 changed files with 5043 additions and 3298 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -5,5 +5,12 @@
 /vendor/
 /composer.lock

+# ignore phpdoc files
+/build
+.phpdoc-md
+
 # ignore XML files
-*.xml
+*.xml
+
+# ignore PHPStorm files
+.idea/*
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License

-Copyright (c) 2016, Art of WiFi
+Copyright (c) 2024, Art of WiFi

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/README.md
+++ b/README.md
@@ -1,42 +1,115 @@
 ## UniFi Controller API client class

-A PHP class which provides access to Ubiquiti's [**UniFi SDN Controller API**](https://unifi-sdn.ui.com/), versions 4.X.X and 5.X.X of the UniFi SDN Controller software are supported (version 5.11.39 has been confirmed to work). It's a standalone version of the class which is used in our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
+[![License](https://img.shields.io/github/license/Art-of-WiFi/UniFi-API-client)](https://github.com/Art-of-WiFi/UniFi-API-client/blob/main/LICENSE)
+[![Packagist Version](https://img.shields.io/packagist/v/art-of-wifi/unifi-api-client)](https://packagist.org/packages/art-of-wifi/unifi-api-client)
+[![Downloads](https://img.shields.io/packagist/dt/art-of-wifi/unifi-api-client)](https://packagist.org/packages/art-of-wifi/unifi-api-client)
+[![PHP Version](https://img.shields.io/packagist/php-v/art-of-wifi/unifi-api-client)](https://packagist.org/packages/art-of-wifi/unifi-api-client)
+
+A PHP class that provides access to Ubiquiti's [**UniFi Network Application**](https://unifi-network.ui.com/) API.
+
+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. See the [installation instructions](#Installation) below for more details.
+
+## Supported Versions
+
+| Software                             | Versions                                            |
+|--------------------------------------|-----------------------------------------------------|
+| UniFi Network Application/controller | 5.x.x, 6.x.x, 7.x.x, 8.x.x (**8.6.9 is confirmed**) |
+| UniFi OS                             | 3.x, 4.x (**4.1.9 is confirmed**)                   |

-This class 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 web 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.10 and cURL 7.58.0)
- network connectivity between this web server and the server and port (normally TCP port 8443) where the UniFi Controller is running
+- a server with:
+  - PHP **7.4.0** or higher (use version [1.1.83](https://github.com/Art-of-WiFi/UniFi-API-client/releases/tag/v1.1.83) 
+    for PHP 7.3.x and lower)
+  - PHP json and PHP cURL modules enabled
+- 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 an **account with local access permissions** to access the UniFi Controller API through this class
+- do not use UniFi Cloud accounts and do not enable 2FA for the accounts that you use with this class

-## Installation ##

-You can use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the API client class.
+## UniFi OS Support
+
+Besides the "software-based" UniFi controllers, this class also supports UniFi OS-based controllers starting from
+version **1.1.47**.
+
+These devices/services have been verified to work:
+- UniFi Dream Router (UDR)
+- UniFi Dream Machine (UDM)
+- UniFi Dream Machine Pro (UDM PRO)
+- UniFi Cloud Key Gen2 (UCK G2), firmware version 2.0.24 or higher
+- UniFi Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
+- UniFi Express (UX)
+- UniFi Dream Wall (UDW)
+- UniFi Cloud Gateway Ultra (UCG-Ultra)
+- UniFi CloudKey Enterprise (CK-Enterprise)
+- UniFi Enterprise Fortress Gateway (EFG)
+- Official UniFi Hosting, details [here](https://help.ui.com/hc/en-us/articles/4415364143511)
+
+The class automatically detects UniFi OS consoles and adjusts the URLs and several functions/methods accordingly.
+
+UniFi OS-based controllers require you to connect using port **443** instead of **8443** which is used for
+"software-based" controllers. 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.
+
+
+### Remote API access to UniFi OS-based controllers
+When connecting to a UniFi OS-based gateway through the WAN interface, you need to create a specific firewall rule to
+allow this. See this blog post on the Art of WiFi website for more details:
+https://artofwifi.net/blog/how-to-access-the-unifi-controller-by-wan-ip-or-hostname-on-a-udm-pro
+
+The "custom firewall rule" approach described there is the recommended method.
+
+
+## Upgrading from previous versions
+
+When upgrading from a version before **2.0.0**, please:
+- change your code to use the new Exceptions that are thrown by the class
+- test the client with your code for any breaking changes
+- make sure you are using [Composer](#composer) to install the class because the code is no longer held within a single file
+
+
+## Installation
+
+Use [Composer](#composer) or [Git](#git) to install the API client class.
+

 ### 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 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, execute this command from the shell in your project directory:

 ```sh
 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
 {
    "require": {
-        "art-of-wifi/unifi-api-client": "^1.1"
+        "art-of-wifi/unifi-api-client": "^2.0"
    }
 }
 ```

-Finally, be sure to include the autoloader in your code:
+Finally, be sure to include the composer autoloader in your code if your framework doesn't already do this for you:

 ```php
-require_once('vendor/autoload.php');
+/**
+ * load the class using the composer autoloader
+ */
+require_once 'vendor/autoload.php';
 ```

 ### Git
@@ -50,29 +123,24 @@ 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');
-```
-
-### 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:
-
-```php
-require_once('path/to/src/Client.php');
+/**
+ * load the class directly instead of using the composer autoloader
+ */
+require_once 'path/to/src/Client.php';
 ```

 ## Example usage

-A basic example how to use the class:
+A basic example of how to use the class:

 ```php
 /**
 * 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);
@@ -80,189 +148,163 @@ $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.
-
 #### 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 SDN 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.
+
+
+## Exception handling
+
+The class now throws **Exceptions** for various error conditions instead of using PHP's `trigger_error()` function. This
+allows for more granular error handling in your application code.
+
+Here is an example of how to catch these Exceptions:
+```php
+<?php
+/**
+ * PHP API usage example with Exception handling
+ */
+use UniFi_API\Exceptions\CurlExtensionNotLoadedException;
+use UniFi_API\Exceptions\CurlGeneralErrorException;
+use UniFi_API\Exceptions\CurlTimeoutException;
+use UniFi_API\Exceptions\InvalidBaseUrlException;
+use UniFi_API\Exceptions\InvalidSiteNameException;
+use UniFi_API\Exceptions\JsonDecodeException;
+use UniFi_API\Exceptions\LoginFailedException;
+use UniFi_API\Exceptions\LoginRequiredException;
+
+/**
+ * load the class using the composer autoloader
+ */
+require_once 'vendor/autoload.php';
+
+/**
+ * include the config file (place your credentials etc. there if not already present)
+ */
+require_once 'config.php';
+
+/**
+ * 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 in config.php)
+ */
+try {
+    $unifi_connection = new UniFi_API\Client($controller_user, $controller_password, $controller_url, $site_id, $controller_version, true);
+    $login            = $unifi_connection->login();
+    $results          = $unifi_connection->list_alarms(); // returns a PHP array containing alarm objects
+} catch (CurlExtensionNotLoadedException $e) {
+    echo 'CurlExtensionNotLoadedException: ' . $e->getMessage(). PHP_EOL;
+} catch (InvalidBaseUrlException $e) {
+    echo 'InvalidBaseUrlException: ' . $e->getMessage(). PHP_EOL;
+} catch (InvalidSiteNameException $e) {
+    echo 'InvalidSiteNameException: ' . $e->getMessage(). PHP_EOL;
+} catch (JsonDecodeException $e) {
+    echo 'JsonDecodeException: ' . $e->getMessage(). PHP_EOL;
+} catch (LoginRequiredException $e) {
+    echo 'LoginRequiredException: ' . $e->getMessage(). PHP_EOL;
+} catch (CurlGeneralErrorException $e) {
+    echo 'CurlGeneralErrorException: ' . $e->getMessage(). PHP_EOL;
+} catch (CurlTimeoutException $e) {
+    echo 'CurlTimeoutException: ' . $e->getMessage(). PHP_EOL;
+} catch (LoginFailedException $e) {
+    echo 'LoginFailedException: ' . $e->getMessage(). PHP_EOL;
+} catch (Exception $e) {
+    /** catch any other Exceptions that might be thrown */
+    echo 'General Exception: ' . $e->getMessage(). PHP_EOL;
+}
+```
+
+Although the PHP DocBlocks for most public methods/functions contain `@throws Exception`, it is recommended to catch
+other specific Exceptions that can be thrown by the API Client class to provide more detailed error messages to your
+application code.
+
+In most cases, the class will let Exceptions bubble up to the calling code, but in some cases it will catch them and
+throw a new Exception with a more specific message.
+
+The `list_alarms.php` example in the `examples/` directory is a good starting point to see how you can implement
+Exception handling.
+

 ## 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 source code for more details on the functions/methods and their respective parameters.
+The class currently supports a large and growing number of functions/methods to access the UniFi Controller API. 
+Please refer to the comments/PHP DocBlocks in the source code for more details on each of the functions/methods,
+their purpose, and their respective parameters.

- login()
- logout()
- adopt_device()
- archive_alarm()
- authorize_guest()
- block_sta()
- count_alarms()
- create_firewallgroup()
- create_hotspotop()
- create_network()
- create_radius_account()
- create_site()
- create_usergroup()
- create_user()
- create_voucher()
- create_wlan()
- custom_api_request()
- delete_device()
- delete_firewallgroup()
- delete_network()
- delete_radius_account()
- delete_site()
- delete_usergroup()
- delete_wlan()
- disable_ap()
- edit_client_fixedip()
- edit_firewallgroup()
- edit_usergroup()
- 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_aps() (deprecated but still available as alias)
- list_backups()
- list_clients()
- list_country_codes()
- list_current_channels()
- list_dashboard()
- list_devices()
- list_dpi_stats()
- list_dynamicdns()
- list_events()
- list_extension()
- list_firewallgroups()
- list_guests()
- list_health()
- list_hotspotop()
- list_known_rogueaps()
- list_networkconf()
- list_portconf()
- list_portforward_stats()
- list_portforwarding()
- list_radius_accounts() (supported on controller version 5.5.19 and higher)
- list_radius_profiles()
- list_rogueaps()
- list_self()
- list_settings()
- list_sites()
- list_tags() (supported on controller version 5.5.19 and higher)
- list_usergroups()
- list_users()
- list_wlan_groups()
- list_wlanconf()
- locate_ap()
- move_device()
- power_cycle_switch_port()
- reconnect_sta()
- rename_ap()
- restart_ap()
- revoke_voucher()
- set_ap_radiosettings()
- set_device_settings_base()
- set_guestlogin_settings()
- set_guestlogin_settings_base()
- set_ips_settings_base() (supported on controller version 5.9.10 and higher)
- set_locate_ap() (deprecated but still available as alias)
- set_networksettings_base()
- set_radius_account_base()
- set_site_connectivity()
- set_site_country()
- set_site_guest_access()
- set_site_locale()
- set_site_mgmt()
- 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_usergroup()
- set_wlan_mac_filter()
- set_wlansettings()
- set_wlansettings_base()
- site_leds()
- site_ledsoff() (deprecated but still available as alias)
- site_ledson() (deprecated but still available as alias)
- spectrum_scan()
- spectrum_scan_state()
- 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_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()
- stat_voucher()
- unauthorize_guest()
- unblock_sta()
- unset_locate_ap() (deprecated but still available as alias)
- upgrade_device()
- upgrade_device_external()
- start_rolling_upgrade()
- cancel_rolling_upgrade()
- cmd_stat()
+If you are using an advanced IDE such as PHPStorm or VS Code, you can use its code completion and other
+features to explore the available functions/methods thanks to the extensive PHP DocBlocks throughout the code.

-Internal functions, getters/setters:

- set_debug()
- get_debug()
- set_site()
- get_site()
- get_cookie() (renamed from getcookie())
- get_last_results_raw()
- get_last_error_message()
+## Looking for version 1.x.x?
+
+With versions 1.x.x of the API client, the code was contained within a single file which can be useful in specific
+cases.
+This has changed with version 2.0.0 where the code is now split into multiple files and is managed using composer.
+
+If you are looking for the version 1.x.x code, you can tell composer to install that version by using the following
+syntax in your `composer.json` file:
+
+```javascript
+{
+    "require": {
+        "art-of-wifi/unifi-api-client": "^1.1"
+    }
+}
+```
+
+Alternatively, you can download the latest 1.x.x code from the [releases page](https://github.com/Art-of-WiFi/UniFi-API-client/releases).

 ## 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
+[Issues section](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.
+#### IMPORTANT NOTE:
+When encountering issues with the UniFi API using other libraries, cURL or Postman, please do **not** open an Issue. Such issues will be closed immediately.
+Please use the [Discussions](https://github.com/Art-of-WiFi/UniFi-API-client/discussions) section instead.
+

 ## 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.ubnt.com/unifi/5.10.19/unifi_sh_api
+- https://dl.ui.com/unifi/8.6.9/unifi_sh_api
+
+## Contributors
+
+A big thanks to all the contributors who have helped with this project!
+
+[![Contributors](https://img.shields.io/github/contributors/Art-of-WiFi/UniFi-API-client)](https://github.com/Art-of-WiFi/UniFi-API-client/graphs/contributors)
+
+If you would like to contribute to this project, please open an issue and include
+your suggestions or code there or else create a pull request.
+

 ## 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.
--- a/composer.json
+++ b/composer.json
@@ -1,31 +1,33 @@
 {
-    "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",
+        "unifi os"
+    ],
+    "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": {
-        "php": ">=5.4.0",
-		"ext-curl": "*"
+        "php": ">=7.4.0",
+        "ext-curl": "*",
+        "ext-json": "*"
    },
    "autoload": {
        "psr-4": {
            "UniFi_API\\": "src/"
        }
    }
-}
+}
--- a/examples/README.md
+++ b/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

--- a/examples/ap_scanning_state.php
+++ b/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
@@ -28,7 +28,14 @@ $ap_mac  = '<enter MAC address of Access Point to check>';
 * initialize the UniFi API connection class and log in to the controller and do our thing
 * spectrum_scan_state()
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$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->spectrum_scan_state($ap_mac);
--- a/examples/ap_upgrade_firmware.php
+++ b/examples/ap_upgrade_firmware.php
@@ -3,11 +3,11 @@
 * PHP API usage example
 *
 * contributed by: @4oo4
- * description: example script to check and 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
@@ -24,8 +24,15 @@ $device_mac = '<enter MAC address of device to update>';
 * initialize the UniFi API connection class, log in to the controller
 * (this example assumes you have already assigned the correct values in config.php to the variables used)
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, false);
-$login            = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$login = $unifi_connection->login();

 /**
 * Run the actual upgrade
--- a/examples/auth_guest_basic.php
+++ b/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
@@ -45,9 +45,16 @@ $site_id = '<enter your site id here>';
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();

 /**
 * then we authorize the device for the requested duration
--- a/examples/auth_guest_with_note.php
+++ b/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
@@ -42,9 +42,16 @@ $note = 'Note to attach to newly authorized device';
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();

 /**
 * we authorize the device for the requested duration and attach the note to it's object
--- a/examples/block_list.php
+++ b/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;

 /**
@@ -43,11 +42,18 @@ if ($site_id == "MUST_DEFINE_THIS") {
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login(); // always true regardless of site id
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);

-foreach ($macs_to_block as &$mac) {
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login(); // always true regardless of site id
+
+foreach ($macs_to_block as $mac) {
    // block_result is always true even if mac address does not exist :(
    $block_result = $unifi_connection->block_sta($mac);

--- a/examples/change_super_mgmt.php
+++ b/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,26 +18,33 @@ 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;

 /**
 * 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, true);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
-$site_settings    = $unifi_connection->list_settings();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);

-$super_mgmt_settings = [];
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$site_settings  = $unifi_connection->list_settings();
+
+$super_mgmt_settings    = [];
 $super_mgmt_settings_id = '';

 if (!empty($site_settings)) {
-    foreach($site_settings as $section) {
+    foreach ($site_settings as $section) {
        echo 'section key: ' . $section->key . PHP_EOL;
        if ($section->key === 'super_mgmt') {
-            $super_mgmt_settings = $section;
+            $super_mgmt_settings    = $section;
            $super_mgmt_settings_id = $section->_id;
        }
    }
--- a/examples/change_wlan_password.php
+++ b/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
@@ -35,10 +35,17 @@ $new_password = '<new password goes here>';
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$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->set_wlansettings($wlan_id, $new_password);
+$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->set_wlansettings($wlan_id, $new_password);

 /**
 * provide feedback in json format
--- a/examples/config.template.php
+++ b/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
 */

 /**
@@ -15,8 +13,9 @@
 */
 $controlleruser     = ''; // the user name for access to the UniFi Controller
 $controllerpassword = ''; // the password for access to the UniFi Controller
-$controllerurl      = ''; // full url to the UniFi Controller, eg. 'https://22.22.11.11:8443'
-$controllerversion  = ''; // the version of the Controller software, eg. '4.6.6' (must be at least 4.0.0)
+$controllerurl      = ''; // full url to the UniFi Controller, eg. 'https://22.22.11.11:8443', for UniFi OS-based
+                          // controllers a port suffix isn't required, no trailing slashes should be added
+$controllerversion  = ''; // the version of the Controller software, e.g. '4.6.6' (must be at least 4.0.0)

 /**
 * set to true (without quotes) to enable debug output to the browser and the PHP error log
--- a/examples/create_site.php
+++ b/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
@@ -30,9 +30,16 @@ $description = 'new site';
 /**
 * 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);
-$loginresults     = $unifi_connection->login();
-$results          = $unifi_connection->create_site($description);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$loginresults = $unifi_connection->login();
+$results      = $unifi_connection->create_site($description);

 /**
 * provide feedback in json format
--- a/examples/create_voucher.php
+++ b/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)
@@ -35,9 +35,16 @@ $site_id = '<enter your site id here>';
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();

 /**
 * then we create the required number of vouchers with the requested expiration value
--- a/examples/delete_site.php
+++ b/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
@@ -31,9 +31,16 @@ $site_to_delete = '<_id value of the site>';
 /**
 * 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);
-$loginresults     = $unifi_connection->login();
-$results          = $unifi_connection->delete_site($site_to_delete);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$loginresults = $unifi_connection->login();
+$results      = $unifi_connection->delete_site($site_to_delete);

 /**
 * provide feedback in json format
--- a/examples/disable_device.php
+++ b/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
@@ -30,9 +30,16 @@ $site_id = '<enter your site id here>';
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();

 /**
 * then we disable the device
--- a/examples/disable_switch_port.php
+++ b/examples/disable_switch_port.php
@@ -0,0 +1,85 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example PHP script to disable/enable the port of a UniFi switch
+ * note:           Requires controller version 5.5.X or higher. This example assumes an override alreay exists for the desired port.
+ *                 To create a new port override simply append one (similar in structure to $updated_override) as needed to the
+ *                 $existing_overrides array
+ */
+
+/**
+ * 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';
+
+/**
+ * the site to use to log in to the controller
+ */
+$site_id = '<enter your site id here>';
+
+/**
+ * the MAC address of the UniFi switch to re-configure
+ */
+$device_mac = '<enter MAC address>';
+
+/**
+ * index of port to modify/add
+ */
+$port_idx = 24;
+
+/**
+ * port configuration id to apply when enabling/disabling the port
+ *
+ * NOTE:
+ * port configurations are available through list_portconf()
+ */
+$port_conf_id = '<enter _id value of desired port configuration>';
+
+/**
+ * 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_devices($device_mac);
+$device_id          = $data[0]->device_id;
+$existing_overrides = $data[0]->port_overrides;
+
+foreach ($existing_overrides as $key => $value) {
+    if (!empty($value->port_idx) && $value->port_idx === $port_idx) {
+        $updated_override = [
+            'portconf_id' => $port_conf_id,
+            'port_idx'    => $port_idx,
+            'poe_mode'    => $value->poe_mode,
+            'name'        => 'Your-port-name',
+        ];
+
+        $existing_overrides[$key] = $updated_override;
+    }
+}
+
+$payload = [
+    'port_overrides' => $existing_overrides
+];
+
+$update_device = $unifi_connection->set_device_settings_base($device_id, $payload);
+
+/**
+ * provide feedback in json format
+ */
+echo json_encode($update_device, JSON_PRETTY_PRINT);
--- a/examples/execute_custom_api_request.php
+++ b/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,18 +27,25 @@ $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
 */
-$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);
+$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_method, $payload, $return);

 /**
 * provide feedback in JSON format or as PHP Object
--- a/examples/extend_guest_auth.php
+++ b/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!
@@ -23,9 +23,16 @@ require_once('config.php');
 $site_id   = "default";
 $site_name = "*enter your site name*";

-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();

 if ($loginresults === 400) {
    print "UniFi controller login failure, please check your credentials in config.php.\n";
@@ -36,7 +43,8 @@ if ($loginresults === 400) {
     * loop thru all known guests
     */
    foreach ($guestlist as $guest) {
-        print "<pre>" . $guest->_id . " (" . $guest->mac . "), valid until " . date(DATE_ATOM, $guest->end) . " (" . $guest->end . ")</pre>";
+        print "<pre>" . $guest->_id . " (" . $guest->mac . "), valid until " .
+              date(DATE_ATOM, $guest->end) . " (" . $guest->end . ")</pre>";

        /**
         * just a sample: only extend validity of guests which have end date after 2017-04-02
--- a/examples/list_alarms.php
+++ b/examples/list_alarms.php
@@ -3,19 +3,34 @@
 * 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: An example basic PHP script to pull current alarms from the UniFi controller and output in JSON format,
+ *              also demonstrates how to catch exceptions.
 */
+use UniFi_API\Exceptions\CurlExtensionNotLoadedException;
+use UniFi_API\Exceptions\CurlGeneralErrorException;
+use UniFi_API\Exceptions\CurlTimeoutException;
+use UniFi_API\Exceptions\InvalidBaseUrlException;
+use UniFi_API\Exceptions\InvalidSiteNameException;
+use UniFi_API\Exceptions\JsonDecodeException;
+use UniFi_API\Exceptions\LoginFailedException;
+use UniFi_API\Exceptions\LoginRequiredException;

 /**
 * 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
+ * Include the config file (place your credentials etc. there if not already present), see the config.template.php
+ * file for an example.
+ *
+ * @var array $controlleruser
+ * @var array $controllerpassword
+ * @var array $controllerurl
+ * @var array $controllerversion
+ * @var array $debug
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * the site to use
@@ -25,12 +40,40 @@ $site_id = '<enter your site id here>';
 /**
 * 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_alarms();
+try {
+    $unifi_connection = new UniFi_API\Client(
+        $controlleruser,
+        $controllerpassword,
+        $controllerurl,
+        $site_id,
+        $controllerversion
+    );

-/**
- * provide feedback in json format
- */
-echo json_encode($data, JSON_PRETTY_PRINT);
+    $set_debug_mode = $unifi_connection->set_debug($debug);
+    $login_results  = $unifi_connection->login();
+    $data           = $unifi_connection->list_alarms();
+
+    /**
+     * echo the results in JSON format
+     */
+    echo json_encode($data, JSON_PRETTY_PRINT);
+} catch (CurlExtensionNotLoadedException $e) {
+    echo 'CurlExtensionNotLoadedException: ' . $e->getMessage(). PHP_EOL;
+} catch (InvalidBaseUrlException $e) {
+    echo 'InvalidBaseUrlException: ' . $e->getMessage(). PHP_EOL;
+} catch (InvalidSiteNameException $e) {
+    echo 'InvalidSiteNameException: ' . $e->getMessage(). PHP_EOL;
+} catch (JsonDecodeException $e) {
+    echo 'JsonDecodeException: ' . $e->getMessage(). PHP_EOL;
+} catch (LoginRequiredException $e) {
+    echo 'LoginRequiredException: ' . $e->getMessage(). PHP_EOL;
+} catch (CurlGeneralErrorException $e) {
+    echo 'CurlGeneralErrorException: ' . $e->getMessage(). PHP_EOL;
+} catch (CurlTimeoutException $e) {
+    echo 'CurlTimeoutException: ' . $e->getMessage(). PHP_EOL;
+} catch (LoginFailedException $e) {
+    echo 'LoginFailedException: ' . $e->getMessage(). PHP_EOL;
+} catch (Exception $e) {
+    /** catch any other Exceptions that might be thrown */
+    echo 'General Exception: ' . $e->getMessage(). PHP_EOL;
+}
--- a/examples/list_ap_connected_users.php
+++ b/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
@@ -26,10 +26,17 @@ $site_id = '<enter your site id here>';
 /**
 * initialize the UniFi API connection class and log in to the controller and pull the requested data
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
-$aps_array        = $unifi_connection->list_aps();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$aps_array      = $unifi_connection->list_aps();

 /**
 * output the results in HTML format
--- a/examples/list_connected_users.php
+++ b/examples/list_connected_users.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * 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
+ */
+/**
+ * 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';
+
+/**
+ * the short name of the site which you wish to query
+ */
+$site_id = '<enter your site id here>';
+
+/**
+ * initialize the UniFi API connection class and log in to the controller and pull the requested data
+ */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$clients_array  = $unifi_connection->list_clients();
+
+/**
+ * output the results in JSON format
+ */
+header('Content-Type: application/json; charset=utf-8');
+echo json_encode($clients_array);
--- a/examples/list_site_health.php
+++ b/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
@@ -26,14 +26,20 @@ $site_id = '<enter your site id here>';
 /**
 * initialize the UniFi API connection class and log in to the controller and pull the requested data
 */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);

-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
-$result           = $unifi_connection->list_health();
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$result         = $unifi_connection->list_health();

 /**
 * output the results in correct json formatting
 */
 header('Content-Type: application/json');
-echo (json_encode($result, JSON_PRETTY_PRINT));
+echo(json_encode($result, JSON_PRETTY_PRINT));
--- a/examples/list_sites.php
+++ b/examples/list_sites.php
@@ -0,0 +1,53 @@
+<?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;
--- a/examples/list_social_auth_details.php
+++ b/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
@@ -26,10 +26,17 @@ $site_id = '<enter your site id here>';
 /**
 * 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->stat_payment();
+$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->stat_payment();

 /**
 * cycle through the results and print social auth details if set,
--- a/examples/list_user_stats.php
+++ b/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
@@ -38,12 +38,19 @@ $attribs = ['rx_bytes', 'tx_bytes'];
 /**
 * 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, true);
-$set_debug_mode   = $unifi_connection->set_debug(false);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
 //$data             = $unifi_connection->stat_5minutes_user($mac, null, null, $attribs);
 //$data             = $unifi_connection->stat_hourly_user($mac, null, null, $attribs);
-$data             = $unifi_connection->stat_daily_user($mac, null, null, $attribs);
+$data = $unifi_connection->stat_daily_user($mac, null, null, $attribs);

 /**
 * provide feedback in json format
--- a/examples/modify_smartpower_pdu_outlet.php
+++ b/examples/modify_smartpower_pdu_outlet.php
@@ -0,0 +1,100 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example basic PHP script to toggle power of an outlet on the UniFi SmartPower PDU Pro,
+ *                 last tested with UniFi controller version 6.1.19
+ */
+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';
+
+/**
+ * the site to use
+ */
+$site_id = 'default';
+
+/**
+ * MAC of UniFi SmartPower PDU Pro to work with
+ */
+$pdu_mac = '<MAC ADDRESS of PDU>';
+
+/**
+ * index value of the outlet to modify
+ */
+$outlet_idx = 20;
+
+/**
+ * new values for relay_state (enable/disable Power) and cycle_enabled (disable/enable Modem Power Cycle) for the above outlet,
+ * values must be boolean (true/false)
+ *
+ * NOTES:
+ * - here you can choose to also change the name of the outlet
+ * - outlet overrides are structured like this:
+ *    {
+ *        "index": 1,
+ *        "name": "USB Outlet 1",
+ *        "cycle_enabled": false,
+ *        "relay_state": true
+ *    }
+ */
+$new_relay_state   = true;
+$new_cycle_enabled = false;
+
+/**
+ * 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();
+if (!$loginresults) {
+    echo 'we encountered a login error!';
+    echo PHP_EOL;
+    exit();
+}
+
+$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;
+
+    foreach ($outlet_overrides as $key => $value) {
+        if ($value->index === $outlet_idx) {
+            $outlet_overrides[$key]->relay_state   = $new_relay_state;
+            $outlet_overrides[$key]->cycle_enabled = $new_cycle_enabled;
+        }
+    }
+
+    $pdu_update = $unifi_connection->set_device_settings_base($device_id,
+        ['outlet_overrides' => $outlet_overrides]);
+
+    /**
+     * provide feedback in json format
+     */
+    echo 'results:' . PHP_EOL . PHP_EOL;
+    echo json_encode($pdu_update, JSON_PRETTY_PRINT);
+} else {
+    echo 'not a PDU device?';
+}
+echo PHP_EOL;
--- a/examples/reconnect_client.php
+++ b/examples/reconnect_client.php
@@ -0,0 +1,52 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example basic PHP script to force a client device to reconnect
+ */
+
+/**
+ * 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';
+
+/**
+ * the MAC address to reconnect
+ */
+$mac_to_reconnect = '<MAC address>';
+
+/**
+ * site where the above MAC address is connected
+ */
+$site_id = '<enter your site id here>';
+
+/**
+ * initialize the UniFi API connection class and log in to the controller
+ */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+
+/**
+ * then we force the device to reconnect
+ */
+$reconnect_result = $unifi_connection->reconnect_sta($mac_to_reconnect);
+
+/**
+ * provide feedback in json format
+ */
+echo json_encode($reconnect_result, JSON_PRETTY_PRINT);
--- a/examples/set_vlan_to_port.php
+++ b/examples/set_vlan_to_port.php
@@ -0,0 +1,153 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Samuel Schnelly
+ * description:    example basic PHP script to change VLAN on port
+ */
+
+/**
+ * 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';
+
+/**
+ * the site to use
+ */
+$site_id = '<enter your site id here>';
+
+/**
+ * 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();
+
+/**
+ * change VLAN on port
+ */
+$port = 1;
+$vlan = 200;
+
+/**
+ * MAC Address of the UniFi device
+ */
+$mac = '<enter your device mac address here>';
+
+set_port_vlan($mac, $port, $vlan, $unifi_connection);
+
+/**
+ * Set specific VLAN on device port
+ *
+ * @param string $device_mac MAC Address of UNIFI device
+ * @param int $port_idx Port number of UNIFI device, note: started by 1
+ * @param int $vlan_id VLAN ID to set
+ * @param UniFi_API\Client $unifi_connection
+ *
+ * @return bool true if result is success, false upon failure
+ */
+function set_port_vlan($device_mac, $port_idx, $vlan_id, $unifi_connection)
+{
+    $device = $unifi_connection->list_devices($device_mac);
+
+    // if no device found
+    if (count($device) == 0) {
+        trigger_error('set_port_vlan() device not found');
+        return false;
+    }
+
+    $port_table = $device[0]->port_table;
+    $def_port   = null;
+
+    // check if port exists
+    $exist = false;
+    foreach ($port_table as $key => $port) {
+        if ($port->port_idx == $port_idx) {
+            $exist    = true;
+            $def_port = $port;
+            break;
+        }
+    }
+
+    if (!$exist) {
+        trigger_error('set_port_vlan() port_idx not found on device');
+        return false;
+    }
+
+    // check if vlan exists
+    $native_networkconf_id = null;
+
+    foreach ($unifi_connection->list_networkconf() as $key => $network) {
+        if ($network->purpose == 'vlan-only' && $network->vlan == $vlan_id) {
+            $native_networkconf_id = $network->_id;
+        }
+    }
+
+    if ($native_networkconf_id === null) {
+        trigger_error('set_port_vlan() vlan not exist');
+        return false;
+    }
+
+    $exist = false;
+    foreach ($device[0]->port_overrides as $key => $port) {
+        if ($port->port_idx == $port_idx) {
+            $exist                                                  = true;
+            $device[0]->port_overrides[$key]->native_networkconf_id = $native_networkconf_id;
+            break;
+        }
+    }
+
+    if (!$exist) {
+        $device[0]->port_overrides[] = [
+            'port_idx'                              => isset($port_idx) ? $port_idx : 1,
+            'setting_preference'                    => isset($setting_preference) ? $setting_preference : 'auto',
+            'name'                                  => isset($def_port->name) ? $def_port->name : 'Port 1',
+            'op_mode'                               => isset($def_port->op_mode) ? $def_port->op_mode : 'switch',
+            'port_security_enabled'                 => isset($def_port->port_security_enabled) ? $def_port->port_security_enabled : false,
+            'port_security_mac_address'             => isset($def_port->port_security_mac_address) ? $def_port->port_security_mac_address : [],
+            'native_networkconf_id'                 => isset($native_networkconf_id) ? $native_networkconf_id : '',
+            'excluded_networkconf_ids'              => isset($def_port->excluded_networkconf_ids) ? $def_port->excluded_networkconf_ids : [],
+            'show_traffic_restriction_as_allowlist' => isset($def_port->show_traffic_restriction_as_allowlist) ? $def_port->show_traffic_restriction_as_allowlist : false,
+            'forward'                               => isset($def_port->forward) ? $def_port->forward : 'customize',
+            'lldpmed_enabled'                       => isset($def_port->lldpmed_enabled) ? $def_port->lldpmed_enabled : true,
+            'voice_networkconf_id'                  => isset($def_port->voice_networkconf_id) ? $def_port->voice_networkconf_id : '',
+            'stormctrl_bcast_enabled'               => isset($def_port->stormctrl_bcast_enabled) ? $def_port->stormctrl_bcast_enabled : false,
+            'stormctrl_bcast_rate'                  => isset($def_port->stormctrl_bcast_rate) ? $def_port->stormctrl_bcast_rate : 100,
+            'stormctrl_mcast_enabled'               => isset($def_port->stormctrl_mcast_enabled) ? $def_port->stormctrl_mcast_enabled : false,
+            'stormctrl_mcast_rate'                  => isset($def_port->stormctrl_mcast_rate) ? $def_port->stormctrl_mcast_rate : 100,
+            'stormctrl_ucast_enabled'               => isset($def_port->stormctrl_ucast_enabled) ? $def_port->stormctrl_ucast_enabled : false,
+            'stormctrl_ucast_rate'                  => isset($def_port->stormctrl_ucast_rate) ? $def_port->stormctrl_ucast_rate : 100,
+            'egress_rate_limit_kbps_enabled'        => isset($def_port->egress_rate_limit_kbps_enabled) ? $def_port->egress_rate_limit_kbps_enabled : false,
+            'autoneg'                               => isset($def_port->autoneg) ? $def_port->autoneg : true,
+            'isolation'                             => isset($def_port->isolation) ? $def_port->isolation : false,
+            'stp_port_mode'                         => isset($def_port->stp_port_mode) ? $def_port->stp_port_mode : true,
+            'port_keepalive_enabled'                => isset($def_port->port_keepalive_enabled) ? $def_port->port_keepalive_enabled : false
+        ];
+
+    }
+
+    $payload = [
+        'port_overrides' => $device[0]->port_overrides
+    ];
+
+    $result = $unifi_connection->set_device_settings_base($device[0]->device_id, $payload);
+
+    if ($result) {
+        return true;
+    }
+
+    return false;
+}
--- a/examples/test_connection.php
+++ b/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,13 +11,14 @@
 * 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) {
-    print 'SSL is not supported with this cURL installation!' . PHP_EOL;
+if (!(curl_version()['features'] & CURL_VERSION_SSL)) {
+    print PHP_EOL . 'SSL is not supported with this cURL installation!' . PHP_EOL;
 }

 /**
@@ -25,44 +26,53 @@ if (!curl_version()['features'] & CURL_VERSION_SSL) {
 */
 $ch = curl_init();

-/**
- * 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);
+if (is_resource($ch) || is_object($ch)) {
+    /**
+     * 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_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,
+    ];

-/**
- * This cURL option 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_setopt_array($ch, $curl_options);

-/**
- * Be more verbose
- */
-curl_setopt($ch, CURLOPT_VERBOSE, true);
+    /**
+     * $results contains the output as returned by the cURL request,
+     * returns true when successful, else returns false
+     */
+    print PHP_EOL . 'verbose output from the cURL request:' . PHP_EOL;
+    $results = curl_exec($ch);

-/**
- * $results contains the output as returned by the cURL request,
- * returns true when successful, else returns false
- */
-print 'verbose output from the cURL request:' . PHP_EOL;
-$results = curl_exec($ch);
+    print PHP_EOL . 'curl_getinfo output:' . PHP_EOL;
+    print_r(curl_getinfo($ch));

-print PHP_EOL . 'curl_getinfo output:' . PHP_EOL;
-print_r(curl_getinfo($ch));
+    /**
+     * If we receive a cURL error, output it before the results
+     */
+    if (curl_errno($ch)) {
+        print PHP_EOL . 'cURL error: ' . curl_error($ch) . PHP_EOL;
+    }

-/**
- * If we receive a cURL error, output it before the results
- */
-if (curl_errno($ch)) {
-    print PHP_EOL . 'cURL error: ' . curl_error($ch) . 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;
 }
-
-print PHP_EOL . '$results:' . PHP_EOL;
-print_r($results);
-print PHP_EOL;
--- a/examples/toggle_auto_update_settings.php
+++ b/examples/toggle_auto_update_settings.php
@@ -0,0 +1,69 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description: example to toggle the site-wide auto upgrade setting on a UniFi controller
+ */
+
+/**
+ * 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
+ *
+ * @var string $controlleruser the user name for access to the UniFi Controller
+ * @var string $controllerpassword the password for access to the UniFi Controller
+ * @var string $controllerurl full url to the UniFi Controller, eg. 'https://
+ * @var string $controllerversion the version of the Controller software, eg. '4.6.6' (must be at least 4.0.0)
+ * @var bool $debug set to true (without quotes) to enable debug output to the browser and the PHP error log
+ */
+require_once('config.php');
+
+/**
+ * site id for the site where settings are to be updated
+ */
+$site_id = 'zzzzz';
+
+/**
+ * initialize the UniFi API connection class and log in to the controller to do our thing
+ */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$login_results = $unifi_connection->login();
+
+if ($login_results) {
+    /**
+     * we get the current site mgmt settings
+     */
+    $current_site_settings = $unifi_connection->list_settings();
+
+    $mgmt_settings = [];
+    foreach ($current_site_settings as $section) {
+        if ($section->key == 'mgmt') {
+            $mgmt_settings = $section;
+        }
+    }
+
+    /**
+     * toggle the auto upgrade setting and set the auto upgrade hour to 3
+     */
+    $mgmt_settings->auto_upgrade      = !$mgmt_settings->auto_upgrade;
+    $mgmt_settings->auto_upgrade_hour = 3;
+    $mgmt_id                          = $mgmt_settings->_id;
+    $set_result                       = $unifi_connection->set_site_mgmt($mgmt_id, $mgmt_settings);
+
+    echo 'done' . PHP_EOL;
+    exit();
+}
+
+echo 'login failed' . PHP_EOL;
--- a/examples/toggle_led.php
+++ b/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
@@ -31,9 +31,16 @@ $mac = '<enter MAC address of your AP here>';
 /**
 * initialize the UniFi API connection class and log in to the controller to do our thing
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion); // initialize the class instance
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login();
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();

 /**
 * using the new method/function
--- a/examples/unblock_list.php
+++ b/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;

 /**
@@ -43,9 +43,16 @@ if ($site_id == "MUST_DEFINE_THIS") {
 /**
 * initialize the UniFi API connection class and log in to the controller
 */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
-$loginresults     = $unifi_connection->login(); // always true regardless of site id
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login(); // always true regardless of site id

 foreach ($macs_to_unblock as &$mac) {
    // block_result is always true even if mac address does not exist :(
--- a/examples/update_ac-iw_ports.php
+++ b/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
@@ -47,11 +47,11 @@ $port_conf_id_port_2 = '<_id of port configuration to apply to port #2>';
 $new_ports_config = [
    'port_overrides' => [
        [
-            'port_idx' => 1,
+            'port_idx'    => 1,
            'portconf_id' => $port_conf_id_port_1
        ],
        [
-            'port_idx' => 2,
+            'port_idx'    => 2,
            'portconf_id' => $port_conf_id_port_2
        ]
    ]
@@ -60,12 +60,19 @@ $new_ports_config = [
 /**
 * 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, false);
-$set_debug_mode   = $unifi_connection->set_debug(false);
-$loginresults     = $unifi_connection->login();
-$data             = $unifi_connection->list_devices($device_mac);
-$device_id        = $data[0]->device_id;
-$update_device    = $unifi_connection->set_device_settings_base($device_id, $new_ports_config);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_devices($device_mac);
+$device_id      = $data[0]->device_id;
+$update_device  = $unifi_connection->set_device_settings_base($device_id, $new_ports_config);

 if (!$update_device) {
    $error = $unifi_connection->get_last_results_raw();
--- a/examples/update_device_wlan_settings_5.5.X.php
+++ b/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
@@ -51,22 +51,29 @@ $na_channel = 44;
 /**
 * 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, false);
-$set_debug_mode   = $unifi_connection->set_debug(false);
-$loginresults     = $unifi_connection->login();
-$data             = $unifi_connection->list_devices($ap_mac);
-$radio_table      = $data[0]->radio_table;
-$device_id        = $data[0]->device_id;
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_devices($ap_mac);
+$radio_table    = $data[0]->radio_table;
+$device_id      = $data[0]->device_id;

 foreach ($radio_table as $radio) {
    if ($radio->radio === 'ng') {
        $radio->tx_power_mode = $ng_tx_power_mode;
-        $radio->channel = $ng_channel;
+        $radio->channel       = $ng_channel;
    }

    if ($radio->radio === 'na') {
        $radio->tx_power_mode = $na_tx_power_mode;
-        $radio->channel = $na_channel;
+        $radio->channel       = $na_channel;
    }
 }

--- a/examples/update_switch_poe-mode.php
+++ b/examples/update_switch_poe-mode.php
@@ -0,0 +1,105 @@
+<?php
+/**
+ * PHP API usage example to turn the PoE of the selected switch ports to "off" or "auto"
+ *
+ * contributed by: @Kaltt
+ * description:    A use case for this script is to turn off the PoE of the port where a camera is connected in order to turn off the camera
+ *
+ * usage:          If the file is called via a web URL, it should be called like: update_switch_poe-mode.php?poe_mode=off
+ *                 If the file is called via the command line, it should be called like: php update_switch_poe-mode.php off
+ *                 The values can be "off" or "auto"
+ *
+ * IMPORTANT INFORMATION:
+ * This example no longer works with controller versions 7.1.X and higher. You now need to work with port profiles to enable POE on a switch port.
+ */
+
+/**
+ * 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';
+
+/**
+ * the site to use to log in to the controller
+ */
+$site_id = '<short site name of a site the credentials used have access to>';
+
+/**
+ * the MAC address of the AC-IW device to re-configure
+ */
+$device_mac = '<enter MAC address>';
+
+/**
+ * $lanports is an array that defines which ports should be changed
+ */
+$lanports = [6];
+
+/**
+ * This is the function that reads out the current port configuration and changes the value for the poe_mode for the ports defined in $lanports
+ */
+function update_ports($running_config, $ports, $poe_mode)
+{
+    /**
+     * Update already non-default ports
+     */
+    $running_config_count = count($running_config);
+    for ($i = 0; $i < $running_config_count; $i++) {
+        if (in_array($running_config[$i]->port_idx, $ports)) {
+            $running_config[$i]->poe_mode = $poe_mode;
+            unset($ports[array_search($running_config[$i]->port_idx, $ports)]);
+        }
+    }
+
+    $add_conf = [];
+    foreach ($ports as $port) {
+        $add_conf[] = [
+            'port_idx' => $port,
+            'poe_mode' => $poe_mode
+        ];
+    }
+
+    return array_merge($running_config, $add_conf);
+}
+
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_devices($device_mac);
+$device_id      = $data[0]->device_id;
+$current_conf   = $data[0]->port_overrides;
+
+/**
+ * This reads in the values provided via URL or in the command line, if nothing is set than it will poe_mode will be set to "auto"
+ */
+if (isset($_GET['poe_mode'])) {
+    $poe_mode = $_GET['poe_mode'];
+} elseif (isset($argv[1])) {
+    $poe_mode = $argv[1];
+} else {
+    $poe_mode = 'auto';
+}
+
+$new_ports_config = [
+    'port_overrides' => update_ports($current_conf, $lanports, $poe_mode)
+];
+
+$update_device = $unifi_connection->set_device_settings_base($device_id, $new_ports_config);
+
+if (!$update_device) {
+    $error = $unifi_connection->get_last_results_raw();
+    echo json_encode($error, JSON_PRETTY_PRINT);
+}
+
+echo json_encode($update_device, JSON_PRETTY_PRINT);
--- a/src/Client.php
+++ b/src/Client.php
--- a/src/Exceptions/CurlExtensionNotLoadedException.php
+++ b/src/Exceptions/CurlExtensionNotLoadedException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class CurlExtensionNotLoadedException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('The PHP curl extension is not loaded. Please correct this before proceeding!');
+    }
+}
--- a/src/Exceptions/CurlGeneralErrorException.php
+++ b/src/Exceptions/CurlGeneralErrorException.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class CurlGeneralErrorException extends Exception
+{
+    /** @var mixed $_http_response_code */
+    private $_http_response_code;
+
+    /** @var mixed $_curl_getinfo_results */
+    private $_curl_getinfo_results;
+
+    public function __construct(string $message, $http_response_code, $_curl_getinfo_results)
+    {
+        $this->_http_response_code   = $http_response_code;
+        $this->_curl_getinfo_results = $_curl_getinfo_results;
+
+        parent::__construct($message);
+    }
+
+    /**
+     * Get the HTTP response code.
+     *
+     * @return mixed
+     */
+    public function getHttpResponseCode()
+    {
+        return $this->_http_response_code;
+    }
+
+    /**
+     * Get the cURL curl_getinfo results.
+     *
+     * @return mixed
+     */
+    public function getCurlGetinfoResults()
+    {
+        return $this->_curl_getinfo_results;
+    }
+}
--- a/src/Exceptions/CurlTimeoutException.php
+++ b/src/Exceptions/CurlTimeoutException.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class CurlTimeoutException extends Exception
+{
+    /** @var mixed $_http_response_code */
+    private $_http_response_code;
+
+    /** @var mixed $_curl_getinfo_results */
+    private $_curl_getinfo_results;
+
+    public function __construct(string $message, $http_response_code, $curl_getinfo_results)
+    {
+        $this->_http_response_code   = $http_response_code;
+        $this->_curl_getinfo_results = $curl_getinfo_results;
+
+        parent::__construct($message);
+    }
+
+    /**
+     * Get the HTTP response code.
+     *
+     * @return mixed
+     */
+    public function getHttpResponseCode()
+    {
+        return $this->_http_response_code;
+    }
+
+    /**
+     * Get the cURL curl_getinfo results.
+     *
+     * @return mixed
+     */
+    public function getCurlGetinfoResults()
+    {
+        return $this->_curl_getinfo_results;
+    }
+}
--- a/src/Exceptions/EmailInvalidException.php
+++ b/src/Exceptions/EmailInvalidException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class EmailInvalidException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('Invalid email address provided.');
+    }
+}
--- a/src/Exceptions/InvalidBaseUrlException.php
+++ b/src/Exceptions/InvalidBaseUrlException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class InvalidBaseUrlException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('The base URL provided is invalid.');
+    }
+}
--- a/src/Exceptions/InvalidCurlMethodException.php
+++ b/src/Exceptions/InvalidCurlMethodException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class InvalidCurlMethodException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('Invalid cURL method provided.');
+    }
+}
--- a/src/Exceptions/InvalidSiteNameException.php
+++ b/src/Exceptions/InvalidSiteNameException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class InvalidSiteNameException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('Invalid site name provided.');
+    }
+}
--- a/src/Exceptions/JsonDecodeException.php
+++ b/src/Exceptions/JsonDecodeException.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class JsonDecodeException extends Exception
+{
+    //
+}
--- a/src/Exceptions/LoginFailedException.php
+++ b/src/Exceptions/LoginFailedException.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class LoginFailedException extends Exception
+{
+    //
+}
--- a/src/Exceptions/LoginRequiredException.php
+++ b/src/Exceptions/LoginRequiredException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class LoginRequiredException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('This method requires the API client to be logged in first.');
+    }
+}
--- a/src/Exceptions/MethodDeprecatedException.php
+++ b/src/Exceptions/MethodDeprecatedException.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace UniFi_API\Exceptions;
+
+use Exception;
+
+class MethodDeprecatedException extends Exception
+{
+    //
+}