dump — display dump of current session


Attribute Pos. Req. Default Description
key Yes None (all keys) Display a specific subset of the session.
no_env     0 Exclude HTTP environment variables.
no_cgi     0 Exclude CGI variables.
show_all     0 Show all CGI variables, including the "hidden" ones defined in @Global::HideCGI?
no_session     0 Do not output session structure?
interpolate     0 interpolate output?
hide     0 Hide the tag return value?


This tag dumps the complete session or parts of it, and HTTP environment variables in a human readable format, which is useful for debugging.

To display only a subset from the user's session, use parameter key=. The key can be any information from the user's session, but most often you will want to display carts, scratch or values. For a list of all possible keys, smply invoke [dump] and look under "SESSION".


This tag does not appear to be affected by, or affect, the rest of Interchange.


Example: Displaying current user's full session dump


Example: Displaying current user's cart structure

<pre>[dump key=carts]</pre>

Example: Session dump focusing on session values, without HTTP environment

<pre>[dump show_all=1 no_env=1]</pre>



dump is available in Interchange versions:

4.6.0-5.9.0 (git-head)


Interchange 5.9.0:

Source: code/SystemTag/dump.coretag
Lines: 14

# Copyright 2002-2007 Interchange Development Group and others
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.  See the LICENSE file for details.
# $Id: dump.coretag,v 1.5 2007-03-30 23:40:49 pajamian Exp $

UserTag dump                Order        key
UserTag dump                addAttr
UserTag dump                PosNumber    1
UserTag dump                Version      $Revision: 1.5 $
UserTag dump                MapRoutine   ::full_dump


Interchange Development Group



DocBook! Interchange!