NAME

Catalyst::Plugin::Message - The great new Catalyst::Plugin::Message!

VERSION

Version 0.03

SYNOPSIS

 # in your controller
 use Catalyst qw/Message/;
 sub register : Local {
     my ( $self, $c ) = @_;
     if ( $c->req->method eq 'POST' ){
        my $email = $c->req->param('email');
        $c->errmsg( email => 'email can not be empty.' ) unless defined $email;
        $c->errmsg( email => 'email invalid.' ) unless $email =~ /\@/;
        if ( not $c->errmsg ){
                # save data
        }
     }
     $c->stash->{'template'} = 'register.tpl';
 }

 # register.tpl
 [% errmsg.email %]

errmsg

pass some error message return to the previous page, every message has a key to indicate which aspect.

you can make more error messages relate to a key, only the first message will save into stash.

tipmsg

same as errmsg, just make some tips message return.

diemsg

 # in your controller
 use Catalyst qw/Message/;
 sub edit : Local {
     my ( $self, $c ) = @_;
     my $client_id = $c->req->param('client_id');
     my $client = $c->model('DBIC::Client')->find( $client_id );
     $c->diemsg( "client not found with id: %s", $client_id ) unless $client;

         # continue when $client object is valid
         # ...
         
     $c->stash->{'template'} = 'edit.tpl';
 }

 # error.tpl
 [% diemsg %]

Sometimes the fatal error occurs, which means we cannot continue to execute the rest code, and we wanner just raise the error to the client. For example as above, if the $client object not exists, maybe the parameter client_id invalid or the client has been deleted, then we need tell that what happened, but the internal $c->error simple save the error informations into stash and continue rest codes - of course we can use if-else to let it work, but why should we make it simple, just like native die() did? Here diemsg() comes, and the error information is a business logic, but not code logic, so we need not show the req-res-stash to user. Just tell your user what happend, and make them understand what's the point. :)

AUTHOR

Chunzi, <chunzi at cpan.org>

BUGS

Please report any bugs or feature requests to bug-catalyst-plugin-message at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Plugin-Message. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Catalyst::Plugin::Message

You can also look for information at:

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Catalyst-Plugin-Message

• CPAN Ratings

  http://cpanratings.perl.org/d/Catalyst-Plugin-Message

• RT: CPAN's request tracker

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Plugin-Message

• Search CPAN

  http://search.cpan.org/dist/Catalyst-Plugin-Message

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2006 Chunzi, all rights reserved.

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