base_moodleform Class Reference

Inheritance diagram for base_moodleform:

Collaboration diagram for base_moodleform:

Public Member Functions
	__construct (base_ui_stage $uistage, $action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true)
	definition ()
	definition_after_data ()
	close_task_divs ()
	add_setting (backup_setting $setting, base_task $task=null)
	add_heading ($name, $text)
	add_fixed_setting (backup_setting $setting, base_task $task)
	add_dependencies (backup_setting $setting)
	is_cancelled ()
	remove_element ($elementname)
	get_element ($elementname)
	display ()
	require_definition_after_data ()
Protected Member Functions
	add_html_formatting (backup_setting $setting)
Protected Attributes
	$uistage = null
	$coursediv = false
	$sectiondiv = false
	$activitydiv = false

---

Detailed Description

Backup moodleform bridge

Ahhh the mighty moodleform bridge! Strong enough to take the weight of 682 full grown african swallows all of whom have been carring coconuts for several days. EWWWWW!!!!!!!!!!!!!!!!!!!!!!!!

Copyright:

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

Definition at line 42 of file base_moodleform.class.php.

---

Constructor & Destructor Documentation

__construct	(	base_ui_stage $	uistage,
		$	action = null,
		$	customdata = null,
		$	method = 'post',
		$	target = '',
		$	attributes = null,
		$	editable = true
	)

Creates the form

Parameters:

backup_ui_stage	$uistage
moodle_url | string	$action
mixed	$customdata
string	$method	get|post
string	$target
array	$attributes
bool	$editable

Definition at line 74 of file base_moodleform.class.php.

---

Member Function Documentation

add_dependencies

(

backup_setting $

setting

)

Adds dependencies to the form recursively

Parameters:

backup_setting

$setting

Definition at line 261 of file base_moodleform.class.php.

Here is the call graph for this function:

add_fixed_setting	(	backup_setting $	setting,
		base_task $	task
	)

Adds a fixed or static setting to the form

Parameters:

backup_setting

$setting

Definition at line 227 of file base_moodleform.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_heading	(	$	name,
		$	text
	)

Adds a heading to the form

Parameters:

string	$name
string	$text

Definition at line 164 of file base_moodleform.class.php.

add_html_formatting

(

backup_setting $

setting

)

[protected]

Adds HTML formatting for the given backup setting, needed to group/segment correctly.

Parameters:

backup_setting

$setting

Definition at line 172 of file base_moodleform.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_setting	(	backup_setting $	setting,
		base_task $	task = null
	)

Adds the backup_setting as a element to the form

Parameters:

backup_setting

$setting

Returns:

bool

Definition at line 138 of file base_moodleform.class.php.

Here is the call graph for this function:

close_task_divs

(

)

Closes any open divs

Definition at line 119 of file base_moodleform.class.php.

Here is the call graph for this function:

definition

(

)

The standard form definition... obviously not much here

Reimplemented from moodleform.

Definition at line 81 of file base_moodleform.class.php.

definition_after_data

(

)

Definition applied after the data is organised.. why's it here? because I want to add elements on the fly. moodle_page $PAGE

Reimplemented from moodleform.

Reimplemented in backup_confirmation_form.

Definition at line 98 of file base_moodleform.class.php.

Here is the caller graph for this function:

display

(

)

Displays the form

Reimplemented from moodleform.

Definition at line 306 of file base_moodleform.class.php.

Here is the call graph for this function:

get_element

(

$

elementname

)

Gets an element from the form if it exists

Parameters:

string

$elementname

Returns:

HTML_QuickForm_input|MoodleQuickForm_group

Definition at line 295 of file base_moodleform.class.php.

is_cancelled

(

)

Returns true if the form was cancelled, false otherwise

Returns:

bool

Reimplemented from moodleform.

Definition at line 272 of file base_moodleform.class.php.

Here is the call graph for this function:

remove_element

(

$

elementname

)

Removes an element from the form if it exists

Parameters:

string

$elementname

Returns:

bool

Definition at line 281 of file base_moodleform.class.php.

require_definition_after_data

(

)

Ensures the the definition after data is loaded

Definition at line 314 of file base_moodleform.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$activitydiv = false [protected]

Definition at line 62 of file base_moodleform.class.php.

$coursediv = false [protected]

Definition at line 52 of file base_moodleform.class.php.

$sectiondiv = false [protected]

Definition at line 57 of file base_moodleform.class.php.

$uistage = null [protected]

Definition at line 47 of file base_moodleform.class.php.

---

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

• C:/xampp/htdocs/moodle/backup/util/ui/base_moodleform.class.php