-
-
29 Jan 2020 21:03:12 UTC
- Distribution: Dancer
- Module version: 1.3513
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (2845 / 18 / 0)
- Kwalitee
Bus factor: 4- 86.23% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (382.32KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 182 contributors- Dancer Core Developers
-
1nickt
-
a-adam
-
Achim Adam
-
Adam J. Foxson
-
Adam Kennedy
-
Akash Ayare
-
alambike
-
Alan Haggai Alavi
-
Alberto Simoes
-
Alessandro Ranellucci
-
Alex C
-
Alexis Sukrieh
-
Alex Kalderimis
-
Alex Kapranoff
-
Alex Peters
-
Alfie John
-
Al Newkirk
-
Andrew Beverley
-
andy
-
Anirvan Chatterjee
-
Anton Gerasimov
-
asergei
-
Ashley Willis
-
A. Sinan Unur
-
Ask Bjørn Hansen
-
Assaf Gordon
-
Ben Hutton
-
Bernhard Reutner-Fischer
-
boris shomodjvarac
-
Brad Macpherson
-
Breno G. de Oliveira
-
Brian E. Lozier
-
Brian Hann
-
Brian Phillips
-
burnersk
-
Chris Andrews
-
chrisjrob
-
Chris Seymour
-
Christian Walde
-
chromatic
-
Colin Keith
-
Colin Kuskie
-
CPAN Service
-
Craig Treptow
-
Dagfinn Ilmari Mannsåker
-
Damien Krotkine
-
Damyan Ivanov
-
Dan Book
-
Danijel Tasov
-
Dave Doyle
-
David Cantrell
-
David Golden
-
David Moreno
-
David Steinbrunner
-
David Zurborg
-
Dennis Lichtenthaeler
-
Duncan Hutty
-
Emmanuel Rodriguez
-
Fabrice Gabolde
-
Fayland Lam
-
Felix Dorner
-
Flavio Poletti
-
Florian Larysch
-
Florian Sojer
-
Franck Cuny
-
François Charlier
-
Gabor Szabo
-
Gary Mullen
-
geistteufel
-
Gil Magno
-
Gonzalo Barco
-
Graham Knop
-
Grzegorz Rożniecki
-
Hagen Fuchs
-
Hans Dieter Pearcey
-
Ilmari Vacklin
-
Ilya Chesnokov
-
isync
-
Ivan Bessarabov
-
Ivan Paponov
-
Jacob Rideout
-
Jakob Voss
-
James Aitken
-
jamhed
-
Jess
-
Jesse van Herk
-
Jochen Lutz
-
Joel Roth
-
John Barrett
-
John Wittkoski
-
jonasreinsch
-
Jonathan "Duke" Leto
-
Jonathan Hall
-
Jonathan Otsuka
-
jonathan schatz
-
Jonathan Scott Duff
-
Joshua Barratt
-
JT Smith
-
Juan J. Martínez
-
Jury Gorky
-
Kaitlyn Parkhurst
-
Kent Fredric
-
Kirk Kimmel
-
Lars Thegler
-
Lee Carmichael
-
Lee Johnson
-
Manuel Weiss
-
Marc Chantreux
-
Mark Allen
-
Mark A. Stratman
-
Mark Stosberg
-
Martin Schut
-
Matthew Horsfall (alh)
-
Maurice
-
Maxim Ivanov
-
Max Maischein
-
Michael Genereux
-
Michael G. Schwern
-
Michal Wojciechowski
-
Mikolaj Kucharski
-
miyagawa
-
mlbarrow
-
Mohammad S Anwar
-
Murray
-
Natal Ngétal
-
Nate Jones
-
Naveed Massjouni
-
Naveed
-
Naveen
-
Neil Hooey
-
Nick Tonkin
-
Nicolas Oudard
-
niko
-
Nuno Carvalho
-
Oliver Gorwits
-
Olivier Mengué
-
Olof Johansson
-
Ovid
-
Paul Driver
-
Paul Fenwick
-
Paul Johnson
-
Paul Tomlin
-
pdl
-
Pedro Melo
-
Perlover
-
Phil Carmody
-
Philippe Bruhat (BooK)
-
ppisar
-
Richard Simões
-
Rick Myers
-
Rik Brown
-
Roberto Patriarca
-
Roman Galeev
-
Roman Nuritdinov
-
Rowan Thorpe
-
Russell Jenkins
-
Sam Kington
-
Sapphire Paw
-
Sawyer X
-
scoopio
-
Scott Penrose
-
sdeseille
-
Sean Smith
-
Sebastian de Castelberg
-
Skeeve
-
Slaven Rezic
-
Sniperovitch
-
Squeeks
-
Stefan Hornburg (Racke)
-
Steve Hay
-
Tatsuhiko Miyagawa
-
tednolan
-
Tim King
-
Tom Heady
-
Tom Hukins
-
Tom Wyant
-
Vyacheslav Matyukhin
-
William Wolf
-
Yanick Champoux
- YOUR_NAME <YOUR_EMAIL>
-
Zefram
- Dependencies
- Carp
- Cwd
- Data::Dumper
- Encode
- Exporter
- Fcntl
- File::Basename
- File::Copy
- File::Path
- File::Spec
- File::Spec::Functions
- File::Temp
- File::stat
- FindBin
- Getopt::Long
- HTTP::Body
- HTTP::Date
- HTTP::Headers
- HTTP::Server::Simple::PSGI
- HTTP::Tiny
- Hash::Merge::Simple
- IO::File
- MIME::Types
- Module::Runtime
- POSIX
- Pod::Usage
- Scalar::Util
- Test::Builder
- Test::More
- Time::HiRes
- Try::Tiny
- URI
- URI::Escape
- base
- bytes
- constant
- lib
- overload
- parent
- strict
- vars
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
- NAME
- VERSION
- DESCRIPTION
- USAGE
- SUPPORTED ENGINES
- DEPENDENCY
- AUTHORS
- LICENSE
- SEE ALSO
- AUTHOR
- COPYRIGHT AND LICENSE
NAME
Dancer::Session - session engine for the Dancer framework
VERSION
version 1.3513
DESCRIPTION
This module provides support for server-side sessions for the Dancer web framework. The session is accessible to the user via an abstraction layer implemented by the Dancer::Session class.
USAGE
Configuration
The session engine must be first enabled in the environment settings, this can be done like the following:
In the application code:
# enabling the YAML-file-based session engine set session => 'YAML';
Or in config.yml or environments/$env.yml
session: "YAML"
By default sessions are disabled, you must enable them before using it. If the session engine is disabled, any Dancer::Session call will throw an exception.
See "Configuration" in Dancer::Session::Abstract for more configuration options.
Route Handlers
When enabled, the session engine can be used in a route handler with the keyword session. This keyword allows you to store/retrieve values from the session by name.
Storing a value into the session:
session foo => 'bar';
Retrieving that value later:
my $foo = session 'foo';
You can either look for an existing item in the session storage or modify one. Here is a simple example of two route handlers that implement basic
/login
and/home
actions using the session engine.post '/login' => sub { # look for params and authenticate the user # ... if ($user) { session user_id => $user->id; } }; get '/home' => sub { # if a user is present in the session, let him go, otherwise redirect to # /login if (not session('user_id')) { redirect '/login'; } };
Of course, you probably don't want to have to duplicate the code to check whether the user is logged in for each route handler; there's an example in the Dancer::Cookbook showing how to use a before filter to check whether the user is logged in before all requests, and redirect to a login page if not.
SUPPORTED ENGINES
Dancer has a modular session engine that makes implementing new session backends pretty easy. If you'd like to write your own, feel free to take a look at Dancer::Session::Abstract.
The following engines are supported out-of-the-box (shipped with the core Dancer distribution):
- Dancer::Session::YAML
-
A YAML file-based session backend, pretty convenient for development purposes, but maybe not the best for production needs.
- Dancer::Session::Simple
-
A very simple session backend, holding all session data in memory. This means that sessions are volatile, and no longer exist when the process exits. This module is likely to be most useful for testing purposes, and of little use for production.
Additionally, many more session engines are available from CPAN, including:
- Dancer::Session::Memcached
-
Session are stored in Memcached servers. This is good for production matters and is a good way to use a fast, distributed session storage. If you may be scaling up to add additional servers later, this will be a good choice.
- Dancer::Session::Cookie
-
This module implements a session engine for sessions stored entirely inside encrypted cookies (this engine doesn't use a server-side storage).
- Dancer::Session::Storable
-
This backend stores sessions on disc using Storable, which offers solid performance and reliable serialization of various data structures.
- Dancer::Session::MongoDB
-
A backend to store sessions using MongoDB
- Dancer::Session::KiokuDB
-
A backend to store sessions using KiokuDB
- Dancer::Session::PSGI
-
Let Plack::Middleware::Session handle sessions; may be useful to share sessions between a Dancer app and other Plack-based apps.
DEPENDENCY
Dancer::Session may depend on third-party modules, depending on the session engine used. See the session engine module for details.
AUTHORS
This module has been written by Alexis Sukrieh. See the AUTHORS file that comes with this distribution for details.
LICENSE
This module is free software and is released under the same terms as Perl itself.
SEE ALSO
See Dancer for details about the complete framework.
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.
Module Install Instructions
To install Dancer, copy and paste the appropriate command in to your terminal.
cpanm Dancer
perl -MCPAN -e shell install Dancer
For more information on module installation, please visit the detailed CPAN module installation guide.