The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

CGI::Session::Serialize::yaml - serializer for CGI::Session

DESCRIPTION

This library can be used by CGI::Session to serialize session data. It uses YAML, or the faster C implementation, YAML::Syck if it is available. YAML serializers exist not just for Perl but also other dynamic languages, such as PHP, Python, and Ruby, so storing session data in this format makes it easy to share session data across different languages.

YAML is made to be friendly for humans to parse as well as other computer languages. It creates a format that is easier to read than the default serializer.

METHODS

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 set_error()|CGI::Session::ErrorHandler/"set_error()"

thaw($class, $string)

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

IMPLEMENTATION

Note that this module enables instantiating objects, so you should not use it if your session data comes from an untrusted source.

YAML::Syck is automatically used if it is available, otherwise YAML.pm will be used. You can also specify YAML::XS:

    $CGI::Session::Serialize::yaml::Flavour = 'YAML::XS';

You should be aware that the three YAML modules all have some differences in their implementation of YAML. They were written for different YAML versions, they have bugs, and they deliberately left out certain things.

Using a diffedrent module for existing session data could be problematic.

SEE ALSO

CGI::Session, YAML, YAML::Syck.