dancer::error(3pm) [debian man page]
Dancer::Error(3pm) User Contributed Perl Documentation Dancer::Error(3pm)
NAME
Dancer::Error - class for representing fatal errors
SYNOPSIS
# taken from send_file:
use Dancer::Error;
my $error = Dancer::Error->new(
code => 404,
message => "No such file: `$path'"
);
Dancer::Response->set($error->render);
DESCRIPTION
With Dancer::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 Dancer uses as well under debugging to catch errors and show them on screen.
ATTRIBUTES
code
The code that caused the error.
This is only an attribute getter, you'll have to set it at "new".
title
The title of the error page.
This is only an attribute getter, you'll have to set it at "new".
message
The message of the error page.
This is only an attribute getter, you'll have to set it at "new".
exception
The exception that caused the error. If the error was not caused by an exception, returns undef. Exceptions are usually objects that
inherits of Dancer::Exception.
This is only an attribute getter, you'll have to set it at "new".
METHODS
/SUBROUTINES
new
Create a new Dancer::Error object.
title
The title of the error page.
type
What type of error this is.
code
The code that caused the error.
message
The message that will appear to the user.
exception
The exception that will be useable by the rendering.
backtrace
Create a backtrace of the code where the error is caused.
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-
higlighted "message".
tabulate
Small subroutine to help output nicer.
dumper
This uses Data::Dumper to create nice content output with a few predefined options.
render
Renders a response using Dancer::Response.
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 strack trace of callers.
_censor
An internal method that tries to censor out content which should be protected.
"dumper" calls this method to censor things like passwords and such.
_html_encode
Internal method to encode entities that are illegal in (X)HTML. We output as UTF-8, so no need to encode all non-ASCII characters or use a
module. FIXME : this is not true anymore, output can be any charset. Need fixing.
AUTHOR
Alexis Sukrieh
LICENSE AND COPYRIGHT
Copyright 2009-2010 Alexis Sukrieh.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as
published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
perl v5.14.2 2012-03-31 Dancer::Error(3pm)
Check Out this Related Man Page
Dancer::ModuleLoader(3pm) User Contributed Perl Documentation Dancer::ModuleLoader(3pm)
NAME
Dancer::ModuleLoader - dynamic module loading helpers for Dancer core components
SYNOPSIS
Taken directly from Dancer::Template::TemplateToolkit (which is core):
die "Template is needed by Dancer::Template::TemplateToolkit"
unless Dancer::ModuleLoader->load('Template');
# we now have Template loaded
DESCRIPTION
Sometimes in Dancer core we need to use modules, but we don't want to declare them all in advance in compile-time. These could be because
the specific modules provide extra features which depend on code that isn't (and shouldn't) be in core, or perhaps because we only want
these components loaded in lazy style, saving loading time a bit. For example, why load Template (which isn't required by Dancer) when you
don't use Dancer::Template::TemplateToolkit?
To do such things takes a bit of code for localizing $@ and "eval"ing. That code has been refactored into this module to help Dancer core
developers.
Please only use this for Dancer core modules. If you're writing an external Dancer module (Dancer::Template::Tiny, Dancer::Session::Cookie,
etc.), please simply ""use ModuleYouNeed"" in your code and don't use this module.
METHODS
/SUBROUTINES
load
Runs a ""use ModuleYouNeed"".
use Dancer::ModuleLoader;
...
Dancer::ModuleLoader->load('Something')
or die "Couldn't load Something
";
# load version 5.0 or more
Dancer::ModuleLoader->load('Something', '5.0')
or die "Couldn't load Something
";
# load version 5.0 or more
my ($res, $error) = Dancer::ModuleLoader->load('Something', '5.0');
$res or die "Couldn't load Something : '$error'
";
Takes in arguments the module name, and optionally the minimum version number required.
In scalar context, returns 1 if successful, 0 if not. In list context, returns 1 if successful, "(0, "error message")" if not.
If you need to give argumentto the loading module, please use the method "load_with_params"
require
Runs a ""require ModuleYouNeed"".
use Dancer::ModuleLoader;
...
Dancer::ModuleLoader->require('Something')
or die "Couldn't require Something
";
my ($res, $error) = Dancer::ModuleLoader->require('Something');
$res or die "Couldn't require Something : '$error'
";
If you are unsure what you need ("require" or "load"), learn the differences between "require" and "use".
Takes in arguments the module name.
In scalar context, returns 1 if successful, 0 if not. In list context, returns 1 if successful, "(0, "error message")" if not.
load_with_params
Runs a ""use ModuleYouNeed qw(param1 param2 ...)"".
use Dancer::ModuleLoader;
...
Dancer::ModuleLoader->load('Something', qw(param1 param2) )
or die "Couldn't load Something
";
my ($res, $error) = Dancer::ModuleLoader->load('Something', @params);
$res or die "Couldn't load Something : '$error'
";
Takes in arguments the module name, and optionally parameters to pass to the import internal method.
In scalar context, returns 1 if successful, 0 if not. In list context, returns 1 if successful, "(0, "error message")" if not.
use_lib
Runs a ""use lib qw(path1 path2)"" at run time instead of compile time.
use Dancer::ModuleLoader;
...
Dancer::ModuleLoader->use_lib('path1', @other_paths)
or die "Couldn't perform use lib
";
my ($res, $error) = Dancer::ModuleLoader->use_lib('path1', @other_paths);
$res or die "Couldn't perform use lib : '$error'
";
Takes in arguments a list of path to be prepended to @INC, in a similar way than "use lib". However, this is performed at run time, so the
list of paths can be generated and dynamic.
In scalar context, returns 1 if successful, 0 if not. In list context, returns 1 if successful, "(0, "error message")" if not.
class_from_setting
Given a setting in Dancer::Config, composes the class it should be.
This is the function that translates:
# in config.yaml
template: "template_toolkit"
To the class:
Dancer::Template::TemplateToolkit
Example:
use Dancer::ModuleLoader;
my $class = Dancer::ModuleLoader->class_from_setting(
'Dancer::Template' => 'template_toolkit',
);
# $class == 'Dancer::Template::TemplateToolkit
$class = Dancer::ModuleLoader->class_from_setting(
'Dancer::Template' => 'tiny',
);
# class == 'Dancer::Template::Tiny
AUTHOR
Alexis Sukrieh
LICENSE AND COPYRIGHT
Copyright 2009-2010 Alexis Sukrieh.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as
published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
perl v5.14.2 2011-11-26 Dancer::ModuleLoader(3pm)