dancer::fileutils(3pm) [debian man page]
Dancer::FileUtils(3pm) User Contributed Perl Documentation Dancer::FileUtils(3pm)
NAME
Dancer::FileUtils - helper providing file utilities
SYNOPSIS
use Dancer::FileUtils qw/dirname path/;
# for 'path/to/file'
my $dir = dirname($path); # returns 'path/to'
my $path = path($path); # returns '/abs/path/to/file'
use Dancer::FileUtils qw/path read_file_content/;
my $content = read_file_content( path( 'folder', 'folder', 'file' ) );
my @content = read_file_content( path( 'folder', 'folder', 'file' ) );
use Dancer::FileUtils qw/read_glob_content set_file_mode/;
open my $fh, '<', $file or die "$!
";
set_file_mode($fh);
my @content = read_file_content($fh);
my $content = read_file_content($fh);
DESCRIPTION
Dancer::FileUtils includes a few file related utilities related that Dancer uses internally. Developers may use it instead of writing their
own file reading subroutines or using additional modules.
SUBROUTINES
/METHODS
dirname
use Dancer::FileUtils 'dirname';
my $dir = dirname($path);
Exposes File::Basename's dirname, to allow fetching a directory name from a path. On most OS, returns all but last level of file path. See
File::Basename for details.
open_file
use Dancer::FileUtils 'open_file';
my $fh = open_file('<', $file) or die $message;
Calls open and returns a filehandle. Takes in account the 'charset' setting from Dancer's configuration to open the file in the proper
encoding (or defaults to utf-8 if setting not present).
path
use Dancer::FileUtils 'path';
my $path = path( 'folder', 'folder', 'filename');
Provides comfortable path resolving, internally using File::Spec.
read_file_content
use Dancer::FileUtils 'read_file_content';
my @content = read_file_content($file);
my $content = read_file_content($file);
Returns either the content of a file (whose filename is the input), undef if the file could not be opened.
In array context it returns each line (as defined by $/) as a separate element; in scalar context returns the entire contents of the file.
read_glob_content
use Dancer::FileUtils 'read_glob_content';
open my $fh, '<', $file or die "$!
";
my @content = read_glob_content($fh);
my $content = read_glob_content($fh);
Same as read_file_content, only it accepts a file handle. Returns the content and closes the file handle.
set_file_mode
use Dancer::FileUtils 'set_file_mode';
set_file_mode($fh);
Applies charset setting from Dancer's configuration. Defaults to utf-8 if no charset setting.
EXPORT
Nothing by default. You can provide a list of subroutines to import.
AUTHOR
Alexis Sukrieh
LICENSE AND COPYRIGHT
Copyright 2009-2011 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-01-27 Dancer::FileUtils(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)