bumped version to 1.1.101

- added a private property $cookies_created_at to store the timestamp when the cookies were created/updated.
- added a getter method get_cookies_created_at() to return the timestamp when the cookies were created/updated. This information can be useful to determine how old the cookies are. - minor comments clean up
2024-11-15 10:33:11 +01:00 · 2024-11-15 10:31:10 +01:00 · 2024-11-04 13:43:57 +01:00 · 2024-11-04 13:38:18 +01:00 · 2024-11-04 13:37:01 +01:00 · 2024-11-04 13:34:41 +01:00
38 changed files with 3173 additions and 1984 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -10,4 +10,7 @@
 .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,37 +1,96 @@
 ## UniFi Controller API client class

-A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API, versions 4.X.X and 5.X.X of the UniFi Network Controller software are supported (version 5.12.72 has been confirmed to work) as well as UbiOS-based controllers (version 5.12.59 has been confirmed to work). This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
+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.5.6 is confirmed**) |
+| UniFi OS                             | 3.X, 4.X (**4.1.15 is confirmed**)                  |

-The package can be installed manually or by using composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for easy inclusion in your projects.

 ## Requirements

- a server with PHP, version 5.5.0 or higher, and the PHP cURL module installed (tested on Apache 2.4 with PHP Version 5.6.1 and cURL 7.42.1 and with PHP 7.2.24 and cURL 7.58.0)
- direct network connectivity between this server and the host and port (normally TCP port 8443) where the UniFi Controller is running
- you must use **local accounts**, not UniFi Cloud accounts, to access the UniFi Controller API through this class
+- a server with:
+  - PHP **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
+  - tested on Apache 2.4 with PHP 7.4.27 and cURL 7.60.0 and with PHP 8.3.11 and cURL 7.81.0
+- direct network connectivity between this server and the host and port (usually TCP port 8443 or port 443 for 
+  UniFi OS) where the UniFi Controller is running
+- you **must** use 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


-## UbiOS Support
+## UniFi OS Support

-Support for UbiOS-based controllers (UniFi Dream Machine Pro) has been added as of version 1.1.47. The class automatically detects UbiOS devices and adjusts URLs and several functions/methods accordingly. If your own code applies strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix when dealing with a UbiOS-based controller.
+Support for UniFi OS-based controllers has been added as of 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 a previous version
+
+When upgrading from a version before **1.1.84**, please:
+- make sure you are using PHP **7.4** or higher
+- test the client with your code for any breaking changes; the class methods now have strict parameter type hints and 
+  response types which can break your code in certain cases where the wrong type is passed or a different response type
+  is expected back

-Please test all methods you plan on using thoroughly before using the API Client with UbiOS devices in a production environment.

 ## Installation

-You can use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the API client class.
+Use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the 
+API client class.
+

 ### Composer

