/ 
libapreq2-2.04_03-dev
River stage two • 18 direct dependents • 34 total dependents
/ glue/perl/docs/Table.pod

NAME

Apache::*::Table - Table classes for Apache::Request, Apache::Upload, and Apache::Cookie.

SYNOPSIS

my $table = Apache::Request::Table->new($r);
$table->{test} = 1;
$table->{foo} = "bar1";
$table->add(foo => "bar2");

{
    my $do_data = "";
    $table->do( sub { $do_data .= "@_,"; 1 } );
    ok $do_data eq "test 1,foo bar1,foo bar2,";
}

DESCRIPTION

This manpage documents the Apache::*::Table classes provided by the Apache::Request, Apache::Upload, and Apache::Cookie modules. Table classes are all derived from APR::Table, however since the underlying values they contain are not simple character arrays, the merge, compress, and overlap methods from APR::Table are not implemented.

Apache::Request::Table

These tables arise as parameter tables generated by the args, body, and param methods of Apache::Request. Their values are representable by orinary perl scalars, but unlike APR::Table, the '\0' character may be safely embedded in a value without truncating it.

my $table = Apache::Request::Table->new($r);
my $value = "bar\0quux";
$table->{foo} = $value;

Apache::Upload::Table

These tables arise from the Apache::Request::upload method (which is provided by Apache::Upload). Their values are Apache::Upload objects.

my $upload = Apache::Upload->new($r, name => "foo", file => __FILE__);
my $table = Apache::Upload::Table->new($r);
$table->add($upload);
$upload = $table->{foo};

Apache::Cookie::Table

These tables arise from the cookies method of Apache::Cookie::Jar, and their values are Apache::Cookie objects (or Apache::Cookie derived objects- see the discussion of VALUE_CLASS in Apache::Cookie).

my $cookie = Apache::Cookie->new($r, name =>"foo", value => "bar");
my $table = Apache::Cookie::Table->new($r);
$table->{foo} = $cookie;
$cookie = $table->{foo};

SEE ALSO

Apache::Request, Apache::Cookie, Apache::Upload APR::Table(3)

COPYRIGHT

Copyright 2003-2004  The Apache Software Foundation

Licensed 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

    http://www.apache.org/licenses/LICENSE-2.0

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.