Class: HTML_QuickForm_date

Source Location: /main/inc/lib/pear/HTML/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):

Alexey Borzov <avb@php.net>

Version:

Child classes:

HTML_QuickForm_datepicker: Form element to select a date and hour (with popup datepicker)

HTML_QuickForm_datepickerdate: Form element to select a date and hour (with popup datepicker)

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()
HTML_QuickForm_group::_createElements(): Creates the group's elements.
HTML_QuickForm_group::_createElementsIfNotExist(): A wrapper around _createElements()

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
HTML_QuickForm_element::_findValue(): Tries to find the element value from the values array
HTML_QuickForm_element::_generateId(): Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData(): Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue(): Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes
HTML_Common::_getAttrKey(): Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString(): Returns an HTML formatted attribute string
HTML_Common::_getLineEnd(): Returns the lineEnd
HTML_Common::_getTab(): Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs(): Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes(): Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr(): Removes the given attribute from the given array
HTML_Common::_updateAttrArray(): Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 35]
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

Tags:

author:	Alexey Borzov <avb@php.net>
version:	1.0
access:	public

[ Top ]

Class Variables

$_locale = array(
'en' => array (
'weekdays_short'=> array ('Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'),'weekdays_long'=>array('Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday'),'months_short'=>array('Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'),'months_long'=>array('January','February','March','April','May','June','July','August','September','October','November','December')),'de'=>array('weekdays_short'=>array('So','Mon','Di','Mi','Do','Fr','Sa'),'weekdays_long'=>array('Sonntag','Montag','Dienstag','Mittwoch','Donnerstag','Freitag','Samstag'),'months_short'=>array('Jan','Feb','März','April','Mai','Juni','Juli','Aug','Sept','Okt','Nov','Dez'),'months_long'=>array('Januar','Februar','März','April','Mai','Juni','Juli','August','September','Oktober','November','Dezember')),'fr'=>array('weekdays_short'=>array('Dim','Lun','Mar','Mer','Jeu','Ven','Sam'),'weekdays_long'=>array('Dimanche','Lundi','Mardi','Mercredi','Jeudi','Vendredi','Samedi'),'months_short'=>array('Jan','Fév','Mar','Avr','Mai','Juin','Juil','Août','Sep','Oct','Nov','Déc'),'months_long'=>array('Janvier','Février','Mars','Avril','Mai','Juin','Juillet','Août','Septembre','Octobre','Novembre','Décembre')),'hu'=>array('weekdays_short'=>array('V','H','K','Sze','Cs','P','Szo'),'weekdays_long'=>array('vasárnap','hétfő','kedd','szerda','csütörtök','péntek','szombat'),'months_short'=>array('jan','feb','márc','ápr','máj','jún','júl','aug','szept','okt','nov','dec'),'months_long'=>array('január','február','március','április','május','június','július','augusztus','szeptember','október','november','december')),'pl'=>array('weekdays_short'=>array('Nie','Pn','Wt','Śr','Czw','Pt','Sob'),'weekdays_long'=>array('Niedziela','Poniedziałek','Wtorek','Środa','Czwartek','Piątek','Sobota'),'months_short'=>array('Sty','Lut','Mar','Kwi','Maj','Cze','Lip','Sie','Wrz','Paź','Lis','Gru'),'months_long'=>array('Styczeń','Luty','Marzec','Kwiecień','Maj','Czerwiec','Lipiec','Sierpień','Wrzesień','Październik','Listopad','Grudzień')),'sl'=>array('weekdays_short'=>array('Ned','Pon','Tor','Sre','Cet','Pet','Sob'),'weekdays_long'=>array('Nedelja','Ponedeljek','Torek','Sreda','Cetrtek','Petek','Sobota'),'months_short'=>array('Jan','Feb','Mar','Apr','Maj','Jun','Jul','Avg','Sep','Okt','Nov','Dec'),'months_long'=>array('Januar','Februar','Marec','April','Maj','Junij','Julij','Avgust','September','Oktober','November','December')),'ru'=>array('weekdays_short'=>array('Вс','Пн','Вт','Ср','Чт','Пт','Сб'),'weekdays_long'=>array('Воскресенье','Понедельник','Вторник','Среда','Четверг','Пятница','Суббота'),'months_short'=>array('Янв','Фев','Мар','Апр','Май','Июн','Июл','Авг','Сен','Окт','Ноя','Дек'),'months_long'=>array('Январь','Февраль','Март','Апрель','Май','Июнь','Июль','Август','Сентябрь','Октябрь','Ноябрь','Декабрь')),'es'=>array('weekdays_short'=>array('Dom','Lun','Mar','Mié','Jue','Vie','Sáb'),'weekdays_long'=>array('Domingo','Lunes','Martes','Miércoles','Jueves','Viernes','Sábado'),'months_short'=>array('Ene','Feb','Mar','Abr','May','Jun','Jul','Ago','Sep','Oct','Nov','Dic'),'months_long'=>array('Enero','Febrero','Marzo','Abril','Mayo','Junio','Julio','Agosto','Septiembre','Octubre','Noviembre','Diciembre')),'da'=>array('weekdays_short'=>array('Søn','Man','Tir','Ons','Tor','Fre','Lør'),'weekdays_long'=>array('Søndag','Mandag','Tirsdag','Onsdag','Torsdag','Fredag','Lørdag'),'months_short'=>array('Jan','Feb','Mar','Apr','Maj','Jun','Jul','Aug','Sep','Okt','Nov','Dec'),'months_long'=>array('Januar','Februar','Marts','April','Maj','Juni','Juli','August','September','Oktober','November','December')),'is'=>array('weekdays_short'=>array('Sun','Mán','Þri','Mið','Fim','Fös','Lau'),'weekdays_long'=>array('Sunnudagur','Mánudagur','Þriðjudagur','Miðvikudagur','Fimmtudagur','Föstudagur','Laugardagur'),'months_short'=>array('Jan','Feb','Mar','Apr','Maí','Jún','Júl','Ágú','Sep','Okt','Nóv','Des'),'months_long'=>array('Janúar','Febrúar','Mars','Apríl','Maí','Júní','Júlí','Ágúst','September','Október','Nóvember','Desember')),'it'=>array('weekdays_short'=>array('Dom','Lun','Mar','Mer','Gio','Ven','Sab'),'weekdays_long'=>array('Domenica','Lunedì','Martedì','Mercoledì','Giovedì','Venerdì','Sabato'),'months_short'=>array('Gen','Feb','Mar','Apr','Mag','Giu','Lug','Ago','Set','Ott','Nov','Dic'),'months_long'=>array('Gennaio','Febbraio','Marzo','Aprile','Maggio','Giugno','Luglio','Agosto','Settembre','Ottobre','Novembre','Dicembre')),'sk'=>array('weekdays_short'=>array('Ned','Pon','Uto','Str','tv','Pia','Sob'),'weekdays_long'=>array('Nedeža','Pondelok','Utorok','Streda','tvrtok','Piatok','Sobota'),'months_short'=>array('Jan','Feb','Mar','Apr','Máj','Jún','Júl','Aug','Sep','Okt','Nov','Dec'),'months_long'=>array('Január','Február','Marec','Apríl','Máj','Jún','Júl','August','September','Október','November','December')),'cs'=>array('weekdays_short'=>array('Ne','Po','Út','St','Čt','Pá','So'),'weekdays_long'=>array('Neděle','Pondělí','Úterý','Středa','Čtvrtek','Pátek','Sobota'),'months_short'=>array('Led','Úno','Bře','Dub','Kvě','Čen','Čec','Srp','Zář','Říj','Lis','Pro'),'months_long'=>array('Leden','Únor','Březen','Duben','Květen','Červen','Červenec','Srpen','Září','Říjen','Listopad','Prosinec')),'hy'=>array('weekdays_short'=>array('Կրկ','Երկ','Երք','Չրք','Հնգ','Ուր','Շբթ'),'weekdays_long'=>array('Կիրակի','Երկուշաբթի','Երեքշաբթի','Չորեքշաբթի','Հինգշաբթի','Ուրբաթ','Շաբաթ'),'months_short'=>array('Հնվ','Փտր','Մրտ','Ապր','Մյս','Հնս','Հլս','Օգս','Սպտ','Հկտ','Նյմ','Դկտ'),'months_long'=>array('Հունվար','Փետրվար','Մարտ','Ապրիլ','Մայիս','Հունիս','Հուլիս','Օգոստոս','Սեպտեմբեր','Հոկտեմբեր','Նոյեմբեր','Դեկտեմբեր')),'nl'=>array('weekdays_short'=>array('Zo','Ma','Di','Wo','Do','Vr','Za'),'weekdays_long'=>array('Zondag','Maandag','Dinsdag','Woensdag','Donderdag','Vrijdag','Zaterdag'),'months_short'=>array('Jan','Feb','Mar','Apr','Mei','Jun','Jul','Aug','Sep','Okt','Nov','Dec'),'months_long'=>array('Januari','Februari','Maart','April','Mei','Juni','Juli','Augustus','September','Oktober','November','December')),'et'=>array('weekdays_short'=>array('P','E','T','K','N','R','L'),'weekdays_long'=>array('Pühapäev','Esmaspäev','Teisipäev','Kolmapäev','Neljapäev','Reede','Laupäev'),'months_short'=>array('Jaan','Veebr','Märts','Aprill','Mai','Juuni','Juuli','Aug','Sept','Okt','Nov','Dets'),'months_long'=>array('Jaanuar','Veebruar','Märts','Aprill','Mai','Juuni','Juuli','August','September','Oktoober','November','Detsember')),'tr'=>array('weekdays_short'=>array('Paz','Pzt','Sal','Çar','Per','Cum','Cts'),'weekdays_long'=>array('Pazar','Pazartesi','Salı','Çarşamba','Perşembe','Cuma','Cumartesi'),'months_short'=>array('Ock','Şbt','Mrt','Nsn','Mys','Hzrn','Tmmz','Ağst','Eyl','Ekm','Ksm','Arlk'),'months_long'=>array('Ocak','Şubat','Mart','Nisan','Mayıs','Haziran','Temmuz','Ağustos','Eylül','Ekim','Kasım','Aralık')),'no'=>array('weekdays_short'=>array('Søn','Man','Tir','Ons','Tor','Fre','Lør'),'weekdays_long'=>array('Søndag','Mandag','Tirsdag','Onsdag','Torsdag','Fredag','Lørdag'),'months_short'=>array('Jan','Feb','Mar','Apr','Mai','Jun','Jul','Aug','Sep','Okt','Nov','Des'),'months_long'=>array('Januar','Februar','Mars','April','Mai','Juni','Juli','August','September','Oktober','November','Desember')),'eo'=>array('weekdays_short'=>array('Dim','Lun','Mar','Mer','Ĵaŭ','Ven','Sab'),'weekdays_long'=>array('Dimanĉo','Lundo','Mardo','Merkredo','Ĵaŭdo','Vendredo','Sabato'),'months_short'=>array('Jan','Feb','Mar','Apr','Maj','Jun','Jul','Aŭg','Sep','Okt','Nov','Dec'),'months_long'=>array('Januaro','Februaro','Marto','Aprilo','Majo','Junio','Julio','Aŭgusto','Septembro','Oktobro','Novembro','Decembro')),'ua'=>array('weekdays_short'=>array('Ндл','Пнд','Втр','Срд','Чтв','Птн','Сбт'),'weekdays_long'=>array('Неділя','Понеділок','Вівторок','Середа','Четвер','П\'ятниця','Субота'),'months_short'=>array('Січ','Лют','Бер','Кві','Тра','Чер','Лип','Сер','Вер','Жов','Лис','Гру'),'months_long'=>array('Січень','Лютий','Березень','Квітень','Травень','Червень','Липень','Серпень','Вересень','Жовтень','Листопад','Грудень')),'ro'=>array('weekdays_short'=>array('Dum','Lun','Mar','Mie','Joi','Vin','Sam'),'weekdays_long'=>array('Duminica','Luni','Marti','Miercuri','Joi','Vineri','Sambata'),'months_short'=>array('Ian','Feb','Mar','Apr','Mai','Iun','Iul','Aug','Sep','Oct','Nov','Dec'),'months_long'=>array('Ianuarie','Februarie','Martie','Aprilie','Mai','Iunie','Iulie','August','Septembrie','Octombrie','Noiembrie','Decembrie')),'he'=>array('weekdays_short'=>array('ראשון','שני','שלישי','רביעי','חמישי','שישי','שבת'),'weekdays_long'=>array('יום ראשון','יום שני','יום שלישי','יום רביעי','יום חמישי','יום שישי','שבת'),'months_short'=>array('ינואר','פברואר','מרץ','אפריל','מאי','יוני','יולי','אוגוסט','ספטמבר','אוקטובר','נובמבר','דצמבר'),'months_long'=>array('ינואר','פברואר','מרץ','אפריל','מאי','יוני','יולי','אוגוסט','ספטמבר','אוקטובר','נובמבר','דצמבר')),'sv'=>array('weekdays_short'=>array('Sön','Mån','Tis','Ons','Tor','Fre','Lör'),'weekdays_long'=>array('Söndag','Måndag','Tisdag','Onsdag','Torsdag','Fredag','Lördag'),'months_short'=>array('Jan','Feb','Mar','Apr','Maj','Jun','Jul','Aug','Sep','Okt','Nov','Dec'),'months_long'=>array('Januari','Februari','Mars','April','Maj','Juni','Juli','Augusti','September','Oktober','November','December')),'pt'=>array('weekdays_short'=>array('Dom','Seg','Ter','Qua','Qui','Sex','Sáb'),'weekdays_long'=>array('Domingo','Segunda-feira','Terça-feira','Quarta-feira','Quinta-feira','Sexta-feira','Sábado'),'months_short'=>array('Jan','Fev','Mar','Abr','Mai','Jun','Jul','Ago','Set','Out','Nov','Dez'),'months_long'=>array('Janeiro','Fevereiro','Março','Abril','Maio','Junho','Julho','Agosto','Setembro','Outubro','Novembro','Dezembro')),'tw'=>array('weekdays_short'=>array('週日','週一','週二','週三','週四','週五','週六'),'weekdays_long'=>array('星期日','星期一','星期二','星期三','星期四','星期五','星期六'),'months_short'=>array('一月','二月','三月','四月','五月','六月','七月','八月','九月','十月','十一月','十二月'),'months_long'=>array('一月','二月','三月','四月','五月','六月','七月','八月','九月','十月','十一月','十二月')),'pt-br'=>array('weekdays_short'=>array('Dom','Seg','Ter','Qua','Qui','Sex','Sáb'),'weekdays_long'=>array('Domingo','Segunda','Terça','Quarta','Quinta','Sexta','Sábado'),'months_short'=>array('Jan','Fev','Mar','Abr','Mai','Jun','Jul','Ago','Set','Out','Nov','Dez'),'months_long'=>array('Janeiro','Fevereiro','Março','Abril','Maio','Junho','Julho','Agosto','Setembro','Outubro','Novembro','Dezembro')))

[line 98]

Options in different languages

Note to potential translators: to avoid encoding problems please send your translations with "weird" letters encoded as HTML Unicode entities

Tags:

access:

private

Type:

array

[ Top ]

$_options = array(
        'language'         => 'en',
        'format'           => 'dMY',
        'minYear'          => 2001,
        'maxYear'          => 2010,
        'addEmptyOption'   => false,
        'emptyOptionValue' => '',
        'emptyOptionText'  => ' ',
        'optionIncrement'  => array('i' => 1, 's' => 1))

[line 71]

Various options to control the element's display.

Currently known options are 'language': date language 'format': Format of the date, based on PHP's date() function. The following characters are 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')

Tags:

access:

private

Type:

array

[ Top ]

$_wrap = array('', '')

[line 87]

These complement separators, they are appended to the resultant HTML

Tags:

access:

private

Type:

array

[ Top ]

Class Methods

constructor HTML_QuickForm_date [line 269]

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

Class constructor

Tags:

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 ]

method accept [line 475]

void accept(

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

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

Parameters:

	&$renderer
	$required
	$error

[ Top ]

method onQuickFormEvent [line 483]

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 ]

method setValue [line 428]

void setValue(

$value)

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

Parameters:

$value

[ Top ]

method toHtml [line 463]

