Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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)

Check Out this Related Man Page

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

NAME

       Dancer::Plugin - helper for writing Dancer plugins

DESCRIPTION

       Create plugins for Dancer

SYNOPSIS

	 package Dancer::Plugin::LinkBlocker;
	 use Dancer ':syntax';
	 use Dancer::Plugin;

	 register block_links_from => sub {
	   my $conf = plugin_setting();
	   my $re = join ('|', @{$conf->{hosts}});
	   before sub {
	       if (request->referer && request->referer =~ /$re/) {
		   status 403 || $conf->{http_code};
	       }
	   };
	 };

	 register_plugin;
	 1;

       And in your application:

	   package My::Webapp;

	   use Dancer ':syntax';
	   use Dancer::Plugin::LinkBlocker;

	   block_links_from; # this is exported by the plugin

PLUGINS

       You can extend Dancer by writing your own Plugin.

       A plugin is a module that exports a bunch of symbols to the current namespace (the caller will see all the symbols defined via "register").

       Note that you have to "use" the plugin wherever you want to use its symbols.  For instance, if you have Webapp::App1 and Webapp::App2, both
       loaded from your main application, they both need to "use FooPlugin" if they want to use the symbols exported by "FooPlugin".

   METHODS
       register
	   Lets you define a keyword that will be exported by the plugin.

	       register my_symbol_to_export => sub {
		   # ... some code
	       };

       register_plugin
	   A Dancer plugin must end with this statement. This lets the plugin register all the symbols define with "register" as exported symbols
	   (via the Exporter module).

	   A Dancer plugin inherits from Dancer::Plugin and Exporter transparently.

       plugin_setting
	   Configuration for plugin should be structured like this in the config.yml of the application:

	     plugins:
	       plugin_name:
		 key: value

	   If "plugin_setting" is called inside a plugin, the appropriate configuration will be returned. The "plugin_name" should be the name of
	   the package, or, if the plugin name is under the Dancer::Plugin:: namespace (which is recommended), the remaining part of the plugin
	   name.

	   Enclose the remaining part in quotes if it contains ::, e.g.  for Dancer::Plugin::Foo::Bar, use:

	     plugins:
	       "Foo::Bar":
		 key: value

AUTHORS

       This module has been written by Alexis Sukrieh and others.

LICENSE

       This module is free software and is published under the same terms as Perl itself.

perl v5.14.2							    2011-11-30						       Dancer::Plugin(3pm)
Man Page