Moodle  2.2.1
http://www.collinsharper.com
admin_setting_configtime Class Reference
Inheritance diagram for admin_setting_configtime:
Collaboration diagram for admin_setting_configtime:

Public Member Functions

 __construct ($hoursname, $minutesname, $visiblename, $description, $defaultsetting)
 get_setting ()
 write_setting ($data)
 output_html ($data, $query='')

Data Fields

 $name2

Detailed Description

Time selector

This is a liiitle bit messy. we're using two selects, but we're returning them as an array named after $name (so we only use $name2 internally for the setting)

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 2695 of file adminlib.php.


Constructor & Destructor Documentation

__construct ( hoursname,
minutesname,
visiblename,
description,
defaultsetting 
)

Constructor

Parameters:
string$hoursnamesetting for hours
string$minutesnamesetting for hours
string$visiblenamelocalised
string$descriptionlong localised info
array$defaultsettingarray representing default time 'h'=>hours, 'm'=>minutes

Definition at line 2707 of file adminlib.php.


Member Function Documentation

Get the selected time

Returns:
mixed An array containing 'h'=>xx, 'm'=>xx, or null if not set

Reimplemented from admin_setting.

Definition at line 2717 of file adminlib.php.

Here is the call graph for this function:

output_html ( data,
query = '' 
)

Returns XHTML time select fields

Parameters:
array$dataMust be form 'h'=>xx, 'm'=>xx
string$query
Returns:
string XHTML time select fields and wrapping div(s)

Reimplemented from admin_setting.

Definition at line 2749 of file adminlib.php.

Here is the call graph for this function:

write_setting ( data)

Store the time (hours and minutes)

Parameters:
array$dataMust be form 'h'=>xx, 'm'=>xx
Returns:
bool true if success, false if not

Reimplemented from admin_setting.

Definition at line 2733 of file adminlib.php.

Here is the call graph for this function:


Field Documentation

$name2

Definition at line 2697 of file adminlib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations