.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Dancer::Plugin::FlashMessage 3pm"
.TH Dancer::Plugin::FlashMessage 3pm "2015-06-01" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Dancer::Plugin::FlashMessage \- Dancer plugin to display temporary messages, so called "flash messages".
.SH "VERSION"
.IX Header "VERSION"
version 0.314
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin helps you display temporary messages, so called \*(L"flash messages\*(R".
It provides a \f(CW\*(C`flash()\*(C'\fR method to define the message. The plugin then takes
care of attaching the content to the session, propagating it to the templating
system, and then removing it from the session.
.PP
However, it's up to you to have a place in your views or layout where the
message will be displayed. But that's not too hard (see \s-1SYNOPSYS\s0).
.PP
Basically, the plugin gives you access to the 'flash' hash in your views. It
can be used to display flash messages.
.PP
By default, the plugin works using a decent configuration. However, you can
change the behaviour of the plugin. See \s-1CONFIGURATION\s0
.SH "NAME"
Dancer::Plugin::FlashMessage \- A plugin to display "flash messages" : short temporary messages
.SH "SYNOPSYS"
.IX Header "SYNOPSYS"
Example with Template Toolkit
.PP
In your configuration, make sure you have session configured. Of course you can
use any session engine :
.PP
.Vb 1
\&  session: "simple"
.Ve
.PP
In your index.tt view or in your layout :
.PP
.Vb 3
\&  <% IF flash.error %>
\&    <div class=error> <% flash.error %> </div>
\&  <% END %>
.Ve
.PP
In your css :
.PP
.Vb 2
\&  .error { background: #CEE5F5; padding: 0.5em;
\&           border: 1px solid #AACBE2; }
.Ve
.PP
In your Dancer App :
.PP
.Vb 1
\&  package MyWebService;
\&
\&  use Dancer;
\&  use Dancer::Plugin::FlashMessage;
\&
\&  get \*(Aq/hello\*(Aq => sub {
\&      flash error => \*(AqError message\*(Aq;
\&      template \*(Aqindex\*(Aq;
\&  };
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "flash"
.IX Subsection "flash"
.Vb 2
\&  # sets the flash message for the warning key
\&  flash warning => \*(Aqsome warning message\*(Aq;
\&
\&  # retrieves and removes the flash message for the warning key
\&  my $warning_message = flash \*(Aqwarning\*(Aq;
.Ve
.PP
This method can take 1 or 2 parameters. When called with two parameters, it
sets the flash message for the given key.
.PP
When called with one parameter, it returns the value of the flash message of
the given key. The message is deleted from the flash hash in the session.
.PP
In both cases, \f(CW\*(C`flash\*(C'\fR always returns the value;
.SH "IN YOUR TEMPLATE"
.IX Header "IN YOUR TEMPLATE"
After having set a flash message using \f(CW\*(C`flash\*(C'\fR in your Dancer route, you can
access the flash message from within your template. The plugin provides you
with the \f(CW\*(C`flash\*(C'\fR hashref, that you can access in your template, for example
like this :
.PP
.Vb 1
\&  <div class=error> <% flash.error %> </div>
.Ve
.PP
When you use it in your template, the flash message is deleted. So next
time, \f(CW\*(C`flash.error\*(C'\fR will not exist.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
With no configuration whatsoever, the plugin will work fine, thus contributing
to the \fIkeep it simple\fR motto of Dancer.
.SS "configuration default values"
.IX Subsection "configuration default values"
These are the default values. See below for a description of the keys
.PP
.Vb 4
\&  plugins:
\&    FlashMessage:
\&      token_name: flash
\&      session_hash_key: _flash
.Ve
.SS "configuration description"
.IX Subsection "configuration description"
.IP "token_name" 4
.IX Item "token_name"
The name of the template token that will contain the hash of flash messages.
\&\fBDefault\fR : \f(CW\*(C`flash\*(C'\fR
.IP "session_hash_key" 4
.IX Item "session_hash_key"
You probably don't need that, but this setting allows you to change the name of
the session key used to store the hash of flash messages. It may be useful in
the unlikely case where you have key name conflicts in your session. \fBDefault\fR :
\&\f(CW\*(C`_flash\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This software is copyright (c) 2011 by Damien \*(L"dams\*(R" Krotkine <dams@cpan.org>.
.SH "LICENCE"
.IX Header "LICENCE"
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "AUTHORS"
.IX Header "AUTHORS"
This module has been written by Damien \*(L"dams\*(R" Krotkine <dams@cpan.org>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Dancer
.SH "AUTHOR"
.IX Header "AUTHOR"
Damien \*(L"dams\*(R" Krotkine
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Damien \*(L"dams\*(R" Krotkine.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.