dancer::object(3pm) [debian man page]

Dancer::Object(3pm)					User Contributed Perl Documentation				       Dancer::Object(3pm)

NAME

       Dancer::Object - Objects base class for Dancer

SYNOPSIS

	   package My::Dancer::Extension;

	   use strict;
	   use warnings;
	   use base 'Dancer::Object';

	   __PACKAGE__->attributes( qw/name value this that/ );

	   sub init {
	       # our initialization code, if we need one
	   }

DESCRIPTION

       While we love Moose, we can't use it for Dancer and still keep Dancer minimal, so we wrote Dancer::Object instead.

       It provides you with attributes and an initializer.

METHODS

   new
       Creates a new object of whatever is based off Dancer::Object. This is a generic "new" method so you don't have to write one yourself when
       extending "Dancer::Object".

       It accepts arguments in a hash and runs an additional "init" method (described below) which you should implement.

   init
       Exists but does nothing. This is so you won't have to write an initializer if you don't want to.

   clone
       Creates and returns a clone of the object using Clone, which is loaded dynamically. If we cannot load Clone, we throw an exception.

   get_attributes
       Get the attributes of the specific class.

   attributes
       Generates attributes for whatever object is extending Dancer::Object and saves them in an internal hashref so they can be later fetched
       using "get_attributes".

       For each defined attribute you can access its value using:

	 $self->your_attribute_name;

       To set a value use

	 $self->your_attribute_name($value);

       Nevertheless, you can continue to use these attributes as hash keys, as usual with blessed hash references:

	 $self->{your_attribute_name} = $value;

       Although this is possible we defend you should use the method approach, as it maintains compatibility in case "Dancer::Object" structure
       changes in the future.

   attributes_defaults
	 $self->attributes_defaults(length => 2);

       given a hash (not a hashref), makes sure an object has the given attributes default values. Usually called from within an "init" function.

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-30						       Dancer::Object(3pm)

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)