-The preferred installation method is through [composer](https://getcomposer.org). Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have composer installed.
+The preferred installation method is through [composer](https://getcomposer.org). 
+Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you don't have composer
+installed already.

-Once composer is installed, simply execute this command from the shell in your project directory:
+Once composer is installed, simply execute this command from the shell in your project
+directory:

 ```sh
 composer require art-of-wifi/unifi-api-client
 ```

- Or you can manually add the package to your composer.json file:
+Or manually add the package to your composer.json file:

 ```javascript
 {
@@ -41,12 +100,16 @@ composer require art-of-wifi/unifi-api-client
 }
 ```

-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

 Execute the following `git` command from the shell in your project directory:
@@ -58,17 +121,27 @@ 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');
+/**
+ * load the class directly instead of using the composer autoloader
+ */
+require_once 'path/to/src/Client.php';
 ```

+
 ### Download the Release

-If you prefer not to use composer or git, you can simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), uncompress the zip file, then include the file containing the class in your code like so:
+If you prefer not to use composer or git,
+simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), unpack 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:
@@ -77,10 +150,10 @@ A basic example how to use the class:
 /**
 * load the class using the composer autoloader
 */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';

 /**
- * initialize the Unifi API connection class, log in to the controller and request the alarms collection
+ * initialize the UniFi API connection class, log in to the controller and request the alarms collection
 * (this example assumes you have already assigned the correct values to the variables used)
 */
 $unifi_connection = new UniFi_API\Client($controller_user, $controller_password, $controller_url, $site_id, $controller_version, true);
@@ -88,47 +161,60 @@ $login            = $unifi_connection->login();
 $results          = $unifi_connection->list_alarms(); // returns a PHP array containing alarm objects
 ```

-Please refer to the `examples/` directory for some more detailed examples which you can use as a starting point for your own PHP code.
+Please refer to the `examples/` directory for some more detailed examples which can be used as a starting point for your
+own PHP code.
+

 #### IMPORTANT NOTES:

-1. In the above example, `$site_id` is the short site "name" (usually 8 characters long) that is visible in the URL when managing the site in the UniFi Network Controller. For example with this URL:
+1. In the above example, `$site_id` is the short site "name" (usually 8 characters long) that is visible in the URL when
+   managing the site in the UniFi Network Controller. For example with this URL:

   `https://<controller IP address or FQDN>:8443/manage/site/jl3z2shm/dashboard`

   `jl3z2shm` is the short site "name" and the value to assign to $site_id.

-2. The last optional parameter that is passed to the constructor in the above example (`true`), enables validation of the controller's SSL certificate which is otherwise **disabled** by default. It is highly recommended to enable this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
+2. The 6th optional parameter that is passed to the constructor in the above example (`true`), enables validation of
+   the controller's SSL certificate which is otherwise **disabled** by default. It is **highly recommended** to enable
+   this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is
+   associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
+
+3. Using an administrator account (`$controller_user` in the above example) with **read-only** permissions can limit 
+   visibility on certain collection/object properties. See this
+   [issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129) and this 
+   [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94) for an example where the WPA2 password isn't
+   visible for **read-only** administrator accounts.
+

 ## Functions/methods supported

-The class currently supports the following functions/methods to GET/POST/PUT/DELETE data through the UniFi Controller API. Please refer to the comments in the source code for more details on the functions/methods and their respective parameters.
+The class currently supports the following functions/methods to access the UniFi Controller API. This list is sorted
+alphabetically. Please refer to the comments in the source code for more details on each of the functions/methods,
+their purpose, and their respective parameters.

- login()
- logout()
 - adopt_device()
+- advanced_adopt_device()
 - archive_alarm()
 - assign_existing_admin()
 - authorize_guest()
 - block_sta()
 - cancel_rolling_upgrade()
- cmd_stat()
- count_alarms()
 - check_controller_update()
 - check_firmware_update()
- create_apgroup() (supported with controller versions 6.0.X and higher)
+- cmd_stat()
+- count_alarms()
+- create_apgroup()
 - create_dynamicdns()
 - create_firewallgroup()
 - create_hotspotop()
 - create_network()
 - create_radius_account()
- create_site()
 - create_user()
 - create_usergroup()
 - create_voucher()
 - create_wlan()
 - custom_api_request()
- delete_apgroup() (supported with controller versions 6.0.X and higher)
+- delete_apgroup()
 - delete_device()
 - delete_firewallgroup()
 - delete_network()
@@ -137,26 +223,46 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - delete_usergroup()
 - delete_wlan()
 - disable_ap()
- edit_apgroup() (supported with controller versions 6.0.X and higher)
+- disable_wlan()
+- edit_apgroup()
 - edit_client_fixedip()
+- edit_client_name()
 - edit_firewallgroup()
 - edit_usergroup()
 - extend_guest_validity()
- forget_sta() (supported on controller version 5.9.X and higher)
+- forget_sta()
+- generate_backup()
+- generate_backup_site()
+- get_class_version()
+- get_cookie()
+- get_cookies()
+- get_curl_connection_timeout()
+- get_curl_http_version()
+- get_curl_method()
+- get_curl_request_timeout()
+- get_curl_request_timeout()
+- get_curl_ssl_verify_host()
+- get_curl_ssl_verify_peer()
+- get_debug()
+- get_is_unifi_os()
+- get_last_error_message()
+- get_last_results_raw()
+- get_site()
 - invite_admin()
 - led_override()
 - list_admins()
- list_alarms()
 - list_all_admins()
- list_apgroups() (supported with controller versions 6.0.X and higher)
- list_aps() (deprecated but still available as alias)
+- list_alarms()
+- list_aps()
 - list_backups()
 - list_clients()
 - list_country_codes()
 - list_current_channels()
 - list_dashboard()
+- list_device_name_mappings()
+- list_device_states()
 - list_devices()
- list_dpi_stats()
+- list_devices_basic()
 - list_dynamicdns()
 - list_events()
 - list_extension()
@@ -170,38 +276,46 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - list_portconf()
 - list_portforward_stats()
 - list_portforwarding()
- list_radius_accounts() (supported on controller version 5.5.19 and higher)
+- list_radius_accounts()
 - list_radius_profiles()
- list_rogueaps()
- list_routing()
 - list_self()
 - list_settings()
 - list_sites()
- list_tags() (supported on controller version 5.5.19 and higher)
- list_usergroups()
+- list_tags()
 - list_users()
 - list_wlan_groups()
 - list_wlanconf()
 - locate_ap()
+- login()
+- logout()
 - move_device()
 - power_cycle_switch_port()
 - reboot_cloudkey()
- reconnect_sta()
 - rename_ap()
- restart_ap() (deprecated but still available as alias)
- restart_device()
 - revoke_admin()
 - revoke_voucher()
 - set_ap_radiosettings()
+- set_ap_wlangroup()
+- set_connection_timeout()
+- set_cookies()
+- set_curl_http_version()
+- set_curl_request_timeout()
+- set_curl_ssl_verify_host()
+- set_curl_ssl_verify_peer()
+- set_debug()
 - set_device_settings_base()
 - set_dynamicdns()
- set_element_adoption() (supported on controller version 5.13.X and higher)
+- set_element_adoption()
 - set_guestlogin_settings()
 - set_guestlogin_settings_base()
- set_ips_settings_base() (supported on controller version 5.9.10 and higher)
+- set_ips_settings_base()
+- set_is_unifi_os()
 - set_locate_ap() (deprecated but still available as alias)
 - set_networksettings_base()
 - set_radius_account_base()
+- set_request_method()
+- set_request_timeout()
+- set_site()
 - set_site_connectivity()
 - set_site_country()
 - set_site_guest_access()
@@ -220,27 +334,30 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - 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()
 - start_rolling_upgrade()
- stat_5minutes_aps() (supported on controller version 5.5.X and higher)
- stat_5minutes_gateway() (supported on controller version 5.7.X and higher)
- stat_5minutes_site() (supported on controller version 5.5.X and higher)
- stat_5minutes_user (supported on controller version 5.7.X and higher)
+- stat_5minutes_aps()
+- stat_5minutes_gateway()
+- stat_5minutes_site()
+- stat_5minutes_user()
 - stat_allusers()
 - stat_auths()
 - stat_client()
 - stat_daily_aps()
- stat_daily_gateway() (supported on controller version 5.7.X and higher)
+- stat_daily_gateway()
 - stat_daily_site()
- stat_daily_user() (supported on controller version 5.7.X and higher)
+- stat_daily_user()
+- stat_full_status()
 - stat_hourly_aps()
- stat_hourly_gateway() (supported on controller version 5.7.X and higher)
+- stat_hourly_gateway()
 - stat_hourly_site()
- stat_hourly_user() (supported on controller version 5.7.X and higher)
- stat_ips_events() (supported on controller version 5.9.10 and higher)
+- stat_hourly_user()
+- stat_ips_events()
+- stat_monthly_aps()
+- stat_monthly_gateway()
+- stat_monthly_site()
+- stat_monthly_user()
 - stat_payment()
 - stat_sessions()
 - stat_sites()
@@ -255,49 +372,40 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - upgrade_device()
 - upgrade_device_external()

-Other functions, getters/setters:
-
- get_class_version()
- get_connection_timeout()
- get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
- get_cookies()
- get_debug()
- get_is_unifi_os()
- get_last_error_message()
- get_last_results_raw()
- get_request_type()
- get_site()
- get_ssl_verify_host()
- get_ssl_verify_peer()
- set_connection_timeout()
- set_cookies()
- set_debug()
- set_is_unifi_os()
- set_request_type()
- set_site()
- set_ssl_verify_host()
- set_ssl_verify_peer()
-

 ## Need help or have suggestions?

-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.
+
+
+#### 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.
+

 ## Contribute

-If you would like to contribute code (improvements), please open an issue and include your code there or else create a pull request.
+If you would like to contribute code (improvements), please open an issue and include
+your code there or else create a pull request.
+

 ## Credits

 This class is based on the initial work by the following developers:

- domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
+- domwo: https://community.ui.com/questions/little-php-class-for-unifi-api/933d3fb3-b401-4499-993a-f9af079a4a3a
 - fbagnol: https://github.com/fbagnol/class.unifi.php

 and the API as published by Ubiquiti:

- https://dl.ui.com/unifi/5.12.35/unifi_sh_api
+- https://dl.ui.com/unifi/8.0.26/unifi_sh_api
+

 ## Important Disclaimer

-Many of the functions in this API client class are not officially supported by UBNT and as such, may not be supported in future versions of the UniFi Controller API.
+Many of the functions in this API client class are not officially supported by Ubiquiti
+and as such, may not be supported in future versions of the UniFi Controller API.
--- a/composer.json
+++ b/composer.json
@@ -1,6 +1,6 @@
 {
-    "name":        "art-of-wifi/unifi-api-client",
-    "type":        "library",
+    "name": "art-of-wifi/unifi-api-client",
+    "type": "library",
    "description": "API client class for use with Ubiquiti's UniFi controller",
    "keywords": [
        "ubnt",
@@ -10,17 +10,17 @@
        "api",
        "client"
    ],
-    "homepage":    "https://github.com/Art-of-WiFi/UniFi-API-client",
-    "license":     "MIT",
+    "homepage": "https://github.com/Art-of-WiFi/UniFi-API-client",
+    "license": "MIT",
    "authors": [
        {
-            "name":     "Art of WiFi",
-            "email":    "info@artofowifi.net",
-            "homepage": "http://artofwifi.net"
+            "name": "Art of WiFi",
+            "email": "info@artofowifi.net",
+            "homepage": "https://artofwifi.net"
        }
    ],
    "require": {
-        "php": ">=5.5.0",
+        "php": ">=7.4.0",
        "ext-curl": "*",
        "ext-json": "*"
    },
@@ -29,4 +29,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 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,9 +42,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_block as $mac) {
    // block_result is always true even if mac address does not exist :(
--- 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
 */

 /**
--- 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
@@ -12,13 +12,13 @@
 /**
 * using the composer autoloader
 */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';

 /**
 * include the config file (place your credentials etc. there if not already present)
 * see the config.template.php file for an example
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * the site to use to log in to the controller
@@ -46,7 +46,14 @@ $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, false);
+$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);
--- 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,19 @@
 * PHP API usage example
 *
 * contributed by: Art of WiFi
- * description: example basic PHP script to pull current alarms from the UniFi controller and output in json format
+ * description:    example basic PHP script to pull current alarms from the UniFi controller and output in json format
 */

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

 /**
 * include the config file (place your credentials etc. there if not already present)
 * see the config.template.php file for an example
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * the site to use
@@ -25,7 +25,14 @@ $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);
+$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();
--- 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
@@ -3,19 +3,19 @@
 * PHP API usage example
 *
 * contributed by: @gahujipo
- * description: example to pull connected users and their details from the UniFi controller and output the results
- *              in JSON format
+ * description:    example to pull connected users and their details from the UniFi controller and output the results
+ *                 in JSON format
 */
 /**
 * using the composer autoloader
 */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';

 /**
 * include the config file (place your credentials etc there if not already present)
 * see the config.template.php file for an example
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * the short name of the site which you wish to query
@@ -25,10 +25,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();
-$clients_array    = $unifi_connection->list_clients();
+$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
--- 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
@@ -12,7 +12,7 @@ require 'vendor/autoload.php';
 * include the config file (place your credentials etc. there if not already present)
 * see the config.template.php file for an example
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * the site to use
@@ -49,36 +49,52 @@ $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) {
-    $pdu_details = $unifi_connection->list_devices($pdu_mac);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);

-    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);
-        echo PHP_EOL;
-    } else {
-        echo 'not a PDU device?';
-        echo PHP_EOL;
-    }
-} else {
+$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
@@ -3,19 +3,19 @@
 * PHP API usage example
 *
 * contributed by: Art of WiFi
- * description: example basic PHP script to force a client device to reconnect
+ * description:    example basic PHP script to force a client device to reconnect
 */

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

 /**
 * include the config file (place your credentials etc. there if not already present)
 * see the config.template.php file for an example
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * the MAC address to reconnect
@@ -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 force the device to reconnect
--- 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,12 +11,13 @@
 * see the config.template.php file for an example.
 * (will only be used here to get the URL to the controller)
 */
-require_once('config.php');
+require_once 'config.php';

 /**
 * Check whether the cURL module supports SSL
+ * http://www.php.net/manual/en/function.curl-version.php
 */
-if (!curl_version()['features'] & CURL_VERSION_SSL) {
+if (!(curl_version()['features'] & CURL_VERSION_SSL)) {
    print PHP_EOL . 'SSL is not supported with this cURL installation!' . PHP_EOL;
 }

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

-if (is_resource($ch)) {
+if (is_resource($ch) || is_object($ch)) {
    /**
-     * If we have a resource, we proceed and set the required cURL options
-     */
-    curl_setopt($ch, CURLOPT_URL, $controllerurl);
-    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
-    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
-    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
-
-    /**
-     * This cURL option can have a value of 0-6
+     * If we have a resource or object (for PHP > 8.0), we proceed and set the required cURL options
+     *
+     * NOTES:
+     * The cURL option CURLOPT_SSLVERSION can have a value of 0-6
     * see this URL for more details:
     * http://php.net/manual/en/function.curl-setopt.php
     * 0 is the default value and is used by the PHP API client class
     */
-    curl_setopt($ch, CURLOPT_SSLVERSION, 0);
+    $curl_options = [
+        CURLOPT_PROTOCOLS      => CURLPROTO_HTTPS,
+        CURLOPT_URL            => $controllerurl,
+        CURLOPT_CUSTOMREQUEST  => 'GET',
+        CURLOPT_SSL_VERIFYPEER => false,
+        CURLOPT_SSL_VERIFYHOST => false,
+        CURLOPT_VERBOSE        => true,
+        CURLOPT_SSLVERSION     => 0,
+        CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
+    ];

-    /**
-     * Be more verbose
-     */
-    curl_setopt($ch, CURLOPT_VERBOSE, true);
+    curl_setopt_array($ch, $curl_options);

    /**
     * $results contains the output as returned by the cURL request,
@@ -64,9 +66,13 @@ if (is_resource($ch)) {
        print PHP_EOL . 'cURL error: ' . curl_error($ch) . PHP_EOL;
    }

-    print PHP_EOL . '$results:' . PHP_EOL;
-    print_r($results);
-    print PHP_EOL;
+    print PHP_EOL . 'test result:' . PHP_EOL;
+    if ($results) {
+        print 'Controller connection success' . PHP_EOL;
+        die;
+    }
+
+    print 'Controller connection failed' . PHP_EOL;
 } else {
    print PHP_EOL . 'ERROR: cURL could not be initialized!' . PHP_EOL;
 }
--- 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
@@ -8,18 +8,21 @@
 * 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');
+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
@@ -39,20 +42,21 @@ $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){
+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)){
+    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){
+    foreach ($ports as $port) {
        $add_conf[] = [
            'port_idx' => $port,
            'poe_mode' => $poe_mode
@@ -62,12 +66,19 @@ function update_ports($running_config, $ports, $poe_mode){
    return array_merge($running_config, $add_conf);
 }

-$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;
-$current_conf     = $data[0]->port_overrides;
+$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"
@@ -91,4 +102,4 @@ if (!$update_device) {
    echo json_encode($error, JSON_PRETTY_PRINT);
 }

-echo json_encode($update_device, JSON_PRETTY_PRINT);
+echo json_encode($update_device, JSON_PRETTY_PRINT);
--- a/src/Client.php
+++ b/src/Client.php
Author	SHA1	Message	Date
malle-pietje	9726378e3c	bumped version to 1.1.101	2024-11-15 10:33:11 +01:00
malle-pietje	494375f8b5	- added a private property $cookies_created_at to store the timestamp when the cookies were created/updated. - added a getter method get_cookies_created_at() to return the timestamp when the cookies were created/updated. This information can be useful to determine how old the cookies are. - minor comments clean up	2024-11-15 10:31:10 +01:00
malle-pietje	3dbc24daca	further tweaks	2024-11-04 13:43:57 +01:00
malle-pietje	93d1d8ec3f	tweaked hyperlink	2024-11-04 13:38:18 +01:00
malle-pietje	b8620f7672	changed link to hyperlink	2024-11-04 13:37:01 +01:00
malle-pietje	1e2e709d4a	inserted link to installation instructions	2024-11-04 13:34:41 +01:00
malle-pietje	472d2eaa68	restructured and updated supported versions info	2024-11-04 13:32:34 +01:00
malle-pietje	1522992e49	bumped version to 1.1.100 fixed incorrect return type for `create_voucher()`, reported by @pa-	2024-10-29 12:14:00 +01:00
malle-pietje	70f6a374e2	- added get_system_log() method to get data from the system logs, returns pages results - minor formatting changes	2024-10-23 13:30:34 +02:00
malle-pietje	ff9e6f0225	merged #244 for a small change to the `start_rolling_upgrade()` method, contributed by @Jacobtims minor additional change to allow changes to the payload of the `start_rolling_upgrade()` method	2024-10-17 16:41:45 +02:00
Jacob Timmerman	00a637dbc4	Add "uxg" to start_rolling_upgrade payload (#244 ) * Fix payload start_rolling_upgrade method * Add "uxg" to start_rolling_upgrade payload	2024-10-17 16:31:25 +02:00
malle-pietje	6498b0255b	Merge branch 'master' of github.com:Art-of-WiFi/UniFi-API-client merging #243	2024-10-17 14:56:47 +02:00
malle-pietje	05e791bcf0	minor changes	2024-10-17 14:56:36 +02:00
Jacob Timmerman	192a1262c3	Fix payload start_rolling_upgrade method (#243 )	2024-10-17 14:55:54 +02:00
malle-pietje	30056f50fc	- bumped version to 1.1.96 - removed @version tag in docblock as it contained redundant information - merged #241 which adds a method to download a generated backup, (contributed by @Jacobtims)	2024-10-14 14:34:48 +02:00
Jacob Timmerman	d040c512a7	Add method to download generated backup (#241 ) Merged PR #241	2024-10-14 14:31:44 +02:00
malle-pietje	b633fa54c7	added ability top determine attributes to fetch with AP and site stats general minor clean up bumped version to 1.1.95	2024-10-07 12:54:19 +02:00
malle-pietje	5327d0c534	minor changes	2024-10-07 10:39:48 +02:00
malle-pietje	f1fc80f34f	API client class v1.1.94 - minor fix based on Scrutinizer feedback - re-added `update_admin()` method to the class; for some reason, the merge of #228 was not successful	2024-08-12 10:24:03 +02:00
malle-pietje	f82d1a6b64	removed exit following suggestion from Scrutinizer	2024-08-08 17:56:33 +02:00
malle-pietje	6f6e80e862	cleanup some comments/doc blocks	2024-08-08 17:45:03 +02:00
malle-pietje	4fefc11761	simplified the contructor by assigning default values to properties within the argument list	2024-08-08 17:37:33 +02:00
malle-pietje	0db5effe6f	minor fix to return type hinting based on feedback from Scrutinizer	2024-08-07 16:26:54 +02:00
malle-pietje	fd69d844a6	API client class v1.1.93 - added the migrate_device() method to migrate one or more devices from one controller to another - added the cancel_migrate_device() method to cancel the migration for one or more devices - added the upgrade_all_devices() method to upgrade all devices of a selected type to the latest firmware version - changed the force_provision() method to allow for multiple MAC addresses to be passed as a parameter - minor changes to a number of doc-blocks - general changes for improved consistency and readability	2024-08-07 16:03:09 +02:00
malle-pietje	12b85ce9db	moved 2 properties to constants which seems more appropriate reformatted single-line comments	2024-08-06 12:30:47 +02:00
malle-pietje	54ec631d4b	added a new example demonstrating the change of site settings	2024-08-04 15:35:26 +02:00
Jacob Timmerman	fdea77fce0	Add days paramater to generate_backup method (#232 )	2024-08-02 17:12:29 +02:00
malle-pietje	108ddd3995	further cleanup of notes in doc blocks	2024-07-31 11:16:02 +02:00
malle-pietje	63600f4da1	- added `delete_admin()`` method, contributed by @Jacobtims - reformatting of notes in the doc blocks	2024-07-31 10:55:21 +02:00
malle-pietje	20aa3e1377	merging PR #228	2024-07-31 10:25:02 +02:00
malle-pietje	d36a088101	API client class v1.1.90 - remove existing x-csrf-token headers before adding a new one, UniFi OS does not like multiple x-csrf-tokens in the same request	2024-02-27 18:48:41 +01:00
malle-pietje	007117cbfc	API client class v1.1.89 - added `create_tag()`, `set_tagged_devices()`, `get_tag()`, and `delete_tag()` methods to manage tags, contributed by @brenard, #205	2024-02-11 17:24:31 +01:00
malle-pietje	7e60ce3e87	API client class v1.1.88 - added list_fingerprint_devices() method to list fingerprints for clients devices, contributed by @dream-rhythm, #213 - minor code cleanup	2024-02-11 14:46:30 +01:00
malle-pietje	83d4f121ed	API client class v1.1.87 - further code cleanup and refactoring to pass more phpstan tests	2024-02-11 12:33:37 +01:00
malle-pietje	bd39c325d2	API client class v1.1.86 - fixes issue with curl_init() returning CurlHandle class objects instead of curl handlers with PHP 8 and higher	2024-02-10 13:26:47 +01:00
malle-pietje	4b175ddf9b	API client class v1.1.85 - removed unnecessary type casting in several methods - fixed return type hinting in several methods where return type would be an array\|bool instead of just array - relaxed parameter type hinting in the constructor to allow for null values for several parameters ($site and $version) that have sensible defaults, reported by @pbksol - using phpstan, the class now passes level 5 checks	2024-02-10 12:13:00 +01:00
malle-pietje	48482d661a	API client class v1.1.84 - PHP 7.4 is now the minimum required version - updated the code for 7.4. specific features such as parameter type hinting, return types, etc. - added the ability to the constructor to change the key that is used to store the unificookie in the session, ($_SESSION['unificookie'] is used by default), this is useful when running multiple applications on the same server	2024-02-09 18:11:43 +01:00
malle-pietje	563739345c	applied tweaks to the README file	2024-01-05 11:08:06 +01:00
malle-pietje	fdc5f06765	applied tweaks to the README file	2024-01-05 11:04:39 +01:00
malle-pietje	35b2fb37f3	applied tweaks to the README file	2024-01-05 11:02:38 +01:00
malle-pietje	8c1b33ed09	added note to README regarding Issues that are not related to the PHP API client	2024-01-05 10:47:11 +01:00
malle-pietje	b6a22abc01	further changes and updates to the README file	2023-12-21 11:09:36 +01:00
malle-pietje	3aa658eab0	minor changes to the instructions in the README file	2023-12-21 10:41:38 +01:00
malle-pietje	a4258f1963	updated the instructions in the README file	2023-12-21 10:36:10 +01:00
malle-pietje	cf5ba015b0	removed statement about cookies no longer being supported...	2023-12-18 15:15:19 +01:00
malle-pietje	2970f79290	API client class v1.1.83 - added a 'accept: application/json' header to the login requests - re-added support for cookies when working with a UniFi OS-based controller	2023-12-18 15:08:24 +01:00
malle-pietje	7fe7a40873	further updates to README	2023-12-18 12:35:58 +01:00
malle-pietje	df1f70547c	updated README added announcement of minimum PHP version moving to 7.4	2023-12-18 12:32:03 +01:00
malle-pietje	e89daaf1a3	API client class v1.1.82 - allow filtering by multiple MAC addresses in list_devices(), contributed by @sgrodzicki, #189	2023-12-18 11:42:56 +01:00
malle-pietje	d66c3ddd75	API client class v1.1.81 - hotfix to address cookie issues in UniFi OS 3.2.7, reported by @tflatebo - fixed minor typos - minor code reformatting of the examples - starting with this release, cookies are no longer supported when connecting to a UniFi OS-based controller - added set_vlan_to_port.php example, contributed by @SamuelSchnelly, #203 - allow additional parameters in `create_wlan()`'s payload, contributed by @sgrodzicki, #191	2023-12-18 11:11:27 +01:00
malle-pietje	9e092f8b85	Merge branch 'master' of github.com:Art-of-WiFi/UniFi-API-client merge for device-basic	2023-03-28 12:22:42 +02:00
Sebastian Grodzicki	e4dc2e273c	Add `stat/device-basic` endpoint (#188 ) Merge to include device-basic endpoint	2023-03-28 12:21:43 +02:00
malle-pietje	67d318ca91	- bumped version to class v1.1.80 - added generate_backup_site() method, contributed by @labo-jad	2023-03-28 12:19:29 +02:00
malle-pietje	cbe89d913c	API client class v1.1.79 - updated README to reflect support for 7.X - `get_last_error_message()` now always returns a string which is empty if no message is available - applied PR #151 in slightly different way for consistency with other similar code sections, contributed by @banakito - changed default argument values in several methods/functions from null to an empty string	2022-03-28 11:57:57 +02:00
malle-pietje	4fe1780e1d	API client class v1.1.78 - fixed `create_radius_account()` method to make Tunnel Type and Medium optional parameters, reported by @CodeByJacob	2022-03-11 13:24:31 +01:00
malle-pietje	61bd2eda0d	API client class v1.1.77 - removed unnecessary CURLOPT_HEADER from the login() method - added several more possible attributes for client stats - cast VLAN id to string in create_radius_account()	2022-03-11 12:08:40 +01:00
malle-pietje	746fb0933c	API client class v1.1.76 - minor changes based on feedback by Scrutinizer - removed use of CURLOPT_NOBODY in login() method - switched to using cURL's default HTTP version	2021-12-29 15:01:12 +01:00
malle-pietje	aefbbdc5e1	API client class v1.1.75 - updated docblocks to be less USG-specific - removed content-length header from the logout method, reported by @Olivier6767 - added notes to reflect successful tests with UDR running latest Pre-Release version of the UniFi controller (version 6.5.52) - added checks in specific cases when using trim() to prevent PHP 8 from throwing an error when the variable is null, submitted by @djchen	2021-12-18 12:00:56 +01:00
malle-pietje	fbfd6a8246	API client class v1.1.74 - minor refactoring - fixed minor typos - updated README to reflect limited visibility when using read-only administrator accounts, reported by @KetchupBomb and @NickDunas	2021-11-08 10:30:22 +01:00
malle-pietje	310abc43b5	API client class v1.1.73 - minor spacing changes based on Scrutinizer feedback - updated create_wlan() method/function to work with the new way of assigning a VLAN which now requires passing the _id value of the VLAN, reported by @BeneReuthlinger - merged #132, README update, contributed by @pauloboc - merged #133, adds edit_client_name() method, contributed by @pauloboc	2021-10-23 11:14:25 +02:00
malle-pietje	01eafb516a	Merge branch 'master' of github.com:Art-of-WiFi/UniFi-API-client merge #133	2021-10-23 10:34:46 +02:00
Paulo Ferreira	c3c44d61e4	Add method rename client (#133 ) * Update Client.php Add method rename client * Update README.md	2021-10-23 10:34:39 +02:00
malle-pietje	2e7b556d8e	Merge branch 'master' of github.com:Art-of-WiFi/UniFi-API-client merged #132	2021-10-23 10:32:41 +02:00
malle-pietje	e7e1540df4	- minor spacing changes based on Scrutinizer feedback - updated create_wlan() method/function to work with the new way of assigning a VLAN which now requires passing the _id value of the VLAN, reported by @BeneReuthlinger	2021-10-23 10:32:20 +02:00
Paulo Ferreira	adb98a3c8e	Update README.md (#132 ) Fix parameters separations	2021-10-22 17:35:05 +02:00
malle-pietje	9cca43557c	API client class v1.1.72 - added property $request_timeout to control the cURL option CURLOPT_TIMEOUT, contributed by @mreho - added setter and getter for $request_timeout, contributed by @mreho - changed default value for the cURL option CURLOPT_HTTP_VERSION to CURL_HTTP_VERSION_1_1: - as of cURL version 7.62.0 the default value is CURL_HTTP_VERSION_2TLS which may cause issues - https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html - added property for $curl_http_version to hold the value for CURLOPT_HTTP_VERSION - added setter and getter for $curl_http_version - switched to using a constant to hold the class version - updated the README file	2021-10-19 10:39:17 +02:00
malle-pietje	13b6699889	API client class v1.1.71 - modified `create_radius_account()` method to make Tunnel Type and Medium optional parameters, contributed by @mreho - added `advanced_adopt_device()` method for more advanced adoption capabilities, contributed by @Sarrus - refactored several code sections - updated connection test script	2021-09-29 10:41:39 +02:00
malle-pietje	665fed93e2	shortened several property names	2021-03-22 11:58:20 +01:00
malle-pietje	36c0fecaff	minor improvements	2021-03-22 11:52:44 +01:00
malle-pietje	474578a9d5	removed non-compliant header suffix	2021-03-21 16:08:55 +01:00
malle-pietje	5281db56de	API client class v1.1.69 - added list_device_states() function/method, as suggested by @hoerter - implemented fix to prevent cURL from sending an `Expect: 100-continue` header with each POST request - implemented a callback function with the CURLOPT_HEADERFUNCTION option to process the response headers after each request and extract the Cookie contents - general cleanup	2021-03-21 16:03:05 +01:00
malle-pietje	021d01ba86	API client class v1.1.68 - fixed a bug that was introduced with 1.1.67 and would only occur in certain corner cases	2021-01-24 18:09:38 +01:00
malle-pietje	caf838abb9	API client class v1.1.67 - fixed a bug where the request headers for subsequent function calls within the same Client instance would not always be cleared	2021-01-24 17:58:23 +01:00
malle-pietje	aa778c9b7b	API client class v1.1.66 - simplified code based on Scrutinizer reports	2021-01-24 14:21:26 +01:00
malle-pietje	0e9ee66cef	updated README to include new functions/methods	2021-01-23 11:44:12 +01:00
malle-pietje	721ba7d084	API client class v1.1.65 - applied minor improvements based on Scrutinizer reports - applied minor changes to `authorize_guest()` to further improve handling of 0/null/empty values passed - restricted protocols to be used by cURL to only allow http and https for improved security - added methods/functions `list_device_name_mappings()` and `stat_full_status()`	2021-01-23 11:41:52 +01:00
malle-pietje	bf3446bba0	API client class v1.1.64 - added information to several docblocks - changed handling of request headers, added private property for this - applied changes for improved use of require_once in the README and examples - added `list_sites()` example - potential breaking changes: renamed `get_request_type()` and `set_request_type()` functions/methods to `get_request_method()` and `set_request_method()` respectively	2021-01-21 10:59:27 +01:00
malle-pietje	a4998de3a9	API client class v1.1.63 - changed references to UbiOS back to UniFi OS - removed capitalization from all header strings (per RFC, header fields are case-insensitive: https://tools.ietf.org/html/rfc7230#section-3.2) - removed charset parameter from headers (not required per RFC) - added x-csrf-token header to all requests except GET when talking to UniFi OS-based controllers, thanks go to @paciks for raising #86	2021-01-06 17:03:21 +01:00
malle-pietje	c82481a28a	API client class v1.1.62 - added several monthly stats methods: `stat_monthly_gateway()`, `stat_monthly_site()`, `stat_monthly_aps()`, `stat_monthly_user()`, thanks go to @Roel Janssens for spotting these MongoDB collections - test for `object` or `resource` in `get_curl_resource()`, closes PR #82 submitted by @banakito - applied change to comments in `example/modify_smartpower_pdu_outlet.php` based on a suggestion by @thesohoguy - removed unnecessary variable from `list_apgroups()`, thanks go to Stephen Davies for reporting - added an optional parameter $ap_group_ids to the `create_wlan()` function/method for UniFi controller versions 6.0.X and higher, thanks go to Stephen Davies for contributing	2020-12-10 14:52:39 +01:00
malle-pietje	2c743563f8	API client class v1.1.61 - minor improvements of comments contents - fixed naming error in comments for list_devices() - updated supported controller versions in main README - change variable names used from MBytes to megabytes for improved consistency	2020-11-26 13:19:53 +01:00