/ 
Dancer-1.1902
River stage three • 211 direct dependents • 215 total dependents
/ Dancer::ModuleLoader

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 evaling. 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\n";

Returns 1 if successful, 0 if not.

require

Runs a "require ModuleYouNeed".

use Dancer::ModuleLoader;
...
Dancer::ModuleLoader->require('Something')
    or die "Couldn't require Something\n";

If you are unsure what you need (require or load), learn the differences between require and use.

Returns 1 if successful, 0 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.