-
-
29 Jan 2020 21:03:12 UTC
- Distribution: Dancer
- Module version: 1.3513
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (3225 / 18 / 0)
- Kwalitee
Bus factor: 4- 86.23% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (382.32KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 182 contributors- Dancer Core Developers
-
1nickt
-
a-adam
-
Achim Adam
-
Adam J. Foxson
-
Adam Kennedy
-
Akash Ayare
-
alambike
-
Alan Haggai Alavi
-
Alberto Simoes
-
Alessandro Ranellucci
-
Alex C
-
Alexis Sukrieh
-
Alex Kalderimis
-
Alex Kapranoff
-
Alex Peters
-
Alfie John
-
Al Newkirk
-
Andrew Beverley
-
andy
-
Anirvan Chatterjee
-
Anton Gerasimov
-
asergei
-
Ashley Willis
-
A. Sinan Unur
-
Ask Bjørn Hansen
-
Assaf Gordon
-
Ben Hutton
-
Bernhard Reutner-Fischer
-
boris shomodjvarac
-
Brad Macpherson
-
Breno G. de Oliveira
-
Brian E. Lozier
-
Brian Hann
-
Brian Phillips
-
burnersk
-
Chris Andrews
-
chrisjrob
-
Chris Seymour
-
Christian Walde
-
chromatic
-
Colin Keith
-
Colin Kuskie
-
CPAN Service
-
Craig Treptow
-
Dagfinn Ilmari Mannsåker
-
Damien Krotkine
-
Damyan Ivanov
-
Dan Book
-
Danijel Tasov
-
Dave Doyle
-
David Cantrell
-
David Golden
-
David Moreno
-
David Steinbrunner
-
David Zurborg
-
Dennis Lichtenthaeler
-
Duncan Hutty
-
Emmanuel Rodriguez
-
Fabrice Gabolde
-
Fayland Lam
-
Felix Dorner
-
Flavio Poletti
-
Florian Larysch
-
Florian Sojer
-
Franck Cuny
-
François Charlier
-
Gabor Szabo
-
Gary Mullen
-
geistteufel
-
Gil Magno
-
Gonzalo Barco
-
Graham Knop
-
Grzegorz Rożniecki
-
Hagen Fuchs
-
Hans Dieter Pearcey
-
Ilmari Vacklin
-
Ilya Chesnokov
-
isync
-
Ivan Bessarabov
-
Ivan Paponov
-
Jacob Rideout
-
Jakob Voss
-
James Aitken
-
jamhed
-
Jess
-
Jesse van Herk
-
Jochen Lutz
-
Joel Roth
-
John Barrett
-
John Wittkoski
-
jonasreinsch
-
Jonathan "Duke" Leto
-
Jonathan Hall
-
Jonathan Otsuka
-
jonathan schatz
-
Jonathan Scott Duff
-
Joshua Barratt
-
JT Smith
-
Juan J. Martínez
-
Jury Gorky
-
Kaitlyn Parkhurst
-
Kent Fredric
-
Kirk Kimmel
-
Lars Thegler
-
Lee Carmichael
-
Lee Johnson
-
Manuel Weiss
-
Marc Chantreux
-
Mark Allen
-
Mark A. Stratman
-
Mark Stosberg
-
Martin Schut
-
Matthew Horsfall (alh)
-
Maurice
-
Maxim Ivanov
-
Max Maischein
-
Michael Genereux
-
Michael G. Schwern
-
Michal Wojciechowski
-
Mikolaj Kucharski
-
miyagawa
-
mlbarrow
-
Mohammad S Anwar
-
Murray
-
Natal Ngétal
-
Nate Jones
-
Naveed Massjouni
-
Naveed
-
Naveen
-
Neil Hooey
-
Nick Tonkin
-
Nicolas Oudard
-
niko
-
Nuno Carvalho
-
Oliver Gorwits
-
Olivier Mengué
-
Olof Johansson
-
Ovid
-
Paul Driver
-
Paul Fenwick
-
Paul Johnson
-
Paul Tomlin
-
pdl
-
Pedro Melo
-
Perlover
-
Phil Carmody
-
Philippe Bruhat (BooK)
-
ppisar
-
Richard Simões
-
Rick Myers
-
Rik Brown
-
Roberto Patriarca
-
Roman Galeev
-
Roman Nuritdinov
-
Rowan Thorpe
-
Russell Jenkins
-
Sam Kington
-
Sapphire Paw
-
Sawyer X
-
scoopio
-
Scott Penrose
-
sdeseille
-
Sean Smith
-
Sebastian de Castelberg
-
Skeeve
-
Slaven Rezic
-
Sniperovitch
-
Squeeks
-
Stefan Hornburg (Racke)
-
Steve Hay
-
Tatsuhiko Miyagawa
-
tednolan
-
Tim King
-
Tom Heady
-
Tom Hukins
-
Tom Wyant
-
Vyacheslav Matyukhin
-
William Wolf
-
Yanick Champoux
- YOUR_NAME <YOUR_EMAIL>
-
Zefram
- Dependencies
- Carp
- Cwd
- Data::Dumper
- Encode
- Exporter
- Fcntl
- File::Basename
- File::Copy
- File::Path
- File::Spec
- File::Spec::Functions
- File::Temp
- File::stat
- FindBin
- Getopt::Long
- HTTP::Body
- HTTP::Date
- HTTP::Headers
- HTTP::Server::Simple::PSGI
- HTTP::Tiny
- Hash::Merge::Simple
- IO::File
- MIME::Types
- Module::Runtime
- POSIX
- Pod::Usage
- Scalar::Util
- Test::Builder
- Test::More
- Time::HiRes
- Try::Tiny
- URI
- URI::Escape
- base
- bytes
- constant
- lib
- overload
- parent
- strict
- vars
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Dancer::Plugin - helper for writing Dancer plugins
VERSION
version 1.3513
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
DESCRIPTION
Create plugins for Dancer
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 touse FooPlugin
if they want to use the symbols exported byFooPlugin
.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.
- register_hook
-
Allows a plugin to declare a list of supported hooks. Any hook declared like so can be executed by the plugin with
execute_hooks
.register_hook 'foo'; register_hook 'foo', 'bar', 'baz';
- execute_hooks
-
Allows a plugin to execute the hooks attached at the given position
execute_hooks 'some_hook';
The hook must have been registered by the plugin first, with
register_hook
. - 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. Theplugin_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
- plugin_args
-
To easy migration and interoperability between Dancer 1 and Dancer 2 you can use this method to obtain the arguments or parameters passed to a plugin-defined keyword. Although not relevant for Dancer 1 only, or Dancer 2 only, plugins, it is useful for universal plugins.
register foo => sub { my ($self, @args) = plugin_args(@_); ... }
Note that Dancer 1 will return undef as the object reference.
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.
AUTHOR
Dancer Core Developers
COPYRIGHT AND LICENSE
This software is copyright (c) 2010 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.
Module Install Instructions
To install Dancer, copy and paste the appropriate command in to your terminal.
cpanm Dancer
perl -MCPAN -e shell install Dancer
For more information on module installation, please visit the detailed CPAN module installation guide.