Super Globals Plus for Zen Cart 1.3.9, 1.5.0-1.5.4

Version 1.6.1 by paulm, torvista and lat9

Current Support Thread at Zen Cart Forums: http://www.zen-cart.com/forum/showthread.php?p=429150

Copyright

Paul Mathot, Haarlem, the Netherlands, September 2007 (beterelektro.nl) :: lat9 (vinosdefrutastropicales.com), 2011-2015. Released under the Gnu General Public License (see included LICENSE.TXT)

What it does

Super Globals Plus is a developers' tool that makes evaluating variables easy. It produces a clear overview of the contents of strings, arrays, constants, objects, arrays within object, objects within arrays or whatever. Because the amount of information given by this tool was overwhelming to most new users of the Super Globals Plus script, version 1.24 and later only shows $_POST and $_SESSION by default.

Features:

• Show all GLOBALS, or just the Superglobals you need to evaluate.
• Show all defined constants (v1.2).
• Show a list of included files (v1.22).
• Show Superglobals either in a javascript popup window or at the end of each rendered page. (v1.4)
• Optionally hide HTTP_ variables when showing all globals.
• Show the whole content of each variable, including all objects and arrays etc!
• Recursion protection (optional: recursion level/off)
• Show the variable type (array, string, object, integer, NULL, boolean, resource).
• Converts strings into their htmlentities before output (v1.0)
• Clear output (see screenshot to the right).
• Easy install on Zen Cart 1.3.9, 1.5.0, 1.5.1, 1.5.2 and 1.5.3 — instructions included.
• Optional IP address protection.
• Admin switches for all options.

How to use it

After you have you have copied the required files and logged into your store's admin, you will see the Configuration->Superglobals selection. Within that selection are the values that you can use to control the plugin's display.

Installation

There are no core-file overwrites for the catalog area in this plugin, but there are core-file admin overwrites. You should always backup your store's database and files prior to making any changes.

1. Log into your Zen Cart admin.
2. Copy these files to your store's file-system, after renaming the "YOUR_TEMPLATE" directory to match your custom template's name and the "YOUR_ADMIN" directory to match the name of your admin directory:
   1. /includes/functions/extra_functions/superglobals.php
   2. /includes/templates/YOUR_TEMPLATE/common/tpl_main_page.php
   3. /includes/templates/YOUR_TEMPLATE/css/stylesheet_superglobals.css
   4. /YOUR_ADMIN/index.php
   5. /YOUR_ADMIN/includes/footer.php
   6. /YOUR_ADMIN/includes/stylesheet.css
   7. /YOUR_ADMIN/includes/stylesheet_superglobals.css
   8. /YOUR_ADMIN/includes/functions/extra_functions/superglobals.php
   9. /YOUR_ADMIN/includes/languages/english/extra_definitions/superglobals.php
3. Click the "Admin Home" link. After you've clicked that link, the plugin's auto-installer will run and the Configuration->Superglobals will be available.

Un-install

Run either superglobals_remove.sql (for Zen Cart v1.5.0 or later) or superglobals_remove_139.sql (for Zen Cart v 1.3.9x) to remove the database entries, then delete the files you previously copied (replacing the admin core files that were overwritten).

Version History:

• v1.6.1 (lat9), 2015-12-06:
  • BUGFIX: Correct validation issues.
  • BUGFIX: Correct processing of Super Globals Exclusions so that the associated data elements are bypassed rather than removed.
• v1.6.0 (lat9), 2014/06/07:
  • BUGFIX: SQL uninstall script doesn't check for a cgi of 0.
  • Identify support for Zen Cart v1.5.3.
  • Remove SQL install scripts, auto-install instead.
  • Move ADMIN_OPTIONAL elements (supporting admin-based Superglobals) into the base install, removing an additional installation step.
  • Removed (unused) /includes/stylesheet_superglobals.css
  • Included Zen Cart v1.5.3 changes to /YOUR_ADMIN/index.php
  • Added a configuration field (Super Globals Exclusions) so that you can identify a list of variables to exclude from the Super Globals variable display. These variables are usually large arrays that don't convey meaningful information.
