• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• ATTRIBUTES
  • show_errors
  • charset
  • type
  • title
  • status
  • message
• METHODS
  • my $error=new Dancer2::Core::Error(status => 404, message => "No such file: `$path'");
  • supported_hooks ();
  • throw($response)
  • backtrace
  • environment
  • get_caller
• FUNCTIONS
  • _censor
  • my $string=_html_encode ($string);
  • dumper
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

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

VERSION

version 0.301002

SYNOPSIS

    # taken from send_file:
    use Dancer2::Core::Error;

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

    Dancer2::Core::Response->set($error->render);

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_errors

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.

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 software is copyright (c) 2021 by Alexis Sukrieh.

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

                    cpanm Dancer2
                

                    perl -MCPAN -e shell
                    install Dancer2