Class: MF_Widget_datetime

Source Location: Program_Root/MailForm/Widget/Datetime.php

Class Overview

MF_Widget
   |
   --MF_Widget_datetime

Datetime widget. Displays 3 select boxes representing the year, month, and day, as well as three text boxes representing the hour, minute, and second.

Author(s)

John Luxford <mailto:lux@simian.ca>

Version

1.4, 2002-03-25, $Id: Datetime.php,v 1.2 2005/07/06 15:30:56 lux Exp $

Copyright

Inherited Variables

Class: MF_Widget

MF_Widget::$advanced
MF_Widget::$data_value
MF_Widget::$default_value
MF_Widget::$display_value
MF_Widget::$form
MF_Widget::$invalid
MF_Widget::$name
MF_Widget::$nullable
MF_Widget::$passover_isset
MF_Widget::$rule
MF_Widget::$rules
MF_Widget::$value

Inherited Methods

Class: MF_Widget

MF_Widget::MF_Widget(): Constructor Method.
MF_Widget::addRule(): Adds a validation rule to the list of $rules.
MF_Widget::attr(): This is the accessor method for setting and getting the value of
MF_Widget::changeType()
MF_Widget::display(): Returns the display HTML for this widget. The optional parameter determines whether or not to automatically display the widget nicely, or whether to simply return the widget (for use in a template).
MF_Widget::getAttrs(): Returns a list of all of the attributes of this object's HTML tag in a string ready to be concatenated into the actual rendered tag output.
MF_Widget::getValue(): Fetches the actual value for this widget.
MF_Widget::invalid(): Returns a ' class="invalid"' string if the widget's $invalid property is set to true, or an empty string otherwise.
MF_Widget::setDefault(): Sets the default value for the widget.
MF_Widget::setValue(): Sets the *ACTUAL* value for this widget. An optional second parameter can be passed, which is unused here, but can be used in complex widget types to assign parts of a value and piece it together from multiple physical form fields.
MF_Widget::setValues(): Sets the *POSSIBLE* values for this widget. If $value is given, sets $this->value as a hash, otherwise, as a string.
MF_Widget::unsetAttr(): Use this method to remove an attribute from the tag
MF_Widget::validate(): Validates the widget against its set of $rules. Returns false on failure to pass any rule.
MF_Widget::validation(): Sets the validation $rule for this widget. Note: This method is deprecated and only wraps around the addRule() method anyway. Please use addRule() instead, since this method will be removed in a near-future release.

Class Details

[line 61]
Datetime widget. Displays 3 select boxes representing the year, month, and day, as well as three text boxes representing the hour, minute, and second.

Please note: MySQL handles timestamp and datetime column types differently, and while both are supported by this widget, it is important to be aware of these differences when designing your database tables.

New in 1.2:

setValue method now supports dates in the format ############## as well as ####-##-## ##:##:##.

New in 1.4:

Added a setDefault(value) method.


1     <?php
2     
3      $widget = new MF_Widget_datetime ('name');
4      $widget->validation ('is "foo"');
5      $widget->setValue ('foo');
6      $widget->error_message = 'Oops!  This widget is being unruly!';
7     
8      ?>

Tags:

access:	public
version:	1.4, 2002-03-25, $Id: Datetime.php,v 1.2 2005/07/06 15:30:56 lux Exp $
license:	http://www.sitellite.org/index/license
copyright:	Copyright (C) 2001-2003, Simian Systems Inc.
author:	John Luxford <mailto:lux@simian.ca>

[ Top ]

Class Variables

$extra = ''

[line 85]

A way to pass extra parameters to the HTML form tag, for example 'enctype="multipart/formdata"'.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

constructor MF_Widget_datetime [line 103]

MF_Widget_datetime MF_Widget_datetime(
string
$name)

Constructor Method.

method display [line 247]

string display(
[boolean
$generate_html = 0])

Returns the display HTML for this widget. The optional parameter determines whether or not to automatically display the widget nicely, or whether to simply return the widget (for use in a template).

Tags:

access:

public

Overrides MF_Widget::display() (Returns the display HTML for this widget. The optional parameter determines whether or not to automatically display the widget nicely, or whether to simply return the widget (for use in a template).)

Parameters:

boolean

$generate_html

[ Top ]

method getValue [line 211]

string getValue(
[object
$cgi = ''])

Fetches the actual value for this widget.

method setDefault [line 177]

void setDefault(
string
$value)

Gives this widget a default value. Accepts a date string of the format 'YYYY-MM-DD HH:MM:SS' or 'YYYYMMDDHHMMSS'.

method setValue [line 139]

void setValue(
[string
$value = ''], [string
$inner_component = ''])

Sets the actual value for this widget. An optional second parameter can be passed, which is unused here, but can be used in complex widget types to assign parts of a value and piece it together from multiple physical form fields.

Tags:

access:

public

Overrides MF_Widget::setValue() (Sets the *ACTUAL* value for this widget. An optional second parameter can be passed, which is unused here, but can be used in complex widget types to assign parts of a value and piece it together from multiple physical form fields.)

Parameters:

string	$value
string	$inner_component

[ Top ]

Packages

Classes

Files

Class: MF_Widget_datetime

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Class: MF_Widget

Inherited Methods

Class: MF_Widget

Class Details

Tags:

Class Variables

$extra = ''

Tags:

$type = 'datetime'

Tags:

Class Methods

constructor MF_Widget_datetime [line 103]

Tags:

Parameters:

method display [line 247]

Tags:

Parameters:

method getValue [line 211]

Tags:

Parameters:

method setDefault [line 177]

Tags:

Parameters:

method setValue [line 139]

Tags:

Parameters: