Stefan Profanter > Catalyst-Action-RenderView-ErrorHandler-0.100165 > Catalyst::Action::RenderView::ErrorHandler

Download:
Catalyst-Action-RenderView-ErrorHandler-0.100165.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.100165   Source   Latest Release: Catalyst-Action-RenderView-ErrorHandler-0.100166

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

enable

If this is true, we will act even in debug mode. Great for getting debug logs AND error-handler templates rendered.

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.

The most excellent Stefan Profanter wrote Catalyst::Action::RenderView::ErrorHandler::Action::Email, which lets you send templated emails on errors.

id

The id you want to have for this action

ignorePath

Optional. If this Regex matches $c->request->path nothing will be logged. Useful if you want ot exclude a request path from logging/emailing a 404 error (eg. there are some bad hackers who try to break into your system by searching PhpMyAdmin. If you don't use it, you can exclude it and you get no mails). The regex is used with ignore-case and the delimiter is '|'

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:
            # Check out
            # L<Catalyst::Action::RenderView::ErrorHandler::Action::Email> if
            # you want to send email from an action
            - type: Email
              id: email-devel
              ignorePath: '(PhpMyAdmin|SqlDump)'
              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

SEE ALSO ^

Catalyst::Action::RenderView::ErrorHandler::Action::Email

Thanks ^

zdk https://github.com/zdk
Stefan Profanter https://metacpan.org/author/PROFANTER
syntax highlighting: