Karen Etheridge > CGI-Cookie-Splitter-0.03 > CGI::Cookie::Splitter

Download:
CGI-Cookie-Splitter-0.03.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.03   Source   Latest Release: CGI-Cookie-Splitter-0.04

NAME ^

CGI::Cookie::Splitter - Split big cookies into smaller ones.

SYNOPSIS ^

        use CGI::Cookie::Splitter;

        my $splitter = CGI::Cookie::Splitter->new(
                size => 123, # defaults to 4096
        );

        @small_cookies = $splitter->split( @big_cookies );

        @big_cookies = $splitter->join( @small_cookies );

DESCRIPTION ^

RFC 2109 reccomends that the minimal cookie size supported by the client is 4096 bytes. This has become a pretty standard value, and if your server sends larger cookies than that it's considered a no-no.

This module provides a pretty simple interface to generate small cookies that are under a certain limit, without wasting too much effort.

METHODS ^

new %params

The only supported parameters right now are size. It defaults to 4096.

split @cookies

This method accepts a list of CGI::Cookie objects (or look alikes) and returns a list of CGI::Cookies.

Whenever an object with a total size that is bigger than the limit specified at construction time is encountered it is replaced in the result list with several objects of the same class, which are assigned serial names and have a smaller size and the same domain/path/expires/secure parameters.

join @cookies

This is the inverse of split.

should_split $cookie

Whether or not the cookie should be split

mangle_name_next $name

Demangles name, increments the index and remangles.

mangle_name $name, $index
demangle_name $mangled_name

These methods encapsulate a name mangling scheme for changing the cookie names to allo wa 1:n relationship.

The default mangling behavior is not 100% safe because cookies with a safe size are not mangled.

As long as your cookie names don't start with the substring _bigcookie_ you should be OK ;-)

SUBCLASSING ^

This module is designed to be easily subclassed... If you need to split cookies using a different criteria then you should look into that.

SEE ALSO ^

CGI::Cookie, CGI::Simple::Cookie, http://www.cookiecutter.com/, http://perlcabal.org/~gaal/metapatch/images/copper-moose-cutter.jpg, RFC 2109

VERSION CONTROL ^

This module is maintained using Darcs. You can get the latest version from http://nothingmuch.woobling.org/CGI-Cookie-Splitter/, and use darcs send to commit changes.

AUTHOR ^

Yuval Kogman, nothingmuch@woobling.org

COPYRIGHT & LICENCE ^

        Copyright (c) 2006 the aforementioned authors. All rights
        reserved. This program is free software; you can redistribute
        it and/or modify it under the same terms as Perl itself.
syntax highlighting: