template::plugin::datetime::format(3pm) [debian man page]

Template::Plugin::DateTime::Format(3pm) 		User Contributed Perl Documentation		   Template::Plugin::DateTime::Format(3pm)

NAME

       Template::Plugin::DateTime::Format - format DateTime objects from inside TT with "DateTime::Format"-style formatters

VERSION

       version 0.02

SYNOPSIS

	  [% USE f = DateTime::Format('DateTime::Format::Strptime', { pattern => "%T" }) %]
	  [% f.format(datetime_object) %]

DESCRIPTION

       Oftentimes, you have a DateTime object that you want to render in your template.  However, the default rendering (2008-01-01T01:23:45) is
       pretty ugly.  Formatting the DateTime with a DateTime::Format object is the usual solution, but there's usually not a nice place to put the
       formatting code.

       This plugin solves that problem.  You can create a formatter object from within TT and then use that object to format DateTime objects.

   CREATING AN OBJECT
       Creating a formatter instance is done in the usual TT way:

	 [% USE varname = DateTime::Format( ... args ... ) %]

       This creates a new formatter and calls it "varname".

       The constructor takes up to three arguments.  The first argument is the name of the formatter class.  It is required, and the named class
       must follow the DateTime::Format API.  An exception will be thrown if the class cannot be loaded.

       The second argument is a reference to pass to the formatter's constructor.  If it is an array reference, the array will be dereferenced
       before being passed to "new" as @_.  Otherwise, the single reference is passed to the constructor.

       The third argument is optional and is the rest of @_ to pass to "format_datetime" after the DateTime object.  I don't know if this is
       actually allowed by the API, but I figured it might come in handy.

   FORMATTING DATES
       Once you've created the object, invoke the "format" method with the DateTime object you'd like to format.  The result of "format_datetime"
       is returned.

METHODS

   new
       Called by TT to create a new formatter.

   format($datetime)
       Formats $datetime.

AUTHOR

       Jonathan Rockway "<jrockway@cpan.org>"

COPYRIGHT AND LICENSE

       Copyright (c) 2008 Jonathan Rockway.

       This module is free software.  You may redistribute it under the same terms as perl itself.

AUTHOR

       Jonathan Rockway <jrockway@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2010 by Jonathan Rockway.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2010-12-27				   Template::Plugin::DateTime::Format(3pm)

Check Out this Related Man Page

HTML::FormFu::Inflator::DateTime(3pm)			User Contributed Perl Documentation		     HTML::FormFu::Inflator::DateTime(3pm)

NAME

       HTML::FormFu::Inflator::DateTime - DateTime inflator

SYNOPSIS

	   ---
	   elements:
	     - type: Text
	       name: start_date
	       inflators:
		 - type: DateTime
		   parser:
		     strptime: '%d-%m-%Y'
		   strptime:
		     pattern: '%d-%b-%Y'
		     locale: de

	     - type: Text
	       name: end_time
	       inflators:
		 - type: DateTime
		   time_zone: Europe/Rome
		   parser:
		     regex: '^ (d{2}) - (d{2}) - (d{4}) $'
		     params: [day, month, year]
		   strptime: '%d-%m-%Y'

       An example of using the same parser declaration for both a DateTime constraint and a DateTime inflator, using YAML references:

	   ---
	   elements:
	     - type: Text
	       name: date
	       constraints:
		 - type: DateTime
		   parser: &PARSER
		     strptime: '%d-%m-%Y'
	       inflators:
		 - type: DateTime
		   parser: *PARSER

DESCRIPTION

       Inflate dates into DateTime objects.

       For a corresponding deflator, see HTML::FormFu::Deflator::Strftime.

METHODS

   parser
       Arguments: \%args

       Required. Define the expected input string, so DateTime::Format::Builder knows how to inflate it into a DateTime object.

       Accepts arguments to be passed to "parser" in DateTime::Format::Builder.

   strptime
       Arguments: \%args

       Arguments: $string

       Optional. Define the format that should be used if the DateTime object is stringified.

   time_zone
       Arguments: $string

       Optional. You can pass along a time_zone in which the DateTime will be created. This is useful if the string to parse does not contain time
       zone information and you want the DateTime to be in a specific zone instead of the floating one (which is likely).

       Accepts a hashref of arguments to be passed to "new" in DateTime::Format::Strptime. Alternatively, accepts a single string argument,
       suitable for passing to "DateTime::Format::Strptime->new( pattern => $string )".

AUTHOR

       Carl Franks, "cfranks@cpan.org"

LICENSE

       This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-01-23				     HTML::FormFu::Inflator::DateTime(3pm)

Linux and UNIX Man Pages

template::plugin::datetime::format(3pm) [debian man page]

Check Out this Related Man Page