dump

Returns a dump of various user and session-related information.

Summary

[dump key]

Parameter	Description	Default
key	Only show a specific subset of the session.	None
no_cgi	Don't show CGI variables in the dump.	No
no_env	Don't show HTTP environment variables in the dump.	No
no_session	Don't show session content data.	No
show_all	Show all CGI variables, including variables that would normally be hidden.	No
hide	Suppress any output text that would ordinarily be returned from this tag. (This universal parameter was introduced with Interchange version 5.5.2.)	No
interpolate	Process any Interchange tags found in the text output from this tag.	Yes

Examples

Perl example

$Tag->dump({
key => 'key',
});

or similarly with positional parameters:

$Tag->dump('key');

Description

This tag can be very useful for debugging. It uses the Data::Dumper Perl module to format and return the following as a large block of text:

Cart contents.
CGI variables.
Client connection information.
Environment variables.
Query value.
Session information.

For instance, you can dump the entire session with the following:

[dump]

You use the following to dump the only contents of the cart(s), with no other session information:

[dump carts]

See the key parameter for more information.

Parameters

key

This parameter can be used to limit the dump to a specific subset of the session data.

The following keys are usually the most useful:

Key	Description
carts	Cart contents.
scratch	Scratchpad variables.
values	Form values.

Other keys are available. Use the [dump] tag with no key to see the entire list.

no_cgi

Don't show CGI variables in the dump. This parameter has no effect if the key parameter is also specified.

no_env

Don't show HTTP environment variables in the dump. This parameter has no effect if the key parameter is also specified.

no_session

Don't show session content data. This parameter has no effect if the key parameter is also specified.

show_all

Show all CGI variables, including ones that would normally be hidden from view. The special "hidden" variables are as follows:

mv_password
mv_verify
mv_password_old
mv_credit_card_number
mv_credit_card_cvv2

This parameter has no effect if either the key or no_cgi parameters are also specified.

Note

The above "hidden" variables, revealed with the "show_all" parameter, will not be stored in the user's session under any circumstances. They may be present in the current view of the session if they have been passed to the current page as CGI variables (most likely as part of a <form> POST).