HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]

Class: HTML_QuickForm_date

Source Location: /HTML_QuickForm-3.2.13/QuickForm/date.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_group
         |
         --HTML_QuickForm_date

Class for a group of elements used to input dates (and times).


Author(s):

Version:

  • Release: 3.2.13

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm_group

HTML_QuickForm_group::HTML_QuickForm_group()
Class constructor
HTML_QuickForm_group::accept()
Accepts a renderer
HTML_QuickForm_group::exportValue()
As usual, to get the group's value we access its elements and call
HTML_QuickForm_group::freeze()
HTML_QuickForm_group::getElementName()
Returns the element name inside the group such as found in the html form
HTML_QuickForm_group::getElements()
Gets the grouped elements
HTML_QuickForm_group::getFrozenHtml()
Returns the value of field without HTML tags
HTML_QuickForm_group::getGroupType()
Gets the group type based on its elements Will return 'mixed' if elements contained in the group are of different types.
HTML_QuickForm_group::getName()
Returns the group name
HTML_QuickForm_group::getValue()
Returns the value of the group
HTML_QuickForm_group::onQuickFormEvent()
Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_group::setElements()
Sets the grouped elements
HTML_QuickForm_group::setName()
Sets the group name
HTML_QuickForm_group::setPersistantFreeze()
HTML_QuickForm_group::setValue()
Sets values for group's elements
HTML_QuickForm_group::toHtml()
Returns Html for the group
HTML_QuickForm_group::unfreeze()

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element()
Class constructor
HTML_QuickForm_element::accept()
Accepts a renderer
HTML_QuickForm_element::apiVersion()
Returns the current API version
HTML_QuickForm_element::exportValue()
Returns a 'safe' element's value
HTML_QuickForm_element::freeze()
Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml()
Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel()
Returns display text for the element
HTML_QuickForm_element::getName()
Returns the element name
HTML_QuickForm_element::getType()
Returns element type
HTML_QuickForm_element::getValue()
Returns the value of the form element
HTML_QuickForm_element::isFrozen()
Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent()
Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel()
Sets display text for the element
HTML_QuickForm_element::setName()
Sets the input field name
HTML_QuickForm_element::setPersistantFreeze()
Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue()
Sets the value of the form element
HTML_QuickForm_element::unfreeze()
Unfreezes the element so that it becomes editable

Class Details

[line 45]
Class for a group of elements used to input dates (and times).

Inspired by original 'date' element but reimplemented as a subclass of HTML_QuickForm_group

  • Author: Alexey Borzov <avb@php.net>
  • Version: Release: 3.2.13
  • Since: 3.1


[ Top ]


Method Detail

HTML_QuickForm_date (Constructor)   [line 293]

HTML_QuickForm_date HTML_QuickForm_date( [string $elementName = null], [mixed $elementLabel = null], [array $options = array()], [mixed $attributes = null])

Class constructor

The following keys may appear in $options array:

  • 'language': date language
  • 'format': Format of the date, based on PHP's date() function. The following characters are currently recognised in format string:
           D => Short names of days
           l => Long names of days
           d => Day numbers
           M => Short names of months
           F => Long names of months
           m => Month numbers
           Y => Four digit year
           y => Two digit year
           h => 12 hour format
           H => 23 hour  format
           i => Minutes
           s => Seconds
           a => am/pm
           A => AM/PM
  • 'minYear': Minimum year in year select
  • 'maxYear': Maximum year in year select
  • 'addEmptyOption': Should an empty option be added to the top of each select box?
  • 'emptyOptionValue': The value passed by the empty option.
  • 'emptyOptionText': The text displayed for the empty option.
  • 'optionIncrement': Step to increase the option values by (works for 'i' and 's')

  • Access: public

Parameters:

string   $elementName     Element's name
mixed   $elementLabel     Label(s) for an element
array   $options     Options to control the element's display
mixed   $attributes     Either a typical HTML attribute string or an associative array

[ Top ]

accept   [line 523]

void accept( &$renderer, [ $required = false], [ $error = null])


Overrides HTML_QuickForm_group::accept() (Accepts a renderer)

Parameters:

   &$renderer     
   $required     
   $error     

[ Top ]

onQuickFormEvent   [line 531]

void onQuickFormEvent( $event, $arg, &$caller)


Overrides HTML_QuickForm_group::onQuickFormEvent() (Called by HTML_QuickForm whenever form event is made on this element)

Parameters:

   $event     
   $arg     
   &$caller     

[ Top ]

setValue   [line 474]

void setValue( $value)


Overrides HTML_QuickForm_group::setValue() (Sets values for group's elements)

Parameters:

   $value     

[ Top ]

toHtml   [line 511]

void toHtml( )


Overrides HTML_QuickForm_group::toHtml() (Returns Html for the group)
[ Top ]


Documentation generated on Sat, 01 Oct 2011 09:00:08 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.