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

Class: HTML_QuickForm_datepickerdate

Source Location: /main/inc/lib/formvalidator/Element/datepickerdate.php

Class Overview

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

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


Author(s):

Version:

  • 1.0

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm_date

HTML_QuickForm_date::HTML_QuickForm_date()
Class constructor
HTML_QuickForm_date::accept()
HTML_QuickForm_date::onQuickFormEvent()
HTML_QuickForm_date::setValue()
HTML_QuickForm_date::toHtml()
HTML_QuickForm_date::_createElements()
HTML_QuickForm_date::_createOptionList()
Creates an option list containing the numbers from the start number to the end, inclusive

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 27]
Form element to select a date and hour (with popup datepicker)



Tags:

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


[ Top ]


Class Methods


constructor HTML_QuickForm_datepickerdate [line 32]

HTML_QuickForm_datepickerdate HTML_QuickForm_datepickerdate( [ $elementName = null], [ $elementLabel = null], [ $attributes = null])

Constructor



Parameters:

   $elementName  
   $elementLabel  
   $attributes  

[ Top ]

method exportValue [line 95]

string exportValue( )

Export the date value in MySQL format



Tags:

return:  YYYY-MM-DD HH:II:SS


Overrides HTML_QuickForm_group::exportValue() (As usual, to get the group's value we access its elements and call)

[ Top ]

method getElementJS [line 77]

void getElementJS( )

Get the necessary javascript for this datepicker



[ Top ]

method setLocalOption [line 110]

void setLocalOption( $name, $value)

Sets an option to a value



Parameters:

   $name  
   $value  

[ Top ]

method toHtml [line 69]

void toHtml( )

HTML code to display this datepicker



Overrides HTML_QuickForm_date::toHtml() (parent method not documented)

[ Top ]


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