Scroll to navigation

Dancer::Session::YAML(3pm) User Contributed Perl Documentation Dancer::Session::YAML(3pm)

NAME

Dancer::Session::YAML - YAML-file-based session backend for Dancer

VERSION

version 1.3521

DESCRIPTION

This module implements a session engine based on YAML files. Session are stored in a session_dir as YAML files. The idea behind this module was to provide a transparent session storage for the developer.

This backend is intended to be used in development environments, when looking inside a session can be useful.

It's not recommended to use this session engine in production environments.

CONFIGURATION

The setting session should be set to "YAML" in order to use this session engine in a Dancer application.

Files will be stored to the value of the setting "session_dir", whose default value is "appdir/sessions".

Here is an example configuration that use this session engine and stores session files in /tmp/dancer-sessions

    session: "YAML"
    session_dir: "/tmp/dancer-sessions"

METHODS

reset

To avoid checking if the sessions directory exists every time a new session is created, this module maintains a cache of session directories it has already created. "reset" wipes this cache out, forcing a test for existence of the sessions directory next time a session is created. It takes no argument.

This is particularly useful if you want to remove the sessions directory on the system where your app is running, but you want this session engine to continue to work without having to restart your application.

DEPENDENCY

This module depends on YAML.

AUTHOR

This module has been written by Alexis Sukrieh, see the AUTHORS file for details.

SEE ALSO

See Dancer::Session for details about session usage in route handlers.

COPYRIGHT

This module is copyright (c) 2009 Alexis Sukrieh <sukria@sukria.net>

LICENSE

This module is free software and is released under the same terms as Perl itself.

AUTHOR

Dancer Core Developers

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Alexis Sukrieh.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2023-02-10 perl v5.36.0