File Coverage

blib/lib/CGI/Session/Serialize/storable.pm

Criterion	Covered	Total	%
statement	10	10	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod	2	2	100.0
total	16	16	100.0

package CGI::Session::Serialize::storable;

# $Id$

use strict;
use Storable;
require CGI::Session::ErrorHandler;

$CGI::Session::Serialize::storable::VERSION = '4.43';
@CGI::Session::Serialize::storable::ISA               = ( "CGI::Session::ErrorHandler" );

=pod

=head1 NAME

CGI::Session::Serialize::storable - Serializer for CGI::Session

=head1 DESCRIPTION

This library can be used by CGI::Session to serialize session data. Uses L<Storable|Storable>.

=head1 METHODS

=over 4

=item freeze($class, \%hash)

Receives two arguments. First is the class name, the second is the data to be serialized.
Should return serialized string on success, undef on failure. Error message should be set using
C<set_error()|CGI::Session::ErrorHandler/"set_error()">

=cut

sub freeze {
    my ($self, $data) = @_;
    return Storable::freeze($data);
}

=item thaw($class, $string)

Receives two arguments. First is the class name, second is the I<frozen> data string. Should return
thawed data structure on success, undef on failure. Error message should be set
using C<set_error()|CGI::Session::ErrorHandler/"set_error()">

=back

=cut

sub thaw {
    my ($self, $string) = @_;
    return Storable::thaw($string);
}

=head1 LICENSING

For support and licensing see L<CGI::Session|CGI::Session>

=cut

1;