/ 
Catalyst-Action-RenderView-ErrorHandler-0.100161
River stage one • 1 direct dependent • 1 total dependent
/ Catalyst::Action::RenderView::ErrorHandler

NAME

Catalyst::Action::RenderView::ErrorHandler - Custom errorhandling in deployed applications

VERSION

version 0.100161

SYNOPSIS

sub end : ActionClass('RenderView::ErrorHandler') {}

DESCRIPTION

We all dread the Please come back later screen. Its uninformative, non- helpful, and in general an awfull default thing to do.

This module lets the developer configure what happens in case of emergency.

If you want the errors emailed to you? You can have it.
Want them logged somewhere as well? suresure, we will do it.
Custom errorpage that fits your design you say? Aw come on :)

CONFIGURATION AND ENVIRONMENT

We take our configuration from <$c-config->{'error_handler'}>>. If you do no configuration, the default is to look for the file 'root/static/error.html', and serve that as a static file. If all you want is to show a custom, static, error page, all you have to do is install the module and add it to your end action.

OPTIONS

actions

Is an array of actions you want taken. Each value should be an hashref with atleast the following keys:

type

Can be Log for builtin, or you can prefix it with a +, then we will use it as a fully qualified class name.

A typical example of an action one might want is Email, which could for instance use Catalyst::View::Email to send an email to the developers.

id

The id you want to have for this action

handlers

Configuration as to what to do when an error occurs. We always need to show something to the user, so thats a given. Each handler represents an error state, and a given handler can perform any given number of actions in addition to rendering or sending something to the browser/client.

HTTP status codes (404, 500 etc)
HTTP status code groups (4xx, 5xx etc)
"fallback" - default action taken on error.

The action is decided in that order.

template

Will be sent to your default_view for processing. Can use c.errors as needed

static

Will be read and served as a static file. This is the only option for fallback, since fallback will be used in case rendering a template failed for some reason.

If the given string begins with an '/', we treat it as an absolute path and try to read it directly. If not, we pass it trough <$c-path_to()>> to get an absolute path to read from.

EXAMPLE

error_handler:
    actions:
        # Note that Email is only provided here as an example, it does not
        # exist.
        - type: Email
          id: email-devel
          to: andreas@example.com
          subject: __MYAPP__ errors:
        - type: Log
          id: log-server
          level: error
    handlers:
        5xx:
            template: root/error/5xx.tt
            actions:
                - email-devel
                - log-server
        500:
            template: root/error/500.tt
            actions:
                - log-server
        fallback:
            static: root/static/error.html
            actions:
                - email-devel

INTERFACE

IMPLEMENTED METHODS

execute

Implemented to comply with Catalyst::Action interface.

It checks if there are errors, if not it it simply returns, assuming Catalyst::Action::RenderView has handled the job. If there are errors we parse the configuration and try to build our handlers.

Then it calls $self->handle.

METHODS

handle

Handles a request, by finding the propper handler.

Once a handler is found, it calls render if there are statics or templates, and then performs all actions (if any).

render

Given either a static file or a template, it will attempt to render it and send it to $context->res->body.

INHERITED METHODS

meta

Inherited from Moose

DEPENDENCIES

Catalyst::Action::RenderView

AUTHOR

Andreas Marienborg <andremar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Andreas Marienborg.

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