Rose::HTML::Form::Field::Time.3pm

Langue: en

Version: 2008-02-25 (mandriva - 01/05/08)

Section: 3 (Bibliothèques de fonctions)

NAME

Rose::HTML::Form::Field::Time - Text field that accepts only valid times and coerces valid input into HH:MM:SS AM/PM format.

SYNOPSIS

     $field =
       Rose::HTML::Form::Field::Time->new(
         label   => 'Time', 
         name    => 'time',
         default => '8am');
 
     print $field->internal_value; # "08:00:00 PM"
 
     $field->input_value('13:00:00 PM');
 
     # "AM/PM only valid with hours less than 12"
     $field->validate or warn $field->error;
 
     $field->input_value('blah');
 
     # "Invalid time"
     $field->validate or warn $field->error;
 
     $field->input_value('6:30 a.m.');
 
     print $field->internal_value; # "06:30:00 AM"
 
     print $field->html;
     ...
 
 

DESCRIPTION

Rose::HTML::Form::Field::Time is a subclass of Rose::HTML::Form::Field::Text that only allows values that are valid times, which it coerces into the form HH:MM:SS AM/PM. It overrides the validate() and inflate_value() methods of its parent class.

This is a good example of a custom field class that constrains the kinds of inputs that it accepts and coerces all valid input and output to a particular format.

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::DateTime
Uses inflate/deflate to convert input to a DateTime object.
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) Copyright (c) 2008 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.