The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

OpenFrame::Cookietin - An abstract cookie class

SYNOPSIS

  use OpenFrame;
  my $cookietin = OpenFrame::Cookietin->new();
  $cookietin->set("animal" => "parrot");
  my $colour = $cookietin->get("colour");
  $cookietin->delete("colour");
  my %cookies = $cookietin->get_all();

DESCRIPTION

OpenFrame::Cookietin represents cookies inside OpenFrame. Cookies in OpenFrame represent some kind of storage option on the requesting side.

Cookies are a general mechanism which server side connections can use to both store and retrieve information on the client side of the connection. The addition of a simple, persistent, client-side state significantly extends the capabilities of Web-based client/server applications. OpenFrame::Cookietin is an abstract cookie class for OpenFrame which can represent cookies no matter how they really come to exist outside OpenFrame (such as CGI or Apache cookie objects).

METHODS

new()

The new() method creates a new OpenFrame::Cookietin object. These can hold multiple cookies (although they must have unique names) inside the cookie tin.

  my $cookietin = OpenFrame::Cookietin->new();

set()

The set() method adds an entry to the cookie tin:

  $cookietin->set("animal" => "parrot");

get()

The get() method returns a cookie value from the cookie tin given its name:

  my $colour = $cookietin->get("colour");

delete()

The delete() method removes a cookie element from the cookie tin given its name:

  $cookietin->delete("colour");

get_all()

The get_all() method returns a hash of all the cookies in the cookie tin:

  my %cookies = $cookietin->get_all();

AUTHOR

James Duncan <jduncan@fotango.com>, Leon Brocard <leon@fotango.com>