MoodleQuickForm_date_time_selector Class Reference

Inheritance diagram for MoodleQuickForm_date_time_selector:

Collaboration diagram for MoodleQuickForm_date_time_selector:

Public Member Functions
	MoodleQuickForm_date_time_selector ($elementName=null, $elementLabel=null, $options=array(), $attributes=null)
	_createElements ()
	onQuickFormEvent ($event, $arg, &$caller)
	toHtml ()
	accept (&$renderer, $required=false, $error=null)
	exportValue (&$submitValues, $assoc=false)
Data Fields
	$_options
	$_wrap = array('', '')

---

Detailed Description

Definition at line 37 of file datetimeselector.php.

---

Member Function Documentation

_createElements

(

)

Creates the group's elements.

This should be overriden by child classes that need to create their elements. The method will be called automatically when needed, calling it from the constructor is discouraged as the constructor is usually called _twice_ on element creation, first time with _no_ parameters.

private

Reimplemented from HTML_QuickForm_group.

Definition at line 92 of file datetimeselector.php.

Here is the call graph for this function:

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

Accepts a renderer

Parameters:

object	An HTML_QuickForm_Renderer object
bool	Whether a group is required
string	An error message associated with a group public

Returns:

void

Reimplemented from HTML_QuickForm_group.

Definition at line 215 of file datetimeselector.php.

Here is the caller graph for this function:

exportValue	(	&$	submitValues,
		$	assoc = false
	)

Output a timestamp. Give it the name of the group.

Parameters:

array	$submitValues
bool	$assoc

Returns:

array

Reimplemented from HTML_QuickForm_group.

Definition at line 229 of file datetimeselector.php.

Here is the call graph for this function:

MoodleQuickForm_date_time_selector	(	$	elementName = null,
		$	elementLabel = null,
		$	options = array(),
		$	attributes = null
	)

Class constructor

public

Parameters:

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

Definition at line 68 of file datetimeselector.php.

Here is the call graph for this function:

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

Called by HTML_QuickForm whenever form event is made on this element

Parameters:

string	$event	Name of event
mixed	$arg	event arguments
object	$caller	calling object

Since:

1.0 public

Returns:

void

Reimplemented from HTML_QuickForm_group.

Definition at line 145 of file datetimeselector.php.

Here is the call graph for this function:

toHtml

(

)

Returns Html for the group

Since:

1.0 public

Returns:

string

Reimplemented from HTML_QuickForm_group.

Definition at line 203 of file datetimeselector.php.

Here is the call graph for this function:

---

Field Documentation

$_options

Initial value:

 array('startyear' => 1970, 'stopyear' => 2020, 'defaulttime' => 0,
                    'timezone' => 99, 'applydst' => true, 'step' => 5, 'optional' => false)

Options for the element

startyear => integer start of range of years that can be selected stopyear => integer last year that can be selected defaulttime => default time value if the field is currently not set timezone => float/string timezone applydst => apply users daylight savings adjustment? step => step to increment minutes by optional => if true, show a checkbox beside the date to turn it on (or off)

Definition at line 49 of file datetimeselector.php.

$_wrap = array('', '')

Definition at line 57 of file datetimeselector.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/form/datetimeselector.php