James Kiser > Catalyst-Plugin-DateTime > Catalyst::Plugin::DateTime

Download:
Catalyst-Plugin-DateTime-0.03.tgz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

Catalyst::Plugin::DateTime - DateTime plugin for Catalyst.

SYNOPSIS ^

    # In your application class 
    use Catalyst qw/DateTime/;


    # Use DateTime objects within your Catalyst app:
    my $dt = $c->datetime(); # will return a DateTime object with local date and time
    my $dt = $c->datetime(year => '2005', month => '01');
 
    $c->datetime->mdy(); # returns current date in mdy format (i.e. 01/01/2006)

    $c->dt(time_zone => 'Asia/Taipei'); # returns current date & time for argued time zone

METHODS ^

datetime

Returns a DateTime object. If params are argued they will be passed to the DateTime->new() method. Exceptions thrown by DateTime will be caught by Catalyst::Exception.

If the argument list is empty, a DateTime object with the local date and time obtained via DateTime->now() will be returned.

Uses time_zone => local as a default.

dt

Alias to datetime.

DESCRIPTION ^

This module's intention is to make the wonders of DateTime easily accesible within a Catalyst application via the Catalyst::Plugin interface.

It adds the methods datetime and dt to the Catalyst namespace.

AUTHOR ^

James Kiser james.kiser@gmail.com

SEE ALSO ^

Catalyst, DateTime

COPYRIGHT & LICENSE ^

    Copyright (c) 2006 the aforementioned author(s). All rights
    reserved. This program is free software; you can redistribute
    it and/or modify it under the same terms as Perl itself.
syntax highlighting: