API Browser version 1.0.16, API client class version 1.1.5

- API client class: changed class name to UnifiApi - API client class: general code cleanup and improvements - API client class: enhanced method/function list_events() - API client class: added method/function list_devices() to replace list_aps() which is still available as alias - API browser tool: general code cleanup - examples: general code cleanup, added config file template
Art-of-WiFi · May 29, 2017 · 86d9c1d · 86d9c1d
1 parent a6bbb29
commit 86d9c1d
Show file tree

Hide file tree

Showing 13 changed files with 202 additions and 151 deletions.
diff --git a/examples/ap_scanning_state.php b/examples/ap_scanning_state.php
@@ -12,7 +12,7 @@
  * NOTE:
  * this example will only work out of the box with a single controller config file!
  */
-require_once('config-local.php');
+require_once('../config.php');
 
 /**
  * site id and MAC address of AP to query
@@ -25,7 +25,7 @@
  * spectrum_scan_state()
  */
 require_once('phpapi/class.unifi.php');
-$unifidata    = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata    = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $loginresults = $unifidata->login();
 $data         = $unifidata->spectrum_scan_state($ap_mac);
 

diff --git a/examples/auth_guest_basic.php b/examples/auth_guest_basic.php
@@ -33,7 +33,7 @@
  * load the Unifi API connection class and log in to the controller
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 

diff --git a/examples/auth_guest_with_note.php b/examples/auth_guest_with_note.php
@@ -38,7 +38,7 @@
  * load the Unifi API connection class and log in to the controller
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 

diff --git a/examples/config.template.php b/examples/config.template.php
@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright (c) 2016, Slooffmaster
+ *
+ * This file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.md
+ *
+ */
+
+/**
+ * Single controller configuration
+ * ===============================
+ * Update this section with your UniFi controller details and credentials
+ */
+$controlleruser     = ''; // the user name for access to the UniFi Controller
+$controllerpassword = ''; // the password for access to the UniFi Controller
+$controllerurl      = ''; // full url to the UniFi Controller, eg. 'https://22.22.11.11:8443'
+$controllerversion  = ''; // the version of the Controller software, eg. '4.6.6' (must be at least 4.0.0)
+
+/**
+ * set to true (without quotes) to enable debug output to the browser and the PHP error log
+ */
+$debug = false;
diff --git a/examples/create_voucher.php b/examples/create_voucher.php
@@ -33,7 +33,7 @@
  * load the Unifi API connection class and log in to the controller
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 

diff --git a/examples/extend_guest_auth.php b/examples/extend_guest_auth.php
@@ -6,14 +6,14 @@
  * description: example of how to extend validity of guest authorizations
  */
 
-require_once ("../phpapi/class.unifi.php");
-require_once ("../config.php");
+require_once("../phpapi/class.unifi.php");
+require_once("../config.php");
 
 // must be adapted to your site!
-$site_id = "default";
+$site_id   = "default";
 $site_name = "*enter your site name*";
 
-$unifidata      = new unifiapi ($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi ($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 

diff --git a/examples/list_alarms.php b/examples/list_alarms.php
@@ -23,7 +23,7 @@
  * load the Unifi API connection class and log in to the controller and do our thing
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 $data           = $unifidata->list_alarms();

diff --git a/examples/list_ap_connected_users.php b/examples/list_ap_connected_users.php
@@ -24,7 +24,7 @@
  * load the Unifi API connection class and log in to the controller and pull the requested data
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 $aps_array      = $unifidata->list_aps();

diff --git a/examples/list_site_health.php b/examples/list_site_health.php
@@ -25,7 +25,7 @@
  */
 require_once('../phpapi/class.unifi.php');
 
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 $result         = $unifidata->list_health();

diff --git a/examples/list_social_auth_details.php b/examples/list_social_auth_details.php
@@ -24,7 +24,7 @@
  * load the Unifi API connection class and log in to the controller and do our thing
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode = $unifidata->set_debug($debug);
 $loginresults   = $unifidata->login();
 $data           = $unifidata->stat_payment();

diff --git a/examples/toggle_led.php b/examples/toggle_led.php
@@ -13,7 +13,7 @@
  * NOTE:
  * this example will only work out of the box with a single controller config file!
  */
-require_once('../config-local.php');
+require_once('../config.php');
 
 /**
  * site id to use
@@ -29,9 +29,9 @@
  * load the Unifi API connection class and log in to the controller to do our thing
  */
 require_once('../phpapi/class.unifi.php');
-$unifidata      = new unifiapi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion); // initialize the class instance
+$unifidata      = new UnifiApi($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion); // initialize the class instance
 $set_debug_mode = $unifidata->set_debug($debug);
-$loginresults   = $unifidata->login(); // log into the controller
+$loginresults   = $unifidata->login();
 
 /**
  * using the "old" deprecated methods/functions

diff --git a/index.php b/index.php
@@ -10,7 +10,7 @@
  *   the currently supported data collections/API endpoints in the README.md file
  * - this tool currently supports versions 4.x and 5.x of the UniFi Controller software
  *
- * VERSION: 1.0.15
+ * VERSION: 1.0.16
  *
  * ------------------------------------------------------------------------------------
  *
@@ -20,7 +20,7 @@
  * with this package in the file LICENSE.md
  *
  */
-define('API_BROWSER_VERSION', '1.0.15');
+define('API_BROWSER_VERSION', '1.0.16');
 
 /**
  * in order to use the PHP $_SESSION array for temporary storage of variables, session_start() is required
@@ -32,7 +32,7 @@
  * - this function can be useful when login errors occur, mostly after upgrades or incorrect credential changes
  */
 if (isset($_GET['reset_session']) && $_GET['reset_session'] == true) {
-    $_SESSION = array();
+    $_SESSION = [];
     session_unset();
     session_destroy();
     session_start();
@@ -137,13 +137,13 @@
              * if the user has configured a single controller, we push it's details
              * to the $_SESSION and $controller arrays
              */
-            $_SESSION['controller'] = array(
+            $_SESSION['controller'] = [
                 'user'     => $controlleruser,
                 'password' => $controllerpassword,
                 'url'      => $controllerurl,
                 'name'     => 'Controller',
                 'version'  => $controllerversion
-            );
+            ];
             $controller = $_SESSION['controller'];
         }
     }
@@ -224,7 +224,7 @@
      * create a new instance of the API client class and log in to the UniFi controller
      * - if an error occurs during the login process, an alert is displayed on the page
      */
-    $unifidata      = new unifiapi($controller['user'], $controller['password'], $controller['url'], $site_id, $controller['version']);
+    $unifidata      = new UnifiApi($controller['user'], $controller['password'], $controller['url'], $site_id, $controller['version']);
     $set_debug_mode = $unifidata->set_debug(trim($debug));
     $loginresults   = $unifidata->login();
 
@@ -317,7 +317,7 @@
             break;
         case 'list_devices':
             $selection = 'list devices';
-            $data      = $unifidata->list_aps();
+            $data      = $unifidata->list_devices();
             break;
         case 'list_wlan_groups':
             $selection = 'list wlan groups';
@@ -497,9 +497,9 @@ function print_output($output_format, $data)
 /**
  * function to sort the sites collection alpabetically by description
  */
-function sites_sort($a, $b)
+function sites_sort($site_a, $site_b)
 {
-    return strcmp($a->desc, $b->desc);
+    return strcmp($site_a->desc, $site_b->desc);
 }
 ?>
 <!DOCTYPE html>
@@ -928,9 +928,9 @@ function sites_sort($a, $b)
     var os_version          = '<?php echo (php_uname('s') . ' ' . php_uname('r')) ?>';
     var api_browser_version = '<?php echo API_BROWSER_VERSION ?>';
     var api_class_version   = '<?php echo API_CLASS_VERSION ?>';
-    var controller_user     = '<?php if (isset($_SESSION['controller'])) { echo $controller['user']; } ?>';
-    var controller_url      = '<?php if (isset($_SESSION['controller'])) { echo $controller['url']; } ?>';
-    var controller_version  = '<?php if (isset($_SESSION['controller'])) { echo $detected_controller_version; } ?>';
+    var controller_user     = '<?php if (isset($_SESSION['controller'])) echo $controller['user'] ?>';
+    var controller_url      = '<?php if (isset($_SESSION['controller'])) echo $controller['url'] ?>';
+    var controller_version  = '<?php if (isset($_SESSION['controller'])) echo $detected_controller_version ?>';
 
     /**
      * update dynamic elements in the DOM using some of the above variables