UniFi API browser 2.0.12

- updated custom menu example in README
- added support for firewall rules, based on PR #81 contributed by @chrishas35

Author: malle-pietje

README.md

@@ -147,35 +147,31 @@ $collections = array_merge($collections, [
         'label' => 'Custom Menu', // length of this string is limited due to dropdown menu width
         'options' => [
             [
-                'type' => 'collection', // either collection or divider
+                'type' => 'collection', // either 'collection' or 'divider'
                 'label' => 'hourly site stats past 24 hours', // string that is displayed in the dropdown menu
-                'method' => 'stat_hourly_site', // the method/function in the API client class that is called
+                'method' => 'stat_hourly_site', // name of the method/function in the API client class that is called
                 'params' => [(time() - (24 * 60 *60)) * 1000, time() * 1000], // an array containing the parameters that are passed to the method/function
-                'key' => 'custom_0' // unique key for this menu option, may be required for future versions
             ],
             [
                 'type' => 'collection',
                 'label' => 'daily site stats past 31 days',
                 'method' => 'stat_daily_site',
                 'params' => [(time() - (31 * 24 * 60 *60)) * 1000, time() * 1000],
-                'key' => 'custom_1'
             ],
             [
                 'type' => 'divider', // dividers have no other properties
             ],
             [
                 'type' => 'collection',
                 'label' => 'enable the site LEDs',
-                'method' => 'site_leds', // don't go wild when adding such calls, this example is simply to show the flexibility
-                'params' => [true],
-                'key' => 'custom_2'
+                'method' => 'site_leds', // don't go too wild when adding such calls, this example is simply to show the flexibility
+                'params' => [true]
             ],
             [
                 'type' => 'collection',
                 'label' => 'disable the site LEDs',
-                'method' => 'site_leds', // don't go wild when adding such calls, this example is simply to show the flexibility
-                'params' => [false],
-                'key' => 'custom_3'
+                'method' => 'site_leds', // don't go too wild when adding such calls, this example is simply to show the flexibility
+                'params' => [false]
             ],
         ],
     ],

collections.php

@@ -13,7 +13,6 @@
  *
  * NOTE:
  * - do not modify this file, instead add a custom sub menu to the config.php file
- * - take care to use correct values for the "key" properties (reserved for later use)
  * - a valid value for params looks like this:
  *     [true, true, 'no'] (note the quotes surrounding strings)
  */
@@ -92,8 +91,7 @@
                 'type'   => 'collection', // or divider
                 'label'  => 'list network configuration',
                 'method' => 'list_networkconf',
-                'params' => [],
-                'key' => 'configuration_9'
+                'params' => []
             ],
             [
                 'type'   => 'collection', // or divider
@@ -107,6 +105,12 @@
                 'method' => 'list_portforwarding',
                 'params' => []
             ],
+            [
+                'type'   => 'collection', // or divider
+                'label'  => 'list firewall rules',
+                'method' => 'list_firewallrules',
+                'params' => []
+            ],
             [
                 'type'   => 'collection', // or divider
                 'label'  => 'list firewall groups',
@@ -340,8 +344,7 @@
                 'type'   => 'collection', // or divider
                 'label'  => '5 minutes site dashboard metrics',
                 'method' => 'list_dashboard',
-                'params' => [true],
-                'key' => 'stats_10'
+                'params' => [true]
             ],
             [
                 'type'   => 'collection', // or divider

common.php

@@ -7,7 +7,7 @@
  * with this package in the file LICENSE.md
  *
  */
-define('TOOL_VERSION', '2.0.11');
+define('TOOL_VERSION', '2.0.12');
 
 /**
  * gather some basic information for the About modal