/usr/share/doc/libapache2-request-perl/html/group__apreq__xs__apr__request__param.html is in libapreq2-doc 2.13-3ubuntu2.
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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 | <html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
<title>libapreq2-2.13: libapreq2: APR::Request::Param</title>
</head>
<body>
<div id="page-header">
<p class="menu">
<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> >
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>APR::Request::Param<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
</table>
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#overloads">OVERLOADS</a></li>
<ul>
<li><a href="#">""</a></li>
</ul>
<li><a href="#methods">METHODS</a></li>
<ul>
<li><a href="#name">name</a></li>
<li><a href="#value">value</a></li>
<li><a href="#is_tainted">is_tainted</a></li>
<li><a href="#charset">charset</a></li>
<li><a href="#make">make</a></li>
<li><a href="#info">info</a></li>
<li><a href="#upload">upload</a></li>
<li><a href="#upload_filename">upload_filename</a></li>
<li><a href="#upload_link">upload_link</a></li>
<li><a href="#upload_slurp">upload_slurp</a></li>
<li><a href="#upload_size">upload_size</a></li>
<li><a href="#upload_type">upload_type</a></li>
<li><a href="#upload_tempname">upload_tempname</a></li>
<li><a href="#upload_io">upload_io</a></li>
<li><a href="#upload_fh">upload_fh</a></li>
</ul>
<li><a href="#methods">METHODS</a></li>
<ul>
<li><a href="#new__tiehandle">new, TIEHANDLE</a></li>
<li><a href="#read">READ</a></li>
<li><a href="#readline">READLINE</a></li>
</ul>
<li><a href="#methods">METHODS</a></li>
<ul>
<li><a href="#read">read</a></li>
<li><a href="#readline">readline</a></li>
</ul>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>APR::Request::Param - wrapper for libapreq2's param API.</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
use APR::Request::Param;</pre>
<pre>
$arg1 = $req->args('alpha');
$body = $req->body;
$body->param_class("APR::Request::Param");
ok $_->isa("APR::Request::Param") for values %$body;</pre>
<pre>
@uploads = grep {$_->upload} values %$body;
$param = $body->get('beta');
$param->upload_slurp(my $content);</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>The <code>APR::Request::Param</code> module provides base methods
for interfacing with libapreq2's param API. It also provides
a few utility functions and constants.</p>
<p>This manpage documents version 2.13
of the APR::Request::Param, APR::Request::Brigade,
and APR::Request::Brigade::IO packages.</p>
<p>
</p>
<hr />
<h1><a name="overloads">OVERLOADS</a></h1>
<p>APR::Request::Param</p>
<p>
</p>
<h2><a name="">""</a></h2>
<pre>
"$param"</pre>
<p>The double-quote interpolation operator maps to
<code>APR::Request::Param::value()</code>.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<p>APR::Request::Param</p>
<p>
</p>
<h2><a name="name">name</a></h2>
<pre>
$param->name()</pre>
<p>Returns the param's name.
This attribute cannot be modified.</p>
<p>
</p>
<h2><a name="value">value</a></h2>
<pre>
$param->value()</pre>
<p>Returns the param's value.
This attribute cannot be modified.</p>
<p>
</p>
<h2><a name="is_tainted">is_tainted</a></h2>
<pre>
$param->is_tainted()
$param->is_tainted($set)</pre>
<p>Get/set the param's internal tainted flag.
Note: if the param's charset is APREQ_CHARSET_UTF8 (8),
this also activates the SvUTF8_on flag during calls
to <code>name()</code> and/or <code>value()</code>.</p>
<pre>
$tainted = $param->is_tainted;
$param->is_tainted(0);
ok $param->is_tainted == 0;</pre>
<p>
</p>
<h2><a name="charset">charset</a></h2>
<pre>
$param->charset()
$param->charset($set)</pre>
<p>Get/set the param's internal charset. The charset
is a number between 0 and 255; the current recognized
values are</p>
<ol>
<li>
<strong>
<a name="apreq_charset_ascii" class="item">APREQ_CHARSET_ASCII (7-bit us-ascii)</a>
</strong>
<li>
<strong>
<a name="apreq_charset_latin1" class="item">APREQ_CHARSET_LATIN1 (8-bit iso-8859-1)</a>
</strong>
<li>
<strong>
<a name="apreq_charset_cp1252" class="item">APREQ_CHARSET_CP1252 (8-bit Windows-1252)</a>
</strong>
<li>
<strong>
<a name="apreq_charset_utf8" class="item">APREQ_CHARSET_UTF8 (utf8 encoded Unicode)</a>
</strong>
</ol>
<p>See <a href="#is_tainted">the is_tainted manpage</a> above for info about how APREQ_CHARSET_UTF8
relates to perl's UTF-8 flag.</p>
<pre>
$charset = $param->charset;
$param->charset(2);
ok $param->charset == 2;</pre>
<p>
</p>
<h2><a name="make">make</a></h2>
<pre>
APR::Request::Param->make($pool, $name, $value)</pre>
<p>Fast XS param constructor.</p>
<p>
</p>
<h2><a name="info">info</a></h2>
<pre>
$param->info()
$param->info($set)</pre>
<p>Get/set the APR::Table headers for this param.</p>
<p>
</p>
<h2><a name="upload">upload</a></h2>
<pre>
$param->upload()
$param->upload($set)</pre>
<p>Get/set the APR::Brigade file-upload content for this param.</p>
<p>
</p>
<h2><a name="upload_filename">upload_filename</a></h2>
<pre>
$param->upload_filename()</pre>
<p>Returns the client-side filename associated with this param.</p>
<p>
</p>
<h2><a name="upload_link">upload_link</a></h2>
<pre>
$param->upload_link($path)</pre>
<p>Links the file-upload content with the local file named <code>$path</code>.
Creates a hard-link if the spoolfile's (see <a href="#upload_tempname">the upload_tempname manpage</a>)
temporary directory is on the same device as <code>$path</code>;
otherwise this writes a copy.</p>
<p>
</p>
<h2><a name="upload_slurp">upload_slurp</a></h2>
<pre>
$param->upload_slurp($data)</pre>
<p>Reads the entire file-upload content into <code>$data</code>.</p>
<p>
</p>
<h2><a name="upload_size">upload_size</a></h2>
<pre>
$param->upload_size()</pre>
<p>Returns the size of the param's file-upload content.</p>
<p>
</p>
<h2><a name="upload_type">upload_type</a></h2>
<pre>
$param->upload_type()</pre>
<p>Returns the MIME-type of the param's file-upload content.</p>
<p>
</p>
<h2><a name="upload_tempname">upload_tempname</a></h2>
<pre>
$param->upload_tempname()</pre>
<p>Returns the name of the local spoolfile for this param.</p>
<p>
</p>
<h2><a name="upload_io">upload_io</a></h2>
<pre>
$param->upload_io()</pre>
<p>Returns an <a href="/APR/Request/Brigade/IO.html">the APR::Request::Brigade::IO manpage</a> object, which can
be treated as a non-seekable IO stream.</p>
<p>
</p>
<h2><a name="upload_fh">upload_fh</a></h2>
<pre>
$param->upload_fh()</pre>
<p>Returns a seekable filehandle representing the file-upload content.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<p>APR::Request::Brigade</p>
<p>This class is derived from APR::Brigade, providing additional
methods for TIEHANDLE, READ and READLINE. To be memory efficient,
these methods delete buckets from the brigade as soon as their
data is actually read, so you cannot <code>seek</code> on handles tied to
this class. Such handles have semantics similar to that of a
read-only socket.</p>
<p>
</p>
<h2><a name="new__tiehandle">new, TIEHANDLE</a></h2>
<pre>
APR::Request::Brigade->TIEHANDLE($bb)</pre>
<p>Creates a copy of the bucket brigade represented by $bb, and
blesses that copy into the APR::Request::Brigade class. This
provides syntactic sugar for using perl's builtin <code>read</code>, <code>readline</code>,
and <code><></code> operations on handles tied to this package:</p>
<pre>
use Symbol;
$fh = gensym;
tie *$fh, "APR::Request::Brigade", $bb;
print while <$fh>;</pre>
<p>
</p>
<h2><a name="read">READ</a></h2>
<pre>
$bb->READ($contents)
$bb->READ($contents, $length)
$bb->READ($contents, $length, $offset)</pre>
<p>Reads data from the brigade $bb into $contents. When omitted
$length defaults to <code>-1</code>, which reads the first bucket into $contents.
A positive $length will read in $length bytes, or the remainder of the
brigade, whichever is greater. $offset represents the index in $context
to read the new data.</p>
<p>
</p>
<h2><a name="readline">READLINE</a></h2>
<pre>
$bb->READLINE()</pre>
<p>Returns the first line of data from the bride. Lines are terminated by
linefeeds (the '\012' character), but we may eventually use <code>$/</code> instead.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<p>APR::Request::Brigade::IO</p>
<p>
</p>
<h2><a name="read">read</a></h2>
<p>OO interface to APR::Request::Brigade::READ.</p>
<p>
</p>
<h2><a name="readline">readline</a></h2>
<p>OO interface to APR::Request::Brigade::READLINE.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="group__apreq__xs__apr__request.html">the APR::Request manpage</a>, <a href="http://apr.apache.org/docs/apr/1.3/apr__tables_8h.html">the APR::Table manpage</a>, <a href="http://apr.apache.org/docs/apr-util/1.3/apr__buckets_8h.html">the APR::Brigade manpage</a>.</p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at</pre>
<pre>
<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
<pre>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</pre>
</div>
<div id="footer">
<p class="apache">
Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
version 1.5.6 on 25 Nov 2010</span>
</p>
</div>
</body>
</html>
|