Richard Clamp > OpenFrame-3.05 > OpenFrame::Cookies

Download:
OpenFrame-3.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  3
View/Report Bugs
Module Version: 3.05   Source  

NAME ^

OpenFrame::Cookies - An abstract cookie class

SYNOPSIS ^

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

DESCRIPTION ^

OpenFrame::Cookies 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::Cookies 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::Cookies object. These can hold multiple cookies (although they must have unique names) inside the cookie tin.

  my $cookies = OpenFrame::Cookies->new();

set()

The set() method adds an entry:

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

get()

The get() method returns a cookie (a OpenFrame::Cookie object) given its name:

  my $colour = $cookies->get("colour")->value;

delete()

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

  $cookies->delete("colour");

get_all()

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

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

AUTHOR ^

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

syntax highlighting: