Revision 4a663bf8
Von Tamino Steinert vor 7 Tagen hinzugefügt
| SL/Helper/Flash.pm | ||
|---|---|---|
|
require Exporter;
|
||
|
our @ISA = qw(Exporter);
|
||
|
our @EXPORT = qw(flash flash_later);
|
||
|
our @EXPORT_OK = qw(render_flash delay_flash);
|
||
|
our @EXPORT_OK = qw(delay_flash);
|
||
|
|
||
|
my %valid_categories = (
|
||
|
map({$_ => 'info'} qw(information message)),
|
||
| ... | ... | |
|
$::auth->set_session_value({ key => "FLASH", value => _store_flash($::auth->get_session_value('FLASH'), @_), auto_restore => 1 });
|
||
|
}
|
||
|
|
||
|
sub delay_flash {
|
||
|
my $store = $::form->{FLASH} || { };
|
||
|
flash_later($_ => @{ $store->{$_} || [] }) for keys %$store;
|
||
|
sub flash_contents {
|
||
|
return unless $::form;
|
||
|
return unless $::form->{FLASH};
|
||
|
return unless 'ARRAY' eq ref $::form->{FLASH};
|
||
|
|
||
|
@{ $::form->{FLASH} }
|
||
|
}
|
||
|
|
||
|
sub render_flash {
|
||
|
return $::form->parse_html_template('common/flash');
|
||
|
sub delay_flash {
|
||
|
my $store = $::form->{FLASH} || [];
|
||
|
flash_later(@{ $_ || [] }) for @$store;
|
||
|
}
|
||
|
|
||
|
#
|
||
| ... | ... | |
|
#
|
||
|
|
||
|
sub _store_flash {
|
||
|
my $store = shift || { };
|
||
|
my $category = _check_category(+shift);
|
||
|
my ($store, $type, $message, $details, $timestamp) = @_;
|
||
|
$store //= [ ];
|
||
|
$timestamp //= time();
|
||
|
my $category = _check_category($type);
|
||
|
|
||
|
$store->{ $category } ||= [ ];
|
||
|
push @{ $store->{ $category } }, @_;
|
||
|
push @{ $store }, [ $type, $message, $details, $timestamp ];
|
||
|
|
||
|
return $store;
|
||
|
}
|
||
| ... | ... | |
|
|
||
|
=head1 SYNOPSIS
|
||
|
|
||
|
use SL::Helper::Flash qw(flash flash_later delay_flash);
|
||
|
|
||
|
# display in this request
|
||
|
flash('info', 'Customer saved!');
|
||
|
flash('error', 'Something went wrong', "details about what went wrong");
|
||
|
flash('warning', 'this might not be a good idea');
|
||
|
|
||
|
# display after a redirect
|
||
|
flash_later('info', 'Customer saved!');
|
||
|
flash_later('error', 'Something went wrong', "details about what went wrong");
|
||
|
flash_later('warning', 'this might not be a good idea');
|
||
|
|
||
|
# delay flash() calls to next request:
|
||
|
delay_flash();
|
||
|
|
||
|
=head1 DESCRIPTION
|
||
|
|
||
|
The flash is a store for messages that should be displayed to the
|
||
|
user. Each message has a category which is usually C<information>,
|
||
|
C<warning> or C<error>. The messages in each category are grouped and
|
||
|
displayed in colors appropriate for their severity (e.g. errors in
|
||
|
red).
|
||
|
|
||
|
Messages are rendered either by calling the function C<render_flash>
|
||
|
or by including the flash sub-template from a template with the
|
||
|
following code:
|
||
|
|
||
|
[%- INCLUDE 'common/flash.html' %]
|
||
|
Messages are rendered by including the L<SL::Layout::Flash> sub layout.
|
||
|
|
||
|
=head1 EXPORTS
|
||
|
|
||
|
The functions L</flash> and L</flash_later> are always exported.
|
||
|
|
||
|
The function L</render_flash> is only exported upon request.
|
||
|
|
||
|
=head1 FUNCTIONS
|
||
|
|
||
|
=over 4
|
||
|
|
||
|
=item C<flash $category, @messages>
|
||
|
=item C<flash $category, $message [, $details ]>
|
||
|
|
||
|
Stores messages for the given category. The category can be either
|
||
|
C<information>, C<warning> or C<error>. C<info> can also be used as an
|
||
|
alias for C<information>.
|
||
|
Store a message with optional details for the given category. The category can
|
||
|
be either C<information>, C<warning> or C<error>. C<info> can also be used as
|
||
|
an alias for C<information>.
|
||
|
|
||
|
=item C<flash_later $category, @messages>
|
||
|
=item C<flash_later $category, $message [, $details ]>
|
||
|
|
||
|
Stores messages for the given category for the next request. The
|
||
|
category can be either C<information>, C<warning> or C<error>. C<info>
|
||
|
can also be used as an alias for C<information>.
|
||
|
Store a message with optional details for the given category for the next
|
||
|
request. The category can be either C<information>, C<warning> or C<error>.
|
||
|
C<info> can also be used as an alias for C<information>.
|
||
|
|
||
|
The messages are stored in the user's session and restored upon the
|
||
|
The message is stored in the user's session and restored upon the
|
||
|
next request. Can be used for transmitting information over HTTP
|
||
|
redirects.
|
||
|
|
||
|
=item C<render_flash>
|
||
|
|
||
|
Outputs the flash message by parsing the C<common/flash.html> template
|
||
|
file.
|
||
|
|
||
|
This function is not exported by default.
|
||
|
|
||
|
=item C<delay_flash>
|
||
|
|
||
|
Delays flash, as if all flash messages in this request would have been
|
||
| ... | ... | |
|
|
||
|
Not exported by default.
|
||
|
|
||
|
=item C<flash_contents>
|
||
|
|
||
|
The contents of the current flash accumulator.
|
||
|
|
||
|
=back
|
||
|
|
||
|
=head1 AUTHOR
|
||
Auch abrufbar als: Unified diff
SL::Layout::Flash: fliegende Flash-Meldungen (portiert von Odyn)