void toHtml(
)

Overridden in child classes as:

HTML_QuickForm_datepicker::toHtml(): HTML code to display this datepicker

HTML_QuickForm_datepickerdate::toHtml(): HTML code to display this datepicker

Overrides HTML_QuickForm_group::toHtml() (Returns Html for the group)

[ Top ]

method _createElements [line 294]

void _createElements(
)

Overrides HTML_QuickForm_group::_createElements() (Creates the group's elements.)

[ Top ]

method _createOptionList [line 417]

array _createOptionList(
int
$start, int
$end, [int
$step = 1])

Creates an option list containing the numbers from the start number to the end, inclusive

Tags:

return:	An array of numeric options.
access:	private

Parameters:

int	$start	The start number
int	$end	The end number
int	$step	Increment by this value

[ Top ]

Documentation generated on Thu, 12 Jun 2008 13:18:16 -0500 by phpDocumentor 1.4.1

Class: HTML_QuickForm_date

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Class: HTML_QuickForm_group

Class: HTML_QuickForm_element

Class: HTML_Common

Inherited Methods

Class: HTML_QuickForm_group

Class: HTML_QuickForm_element

Class: HTML_Common

Class Details

Tags:

Class Variables

Tags:

$_options = array( 'language' => 'en', 'format' => 'dMY', 'minYear' => 2001, 'maxYear' => 2010, 'addEmptyOption' => false, 'emptyOptionValue' => '', 'emptyOptionText' => '&nbsp;', 'optionIncrement' => array('i' => 1, 's' => 1))

Tags:

$_wrap = array('', '')

Tags:

Class Methods

constructor HTML_QuickForm_date [line 269]

Tags:

Parameters:

method accept [line 475]

Parameters:

method onQuickFormEvent [line 483]

Parameters:

method setValue [line 428]

Parameters:

method toHtml [line 463]

method _createElements [line 294]

method _createOptionList [line 417]

Tags:

Parameters:

$_options = array(
'language' => 'en',
'format' => 'dMY',
'minYear' => 2001,
'maxYear' => 2010,
'addEmptyOption' => false,
'emptyOptionValue' => '',
'emptyOptionText' => ' ',
'optionIncrement' => array('i' => 1, 's' => 1))