Franck Cuny > Dancer-1.1902 > Dancer::FileUtils

Download:
Dancer-1.1902.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source   Latest Release: Dancer-1.3130

NAME ^

Dancer::FileUtils - helper providing file utilities

SYNOPSIS ^

    use Dancer::FileUtils qw/path read_file_content/;

    my $content = read_file_content( path( 'folder', 'folder', 'file' ) );

DESCRIPTION ^

Dancer::FileUtils encompasses a few utilities that relate to files which Dancer uses. Developers may use it instead of writing their own little subroutines or use additional modules.

SUBROUTINES/METHODS ^

path

    use Dancer::FileUtils 'path';

    my $path = path( 'folder', 'folder', 'filename');

Provides comfortable path resolving, internally using File::Spec.

dirname

    use Dancer::FileUtils 'dirname';

    my $dir = dirname($path);

Exposes File::Basename's dirname, to allow fetching a directory name from a path.

read_file_content

    use Dancer::FileUtils 'read_file_content';

    my $content = read_file_content($file);

Returns either the content of a file (whose filename is the input) or undef in case it failed to open the file.

read_glob_content

    use Dancer::FileUtils 'read_glob_content';

    open my $fh, '<', $file or die "$!\n";
    my $content = read_glob_content($fh);

Same as read_file_content, only it accepts a file handler.

Returns the content and closes the file handler.

EXPORT ^

Nothing by default. You can provide a list of subroutines to import.

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.

syntax highlighting: