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)

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)