<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>HTML::Mason::Utils - Publicly available functions useful outside of Mason</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<!-- INDEX BEGIN -->
<div name="index">
<p><A NAME="__index__"></a></p>
<ul>
<li><A HREF="#name">NAME</a></li>
<li><A HREF="#description">DESCRIPTION</a></li>
<li><A HREF="#functions">FUNCTIONS</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><A NAME="name">NAME</a></h1>
<p>HTML::Mason::Utils - Publicly available functions useful outside of Mason</p>
<p>
</p>
<hr />
<h1><A NAME="description">DESCRIPTION</a></h1>
<p>The functions in this module are useful when you need to interface
code you have written with Mason.</p>
<p>
</p>
<hr />
<h1><A NAME="functions">FUNCTIONS</a></h1>
<dl>
<dt><strong><A NAME="data_cache_namespace" class="item">data_cache_namespace ($comp_id)</a></strong></dt>
<dd>
<p>Given a component id, this method returns its default
<code>Cache::Cache</code> namespace. This can be useful if you want to access
the cached data outside of Mason.</p>
<p>With a single component root, the component id is just the component
path. With multiple component roots, the component id is
<code>key</code>/<code>path</code>, where <code>key</code> is the key corresponding to the root that
the component falls under.</p>
</dd>
<dt><strong><A NAME="cgi_request_args" class="item">cgi_request_args ($cgi, $method)</a></strong></dt>
<dd>
<p>This function expects to receive a <code>CGI.pm</code> object and the request
method (GET, POST, etc). Given these two things, it will return a
hash in list context or a hashref in scalar context. The hash(ref)
will contain all the arguments passed via the CGI request. The keys
will be argument names and the values will be either scalars or array
references.</p>
</dd>
</dl>
</body>
</html>