GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ROSE::HTML::FORM::FIELD::DATETIME (3)

.ds Aq ’

NAME

Rose::HTML::Form::Field::DateTime - Text field that inflates valid dates and times into DateTime objects.

CONTENTS

SYNOPSIS



    $field =
      Rose::HTML::Form::Field::DateTime->new(
        label   => Date,
        name    => date,
        default => 12/31/2002 8pm);

    print $field->internal_value; # "2002-12-31T20:00:00"
    print $field->output_value;   # "2002-12-31 08:00:00 PM"

    $field->input_value(blah);

    # "Could not parse date: blah"
    $field->validate or warn $field->error;

    $field->input_value(4/30/1980 5:30 p.m.);

    $dt = $field->internal_value; # DateTime object

    print $dt->hour;     # 17
    print $dt->day_name; # Wednesday

    print $field->html;
    ...



DESCRIPTION

Rose::HTML::Form::Field::DateTime is a subclass of Rose::HTML::Form::Field::Text that allows only valid dates as input, which it then coerces to DateTime objects. It overrides the validate(), inflate_value(), and deflate_value() methods of its parent class.

Valid input is converted to the format YYYY-MM-DD HH:MM:SS AM/PM on output.

OBJECT METHODS

<B>date_parser [PARSER]B> Get or set the date parser object. This object must include a parse_datetime() method that takes a single string as an argument and returns a DateTime object, or undef if parsing fails.

If the parser object has an error() method, it will be called to set the error message after a failed parsing attempt.

The parser object defaults to Rose::DateTime::Parser->new().

<B>output_format [FORMAT]B> Get or set the format string passed to Rose::DateTime::Util’s format_date function in order to generate the field’s output value. Defaults to %Y-%m-%d %I:%M:%S %p
<B>time_zone [TZ]B> If the parser object has a time_zone() method, this method simply calls it, passing all arguments. Otherwise, undef is returned.

SEE ALSO

Other examples of custom fields:
Rose::HTML::Form::Field::Email A text field that only accepts valid email addresses.
Rose::HTML::Form::Field::Time Uses inflate/deflate to coerce input into a fixed format.
Rose::HTML::Form::Field::DateTime::Range A compound field whose internal value consists of more than one object.
Rose::HTML::Form::Field::PhoneNumber::US::Split A simple compound field that coalesces multiple subfields into a single value.
Rose::HTML::Form::Field::DateTime::Split::MonthDayYear A compound field that uses inflate/deflate convert input from multiple subfields into a DateTime object.
Rose::HTML::Form::Field::DateTime::Split::MDYHMS A compound field that includes other compound fields and uses inflate/deflate convert input from multiple subfields into a DateTime object.

AUTHOR

John C. Siracusa (siracusa@gmail.com)

LICENSE

Copyright (c) 2010 by John C. Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ROSE::HTML::FORM::FIELD::DATETIME (3) 2015-03-17

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.