Better configuration & Tracy 2.5 update

+ brand change from the KTStudio only to the author

Author: hlavacm

.gitignore

@@ -1,3 +1,4 @@
+.idea/
 nbproject/
 vendor/
 composer.phar

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015, KTStudio
+Copyright (c) 2015,2018 Martin Hlaváč
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -4,17 +4,34 @@
 WP Tracy is port to [WordPress](https://wordpress.org) for test environment.
 When it's activated, it automatically shows Tracy bar and displays within global WP constants and their values.
 
-## Installation
+## Installation & Configuration
 
-1. Use command on your path: composer require ktstudio/wp-tracy
+1. Use command on your path: `composer require hlavacm/wp-tracy`
 2. Profit!
-3. You can optionally define PHP (boolean) constant WP_TRACY_CHECK_USER_LOGGED_IN to check only logged users...
-4. You can optionally define PHP constant WP_TRACY_ENABLE_MODE to set Tracy\Debugger::enable($mode)...
-5. You can optionally use wp_tracy_panels_filter to modify default panels array (full class names)
+3. You can optionally define custom PHP constants in the code, but they must be defined in the action `init` with priority 1.
+3.1 WP_TRACY_ADMIN_DISABLED - `true`
+3.2 WP_TRACY_CHECK_IS_USER_LOGGED_IN - `on`/`off`
+3.3 WP_TRACY_ONLY_FOR_USER_ID - `some (existing) user ID (as a number)`
+3.4 WP_TRACY_ENABLE_MODE - `detect`/`development`/`production`
+3.5 WP_TRACY_PANELS_FILTERING_ALLOWED - `on`/`off`
+4. You can optionally define custom options `wp-tracy-user-settings` as serialized array of keys and values:
+4.1 `check-is-user-logged-in` => `on`/`off`
+4.2 `only-for-user-id` => some (existing) user ID (as number)
+4.3 `debugger-mode` => `detect`/`development`/`production`
+4.4 `panels-filtering-allowed` => `on`/`off`
+5. You can optionally use `wp_tracy_panels_filter` to modify default panels array (full class names)
+6. The following panels are visible by default (if they are available):
+6.1 `WpTracy\\WpPanel`
+6.2 `WpTracy\\WpUserPanel`
+6.3 `WpTracy\\WpPostPanel`
+6.4 `WpTracy\\WpQueryPanel`
+6.5 `WpTracy\\WpQueriedObjectPanel`
+6.6 `WpTracy\\WpDbPanel`
+6.8 `WpTracy\\WpRewritePanel`
 
-![WP Tracy](https://ktstudio.github.io/images/wp-tracy.png "Tracy bar auto-display after plugin activation")
-![WP Tracy exception](https://ktstudio.github.io/images/wp-tracy-exception.png "Tracy exception dialog when is occured")
+![WP Tracy](https://hlavacm.github.io/images/wp-tracy.png "Tracy bar auto-display after plugin activation")
+![WP Tracy exception](https://hlavacm.github.io/images/wp-tracy-exception.png "Tracy exception dialog when is occured")
 
 ---
 
-Copyright © KTStudio.cz 2015
+Copyright © [Martin Hlaváč](https://www.hlavacm.net) 2015-2018

composer.json

@@ -1,20 +1,20 @@
 {
-    "name": "ktstudio/wp-tracy",
+    "name": "hlavacm/wp-tracy",
     "description": "(Nette) Tracy connector for WordPress",
     "keywords": ["tracy", "debugger", "wordpress"],
-    "homepage": "https://github.com/ktstudio/wp-tracy",
+    "homepage": "https://github.com/hlavacm/wp-tracy",
     "license": "BSD-3-Clause",
     "authors": [
         {
             "name": "Martin Hlaváč",
-            "email": "[email protected]",
-            "homepage": "http://www.ktstudio.cz/",
+            "email": "[email protected]",
+            "homepage": "https://www.hlavacm.net/",
             "role": "Developer"
         }
     ],
     "require": {
         "php": ">=5.4.4",
-        "tracy/tracy": "~2.4"
+        "tracy/tracy": "~2.5"
     },
     "autoload": {
         "classmap": ["src/panels"],

src/index.php

@@ -1,31 +1,79 @@
 <?php
 
-add_action("init", "wp_tracy_init_action", 1);
+add_action("init", "wp_tracy_init_action", 2);
 
-function wp_tracy_init_action() {
+function wp_tracy_init_action()
+{
     if (defined("DOING_AJAX") && DOING_AJAX) {
         return; // for IE compatibility WordPress media upload
     }
 
-    if (defined("WP_TRACY_CHECK_USER_LOGGED_IN") && WP_TRACY_CHECK_USER_LOGGED_IN && is_user_logged_in()) {
-        return; // cancel for anonymous users
-    }
-
-    Tracy\Debugger::enable(defined("WP_TRACY_ENABLE_MODE") ? WP_TRACY_ENABLE_MODE : null); // hooray, enabling debugging using Tracy
-    // panels in the correct order
-    $defaultPanels = array(
+    $defaultPanelsClasses = [
         "WpTracy\\WpPanel",
         "WpTracy\\WpUserPanel",
         "WpTracy\\WpPostPanel",
         "WpTracy\\WpQueryPanel",
         "WpTracy\\WpQueriedObjectPanel",
         "WpTracy\\WpDbPanel",
         "WpTracy\\WpRewritePanel",
-    );
-    $panels = apply_filters("wp_tracy_panels_filter", $defaultPanels);
+    ]; // in the correct order
+
+    $defaultSettings = [
+        "check-is-user-logged-in" => defined("WP_TRACY_CHECK_IS_USER_LOGGED_IN") ? WP_TRACY_CHECK_IS_USER_LOGGED_IN : "off",
+        "only-for-user-id" => defined("WP_TRACY_ONLY_FOR_USER_ID") ? WP_TRACY_ONLY_FOR_USER_ID : null,
+        "debugger-mode" => defined("WP_TRACY_ENABLE_MODE") ? WP_TRACY_ENABLE_MODE : "detect",
+        "panels-classes" => $defaultPanelsClasses,
+        "panels-filtering-allowed" => defined("WP_TRACY_PANELS_FILTERING_ALLOWED") ? WP_TRACY_PANELS_FILTERING_ALLOWED : "on",
+    ];
+
+    $userSettings = get_option("wp-tracy-user-settings", []);
+
+    $settings = wp_parse_args($userSettings, $defaultSettings);
+
+    if ($settings["check-is-user-logged-in"] === "on") {
+        $isUserLoggedIn = is_user_logged_in();
+        if (!$isUserLoggedIn) {
+            return; // cancel for anonymous users
+        }
+        $onlyForUserId = $settings["only-for-user-id"];
+        if ($onlyForUserId > 0 && $onlyForUserId != get_current_user_id()) {
+            return; // cancel other users
+        }
+    }
+
+    switch ($settings["debugger-mode"]) {
+        case "development":
+            $debugMode = Tracy\Debugger::DEVELOPMENT;
+            break;
+        case "production":
+            $debugMode = Tracy\Debugger::PRODUCTION;
+            break;
+        default:
+            $debugMode = Tracy\Debugger::DETECT;
+            break;
+    }
+    Tracy\Debugger::enable($debugMode); // hooray, enabling debugging using Tracy
+
+    $panelsClasses = $settings["panels-classes"];
+    if (!is_array($panelsClasses)) {
+        trigger_error("\"wp-tracy-user-settings->panels-classes\" option must be type of array.", E_USER_WARNING);
+        exit;
+    }
+
+    // panels (custom) filtering
+    if ($settings["panels-filtering-allowed"] === "on") {
+        $panelsClasses = apply_filters("wp_tracy_panels_filter", $panelsClasses);
+        if (!is_array($panelsClasses)) {
+            trigger_error("\"wp_tracy_panels_filter\" must return type of array.", E_USER_WARNING);
+            exit;
+        }
+    }
 
     // panels registration
-    foreach ($panels as $className) {
-        Tracy\Debugger::getBar()->addPanel(new $className);
+    foreach ($panelsClasses as $className) {
+        $panel = new $className;
+        if ($panel instanceof Tracy\IBarPanel) {
+            Tracy\Debugger::getBar()->addPanel(new $className);
+        }
     }
 }

src/panels/wpdbpanel.class.php

@@ -4,25 +4,24 @@
 
 /**
  * Custom panel based on global $wpdb variable
- * 
+ *
  * @author Martin Hlaváč
- * @link http://www.ktstudio.cz/
  */
-class WpDbPanel extends WpPanelBase {
-
-    public function getTab() {
+class WpDbPanel extends WpPanelBase
+{
+    public function getTab()
+    {
         return parent::getSimpleTab(__("DB"));
     }
 
-    public function getPanel() {
+    public function getPanel()
+    {
         /* @var $wpdb \WPDB */
         global $wpdb;
-        $output = parent::getTablePanel(array(
-                    "Last Query" => $wpdb->last_query,
-                    "Func Call" => $wpdb->func_call,
-        ));
+        $output = parent::getTablePanel([
+            "Last Query" => $wpdb->last_query,
+        ]);
         $output .= parent::getObjectPanel($wpdb);
         return $output;
     }
-
 }

src/panels/wppanel.class.php

@@ -6,17 +6,18 @@
 
 /**
  * Custom panel based on global $wp variable + other global (versions) variables
- * 
+ *
  * @author Martin Hlaváč
- * @link http://www.ktstudio.cz/
  */
-class WpPanel extends WpPanelBase {
-
-    public function getTab() {
-        return parent::getSimpleTab(__("WP"), null, "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABtUlEQVR42nXTXyjdYRzH8XN0TqZ2oUV2pDXadKwVyR3TtHGlhBuJ3BjGKIq4UBZtDZ3ajb8XUv7kjuGKFEVpKf9KmlxQRgm1FJua97c+v/pp89Src3p+3+f7PL/v8/15Pf+OVKTjj9jwwY/vWHUHe13/H6AaO4hDHhL17AemsY9k9ODSncAWN2IZg0jw/H8coAyvELIkToJ6rOMbHnruHxMoRjg+oMsSvEQsDhGDfAW1Ygt/8RYf0aZfj+Z+WYIa7GIBYfiJKFwjgHOsqbhHCNpClCDSElTiDQYwrxqUa5cq9KMZnzXXgCGMYcoSVOA9NlUgO9qcgi1htoq6p6KPYAbt+OIkqNSVPcaVXiMaX9GBU/VAGrrxHEnodF7hNYpQqh36NF+HRypck+2IQh3fTjnrVfNcYFSTOarJMMZ1K88Qr1O0qF7vEOFVVYM6qv0+wbECrZhP1dorqEWuElofnDiNZEfdwCQ+WYMgE4t63q8bCajVC5Bi3egk8OuqlnQjRSpgnZ6faXEWfiNDm1y5Pya/Fh+opUPqeYuxj6lRlX+BXt3Wna/RGUEV8UZt7MT59Erb7uBbAThl6Btg2vYAAAAASUVORK5CYII=");
+class WpPanel extends WpPanelBase
+{
+    public function getTab()
+    {
+        return parent::getSimpleTab(__("WP"), null, "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfiCQkLEyXB/kfmAAABbklEQVQozz3RPUjUcQCA4ef/Oy89yCO7LA61oVsqOKzLoMUCU3NosJCG3BpqC8KltraWiqMpaJKWimgo+vCOK7jQ6OOwpYQEG0yTSJLI6zK9Goz2l3d5IuinUZ8h7eoIPrmr6FcBUT+kjUh5oOIbWuxz1Bd5C+tB2iWTbqhSWP/R6rq40xZimQ0uWnJTJKYtk8gkpXw3YERWo1KDw4b91OWyGWf1+e2WvLgmDHocHDepw2YV065J2GnKsqIJdW8cC7bLm7NbDjOeaTAgsmhU1SMdQeSV55ocwZoSDmrDtPfGhYCa+/7o0YptqnY4gK3GzYuCIKXsg11ymm1yW9yASKenmoVgVpd5RY16Zc0ZVdWt0xYv7Tcby9QNKqg5IWlN2Vs9slbNmXDOvWDMojMqJu2R9c6yh+KGvHbKorFgxVV7DSvjhR944qslh+RcsRIw77x23ZZM2Sip5qMWCRd8JvrP3euktNV/3HeU1rn/Av+FclJF48KxAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE4LTA5LTA5VDExOjE5OjM3LTA3OjAwvabE/AAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOC0wOS0wOVQxMToxOTozNy0wNzowMMz7fEAAAAAZdEVYdFNvZnR3YXJlAEFkb2JlIEltYWdlUmVhZHlxyWU8AAAAAElFTkSuQmCC");
     }
 
-    public function getPanel() {
+    public function getPanel()
+    {
         /* @var $wpdb \WP */
         global $wp;
         global $wp_version;
@@ -25,16 +26,15 @@ public function getPanel() {
         global $required_php_version;
         global $required_mysql_version;
         global $pagenow;
-        $output = parent::getTablePanel(array(
-                    __("WP Version") => $wp_version,
-                    __("WP DB Version ") => $wp_db_version,
-                    __("TinyMCE Version ") => $tinymce_version,
-                    __("Required PHP Version") => $required_php_version,
-                    __("Required MySQL Version") => $required_mysql_version,
-                    __("Page Now") => $pagenow,
-                    __("WP") => Debugger::dump($wp, true),
-        ));
+        $output = parent::getTablePanel([
+            __("WP Version") => $wp_version,
+            __("WP DB Version ") => $wp_db_version,
+            __("TinyMCE Version ") => $tinymce_version,
+            __("Required PHP Version") => $required_php_version,
+            __("Required MySQL Version") => $required_mysql_version,
+            __("Page Now") => $pagenow,
+            __("WP") => Debugger::dump($wp, true),
+        ]);
         return $output;
     }
-
 }

src/panels/wppanelbase.class.php

@@ -2,35 +2,31 @@
 
 namespace WpTracy;
 
-use Tracy,
-    Tracy\IBarPanel,
-    Tracy\Dumper;
+use Tracy\Dumper;
+use Tracy\IBarPanel;
 
 /**
- * Common basic model for other WP panels 
- * 
+ * Common basic model for other WP panels
+ *
  * @author Martin Hlaváč
- * @link http://www.ktstudio.cz/
  */
-abstract class WpPanelBase implements IBarPanel {
-
+abstract class WpPanelBase implements IBarPanel
+{
     /**
      * (HTML) content of tab for panel
-     * 
-     * @author Martin Hlaváč
-     * @link http://www.ktstudio.cz/
-     * 
+     *
      * @param string $title
      * @param string $description
      * @param string $imageBase64
      * @return string
      */
-    public function getSimpleTab($title = null, $description = null, $imageBase64 = null) {
-        $output = "<span" . (self::issetAndNotEmpty($description) ? " title=\"$description\"" : "") . ">";
-        if (self::issetAndNotEmpty($imageBase64)) {
-            $output .= "<img src=\"data:image/png;base64,$imageBase64\" /> ";
+    public function getSimpleTab($title = null, $description = null, $imageBase64 = null)
+    {
+        $output = "<span" . (!empty($description) ? " title=\"$description\"" : "") . ">";
+        if (!empty($imageBase64)) {
+            $output .= "<img src=\"data:image/png;base64,$imageBase64\" width=\"16\" height=\"16\" /> ";
         }
-        if (self::issetAndNotEmpty($title)) {
+        if (!empty($title)) {
             $output .= $title;
         }
         $output .= "</span>";
@@ -39,17 +35,15 @@ public function getSimpleTab($title = null, $description = null, $imageBase64 =
 
     /**
      * (HTML) table content of panel based on parameters array
-     * 
-     * @author Martin Hlaváč
-     * @link http://www.ktstudio.cz/
-     * 
+     *
      * @param array $params
      * @param string $title
      * @return string
      */
-    public function getTablePanel(array $params, $title = null) {
+    public function getTablePanel(array $params, $title = null)
+    {
         $output = null;
-        if (self::issetAndNotEmpty($title)) {
+        if (!empty($title)) {
             $output .= "<h1>$title</h1>";
         }
         $output .= "<div class=\"nette-inner\">";
@@ -72,37 +66,21 @@ public function getTablePanel(array $params, $title = null) {
     }
 
     /**
-     * (HTML) content of panel based on object 
-     * 
-     * @author Martin Hlaváč
-     * @link http://www.ktstudio.cz/
-     * 
+     * (HTML) content of panel based on object
+     *
      * @param mixed $object
      * @param string $title
      * @return string
      */
-    public function getObjectPanel($object, $title = null) {
+    public function getObjectPanel($object, $title = null)
+    {
         $output = null;
-        if (self::issetAndNotEmpty($title)) {
+        if (!empty($title)) {
             $output .= "<h1>$title</h1>";
         }
         $output .= "<div class=\"nette-inner\">";
-        $output .= Dumper::toHtml($object, array(Dumper::COLLAPSE => false));
+        $output .= Dumper::toHtml($object, [Dumper::COLLAPSE => false]);
         $output .= "</div>";
         return $output;
     }
-
-    /**
-     * Check if the value is assigned and if it's not empty
-     * 
-     * @author Martin Hlaváč
-     * @link http://www.ktstudio.cz/
-     * 
-     * @param mixed $value
-     * @return boolean
-     */
-    public static function issetAndNotEmpty($value) {
-        return isset($value) && !empty($value);
-    }
-
 }