/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/ModPerl/Global.html is in libapache2-mod-perl2-doc 2.0.8+httpd24-r1449661-6ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | <?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></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">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#Synopsis">Synopsis</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#API">API</a>
<ul>
<li><a href="#special_list_call">special_list_call</a></li>
<li><a href="#special_list_clear">special_list_clear</a></li>
<li><a href="#special_list_register">special_list_register</a></li>
</ul>
</li>
<li><a href="#See-Also">See Also</a></li>
<li><a href="#Copyright">Copyright</a></li>
<li><a href="#Authors">Authors</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>ModPerl::Global -- Perl API for manipulating special Perl lists</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use ModPerl::Global ();
my $package = 'MyApache2::Package';
# make the END blocks of this package special
ModPerl::Global::special_list_register(END => $package);
# Execute all encoutered END blocks from this package now
ModPerl::Global::special_list_call( END => $package);
# delete the list of END blocks
ModPerl::Global::special_list_clear( END => $package);</code></pre>
<h1 id="Description">Description</h1>
<p><code>ModPerl::Global</code> provides an API to manipulate special perl lists. At the moment only the <code>END</code> blocks list is supported.</p>
<p>This API allows you to change the normal Perl behavior, and execute special lists when you need to.</p>
<p>For example <code><a>ModPerl::RegistryCooker</a></code> uses it to run <code>END</code> blocks in the scripts at the end of each request.</p>
<p>Before loading a module containing package <code>$package</code>, you need to register it, so the special blocks will be intercepted by mod_perl and not given to Perl. <code><a href="#C_special_list_register_">special_list_register</a></code> does that. Later on when you want to execute the special blocks, <code><a href="#C_special_list_call_">special_list_call</a></code> should be called. Unless you want to call the list more than once, clear the list with <code><a href="#C_special_list_clear_">special_list_clear</a></code>.</p>
<h1 id="API">API</h1>
<p><code>ModPerl::Global</code> provides the following methods:</p>
<h2 id="special_list_call"><code>special_list_call</code></h2>
<p>Call the special list</p>
<pre><code> $ok = special_list_call($key => $package);</code></pre>
<dl>
<dt id="arg1:-key-string">arg1: <code>$key</code> ( string )</dt>
<dd>
<p>The name of the special list. At the moment only <code>'END'</code> is supported.</p>
</dd>
<dt id="arg2:-package-string">arg2: <code>$package</code> ( string )</dt>
<dd>
<p>what package to special list is for</p>
</dd>
<dt id="ret:-ok-boolean">ret: <code>$ok</code> ( boolean )</dt>
<dd>
<p>true value if <code>$key</code> is known, false otherwise.</p>
</dd>
<dt id="since:-2.0.00">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="special_list_clear"><code>special_list_clear</code></h2>
<p>Clear the special list</p>
<pre><code> $ok = special_list_clear($key => $package);</code></pre>
<dl>
<dt id="arg1:-key-string1">arg1: <code>$key</code> ( string )</dt>
<dd>
<p>The name of the special list. At the moment only <code>'END'</code> is supported.</p>
</dd>
<dt id="arg2:-package-string1">arg2: <code>$package</code> ( string )</dt>
<dd>
<p>what package to special list is for</p>
</dd>
<dt id="ret:-ok-boolean1">ret: <code>$ok</code> ( boolean )</dt>
<dd>
<p>true value if <code>$key</code> is known, false otherwise.</p>
</dd>
<dt id="since:-2.0.001">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="special_list_register"><code>special_list_register</code></h2>
<p>Register the special list</p>
<pre><code> $ok = special_list_call($key => $package);</code></pre>
<dl>
<dt id="arg1:-key-string2">arg1: <code>$key</code> ( string )</dt>
<dd>
<p>The name of the special list. At the moment only <code>'END'</code> is supported.</p>
</dd>
<dt id="arg2:-package-string2">arg2: <code>$package</code> ( string )</dt>
<dd>
<p>what package to special list is for</p>
</dd>
<dt id="ret:-ok-boolean2">ret: <code>$ok</code> ( boolean )</dt>
<dd>
<p>true value if <code>$key</code> is known, false otherwise.</p>
</dd>
<dt id="since:-2.0.002">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Notice that you need to register the package before it is loaded. If you register it after, Perl has already compiled the <code>END</code> blocks and there are no longer under your control.</p>
<h1 id="See-Also">See Also</h1>
<p><a>mod_perl 2.0 documentation</a>.</p>
<h1 id="Copyright">Copyright</h1>
<p>mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.</p>
<h1 id="Authors">Authors</h1>
<p><a>The mod_perl development team and numerous contributors</a>.</p>
</body>
</html>
|