HTML_Common

[ ] [ ] [ ]

Packages:
default
Cache_Lite
Crypt
HTML_Common
HTML_QuickForm
HTTP_Request
Image_Text
Log
Mail
Mail_Mime
Net_SMTP
PEAR
QuickForm
Smarty
SmartyGettext
Text_CAPTCHA
Text_Password
Welcompose
Welcompose_Plugins
XML_RPC

Files:

Classes:

Class: HTML_QuickForm_date

Source Location: /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:

1.0

Methods

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: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::charset(): Sets the charset to use by htmlspecialchars() function
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::setAttribute(): Sets the value of the 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

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 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(
)

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

[ Top ]

method _createElements [line 294]

void _createElements(
)

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:51:45 +0100 by phpDocumentor 1.4.3