1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
|
<?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 - Publically 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">
<p><A NAME="__index__"></a></p>
<!-- INDEX BEGIN -->
<ul>
<li><A HREF="#name">NAME</a></li>
<li><A HREF="#description">DESCRIPTION</a></li>
<li><A HREF="#functions">FUNCTIONS</a></li>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><A NAME="name">NAME</a></h1>
<p>HTML::Mason::Utils - Publically 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="item_data_cache_namespace">data_cache_namespace ($comp_id)</a></strong>
<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>
</dd>
<dd>
<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>
</li>
<dt><strong><A NAME="item_cgi_request_args">cgi_request_args ($cgi, $method)</a></strong>
<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 <code>hash(ref)</code>
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>
</li>
</dl>
</body>
</html>
|