.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Table 3" .TH Table 3 "2007-03-30" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Apache::Table \- Perl interface to the Apache table structure .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Apache::Table (); .Ve .PP .Vb 4 \& my $headers_out = $r->headers_out; \& while(my($key,$val) = each %$headers_out) { \& ... \& } .Ve .PP .Vb 2 \& my $table = $r->headers_out; \& $table->set(From => 'dougm@perl.apache.org'); .Ve .PP mod_perl needs to be compiled with at least one of the following options: .PP .Vb 3 \& DYNAMIC=1 \& PERL_TABLE_API=1 \& EVERYTHING=1 .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides tied interfaces to Apache data structures. .Sh "\s-1CLASSES\s0" .IX Subsection "CLASSES" .IP "Apache::Table" 4 .IX Item "Apache::Table" The \fIApache::Table\fR class provides methods for interfacing with the Apache \f(CW\*(C`table\*(C'\fR structure. The following \fIApache\fR class methods, when called in a scalar context with no \*(L"key\*(R" argument, will return a \fI\s-1HASH\s0\fR reference blessed into the \&\fIApache::Table\fR class and where \fI\s-1HASH\s0\fR is tied to \&\fIApache::Table\fR: .Sp .Vb 6 \& headers_in \& headers_out \& err_headers_out \& notes \& dir_config \& subprocess_env .Ve .Sh "\s-1METHODS\s0" .IX Subsection "METHODS" .RS 4 .IP "get" 4 .IX Item "get" Corresponds to the \f(CW\*(C`ap_table_get\*(C'\fR function. .Sp .Vb 1 \& my $value = $table->get($key); .Ve .Sp .Vb 1 \& my $value = $headers_out->{$key}; .Ve .IP "set" 4 .IX Item "set" Corresponds to the \f(CW\*(C`ap_table_set\*(C'\fR function. .Sp .Vb 1 \& $table->set($key, $value); .Ve .Sp .Vb 1 \& $headers_out->{$key} = $value; .Ve .IP "unset" 4 .IX Item "unset" Corresponds to the \f(CW\*(C`ap_table_unset\*(C'\fR function. .Sp .Vb 1 \& $table->unset($key); .Ve .Sp .Vb 1 \& delete $headers_out->{$key}; .Ve .IP "clear" 4 .IX Item "clear" Corresponds to the \f(CW\*(C`ap_table_clear\*(C'\fR function. .Sp .Vb 1 \& $table->clear; .Ve .Sp .Vb 1 \& %$headers_out = (); .Ve .IP "add" 4 .IX Item "add" Corresponds to the \f(CW\*(C`ap_table_add\*(C'\fR function. .Sp .Vb 1 \& $table->add($key, $value); .Ve .IP "merge" 4 .IX Item "merge" Corresponds to the \f(CW\*(C`ap_table_merge\*(C'\fR function. .Sp .Vb 1 \& $table->merge($key, $value); .Ve .RE .RS 4 .RE .SH "AUTHOR" .IX Header "AUTHOR" Doug MacEachern .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIApache\fR\|(3), \fImod_perl\fR\|(3)