Dancer2::Core::Error

(source, CPAN)

version 2.1.0

NAME
VERSION
SYNOPSIS
DESCRIPTION
ATTRIBUTES
- show_stacktrace
- charset
- type
- title
- status
- message
- censor
METHODS
FUNCTIONS
AUTHOR
COPYRIGHT AND LICENSE

#NAME

Dancer2::Core::Error - Class representing fatal errors

#VERSION

version 2.1.0

#SYNOPSIS

use Dancer2::Core::Error;

my $error = Dancer2::Core::Error->new(
    status    => 404,
    message => "No such file: `$path'"
);

$error->throw;

#DESCRIPTION

With Dancer2::Core::Error you can throw reasonable-looking errors to the user instead of crashing the application and filling up the logs.

This is usually used in debugging environments, and it's what Dancer2 uses as well under debugging to catch errors and show them on screen.

#ATTRIBUTES

#show_stacktrace

#charset

#type

The error type.

#title

The title of the error page.

This is only an attribute getter, you'll have to set it at new.

#status

The status that caused the error.

This is only an attribute getter, you'll have to set it at new.

#message

The message of the error page.

#censor

The function to use to censor error messages. By default it uses the censor method of Data::Censor"

# default censor function used by `error_censor` 
# is equivalent to
sub MyApp::censor {
    Data::Censor->new(
       sensitive_fields => qr/pass|card.?num|pan|secret/i,
       replacement      => "Hidden (looks potentially sensitive)",
   )->censor(@_);
}
setting error_censor => 'MyApp::censor';

It can be configured via the app setting error_censor. If provided, error_censor has to be the fully qualified name of the censor function. That function is expected to take in the data as a hashref, modify it in place and return the number of items 'censored'.

For example, using Data::Censor.

# in config.yml
error_censor: MyApp::Censor::censor

# in MyApp::Censor
package MyApp::Censor;

use Data::Censor;

my $data_censor = Data::Censor->new(
    sensitive_fields => [ qw(card_number password hush) ],
    replacement => '(Sensitive data hidden)',
);

sub censor { $data_censor->censor(@_) }

1;

As a shortcut, error_censor can also be the key/value combo of a class and the arguments for its constructor. The created object is expected to have a method censor. For example, the use of Data::Censor above could also have been done via the config

error_censor:
    Data::Censor: 
        sensitive_fields:
            - card_number 
            - password 
            - hush 
        replacement: '(Sensitive data hidden)'

#METHODS

#my $error=new Dancer2::Core::Error(status => 404, message => "No such file: `$path'");

Create a new Dancer2::Core::Error object. For available arguments see ATTRIBUTES.

#supported_hooks ();

#throw($response)

Populates the content of the response with the error's information. If $response is not given, acts on the app attribute's response.

#backtrace

Show the surrounding lines of context at the line where the error was thrown.

This method tries to find out where the error appeared according to the actual error message (using the message attribute) and tries to parse it (supporting the regular/default Perl warning or error pattern and the Devel::SimpleTrace output) and then returns an error-highlighted message.

#environment

A main function to render environment information: the caller (using get_caller), the settings and environment (using dumper) and more.

#get_caller

Creates a stack trace of callers.

#FUNCTIONS

#_censor

An private function that tries to censor out content which should be protected.

dumper calls this method to censor things like passwords and such.

#my $string=_html_encode ($string);

Private function that replaces illegal entities in (X)HTML with their escaped representations.

html_encode() doesn't do any UTF black magic.

#dumper

This uses Data::Dumper to create nice content output with a few predefined options.

#AUTHOR

Dancer Core Developers

#COPYRIGHT AND LICENSE

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

CONTENTS