• v1.5.0 (lat9), 2013/11/30, Include downwardly-compatible Zen Cart v1.5.2 changes in the /YOUR_ADMIN_OPTIONAL files.
• v1.4.4 (torvista, lat9), 2013/02/27
  • Corrected validation errors (empty <strong> tags and popup display) — torvista
  • Added "future proofing" around call to mysql_fetch_array call (deprecated in PHP 5.5) — lat9
• v1.4.3 (lat9), 2013/01/23. *BUGFIX* Updated /includes/functions/extra_functions/superglobals.php so that index 0 of an indexed array is properly output; the problem was introduced by me in the previous release.
• v1.4.2 (lat9), 2012/11/23
  • Updated installation SQL files to correct problem documented by swguy here.
  • Added new configuration value for v1.5.0 and later SQL values to control whether or not the queryCache object is shown. This object can be huge and takes a while to process. Changes made to the superglobals.sql file as well as /includes/functions/extra_functions/superglobals.php. Note that the queryCache object was introduced in Zen Cart v1.5.1; changing this configuration value on a v1.5.0 installation will have no effect.
• v1.4.1 (lat9), 2012/10/13
  • Modified htmlentities calls to include ENT_COMPAT and the CHARSET, for compatibility with PHP v5.4
  • Added htmlspecialchars wrapper around value outputs that were causing HTML validation errors
• v1.4 (paulm and lat9), 2011/09/12
  • Added capability (and admin option) to display the Superglobals information either in a javascript popup window or at the end of each rendered page.
• v1.31 (lat9), 2011/08/15
  • Corrected v1.5.0+ install/uninstall SQL, per this thread.
• v1.30 (lat9), 2011/08/07
  • Corrected invalid HTML output caused by empty resources
  • Added install/uninstall SQL for Zen Cart 1.5.0 and later
  • Restructured zip-file directory, so that installation is simpler.
• v1.24
  • Minor readme.txt edits
  • Minor sql file edits (texts and some default settings) + added removal of old configurations
  • Added extras folder which contains two ready made files so you can even skip the two simple file edits in most cases.
• v1.22-1.23
  • Minor layout fix and some readme.txt edits
• v1.21
  • Added get_ included_ files()
• v1.2
  • Added defined CONSTANTS display.
  • Fixed bugs in admin superglobals function (admin superglobals would only display when shop was in root and when catalog superglobals were enabled).
  • Modified readme for 1.3.5 compatibility
• v1.12
  • fixed typo (which caused XHTML validation errors)
• v1.11
  • Fixed "Enable Superglobals" switches (error in 1.1)
• v1.1
  • (re)Added output buffering
  • Added HTTP_ filter:
    

    if (!(strstr($toplevel_key,'HTTP_') == $toplevel_key)) {

• v1.0, First public non beta version.
  • Removed the "Show single var" feature, since it did not make much sense after all.
  • Shows the var type for every var now (before only arraýs and objects where identified as such, now int, string, etc etc are too).
  • Added htmlentities function for strings.
  • Cleaned up code (replaced if else structure by switch() case)
  • Added feature to echo $GLOBALS
  • Combined catalog and admin script into one
  • Improved HTML source formatting
  • Added recursion level counter (and a maximum recursion level setting)
  • Renamed functions, again (hopefully the function names do make a little more sense now)
  • Added CSS color for resources (blue)
• v0.99
  • Renamed to 0.99 ;-) (not 1.00 because I did not get to cleaning up the code yet)
  • Some (other) small changes to this readme.
• v0.97
  • If the supervar_echo() function is being used, the output will be displayed in the HTML body (while it was displayed "on the spot" in previous versions).
  • Added option to print the data at the top or bottom of the page.
• v0.91
  • Fixed HTML validation
  • Improved styles
• v0.9, Added admin version and the possibility to view the contents of other (than global) variables/constants/array's/objects.
• 0.81, Added sql to remove the settings from the database.
• v0.8, First public version