setting_dependency_disabledif_equals Class Reference

Inheritance diagram for setting_dependency_disabledif_equals:

Collaboration diagram for setting_dependency_disabledif_equals:

Public Member Functions
	__construct (base_setting $setting, base_setting $dependentsetting, $value, $defaultvalue=false)
	is_locked ()
	enforce ()
	get_moodleform_properties ()
Protected Member Functions
	process_value_change ($oldvalue)
	process_status_change ($oldstatus)
Protected Attributes
	$value

---

Detailed Description

A dependency that disables the secondary setting if the primary setting is equal to the provided value

Copyright:

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

Definition at line 169 of file setting_dependency.class.php.

---

Constructor & Destructor Documentation

__construct	(	base_setting $	setting,
		base_setting $	dependentsetting,
		$	value,
		$	defaultvalue = false
	)

Creates the dependency

Parameters:

base_setting	$setting
base_setting	$dependentsetting
mixed	$value
mixed	$defaultvalue

Definition at line 183 of file setting_dependency.class.php.

---

Member Function Documentation

enforce

(

)

Enforces the dependency if required.

Returns:

bool True if there were changes

Reimplemented from setting_dependency.

Reimplemented in setting_dependency_disabledif_not_equals.

Definition at line 245 of file setting_dependency.class.php.

Here is the call graph for this function:

get_moodleform_properties

(

)

Returns an array of properties suitable to be used to define a moodleforms disabled command

Returns:

array

Reimplemented from setting_dependency.

Reimplemented in setting_dependency_disabledif_empty, setting_dependency_disabledif_not_empty, setting_dependency_disabledif_not_checked, setting_dependency_disabledif_checked, and setting_dependency_disabledif_not_equals.

Definition at line 267 of file setting_dependency.class.php.

is_locked

(

)

Returns true if the dependent setting is locked.

Returns:

bool

Reimplemented from setting_dependency.

Reimplemented in setting_dependency_disabledif_empty, and setting_dependency_disabledif_not_empty.

Definition at line 191 of file setting_dependency.class.php.

process_status_change

(

$

oldstatus

)

[protected]

Processes a status change in the primary setting

Parameters:

mixed

$oldstatus

Returns:

bool

Reimplemented from setting_dependency.

Definition at line 224 of file setting_dependency.class.php.

Here is the caller graph for this function:

process_value_change

(

$

oldvalue

)

[protected]

Processes a value change in the primary setting

Parameters:

mixed

$oldvalue

Returns:

bool

Reimplemented from setting_dependency.

Reimplemented in setting_dependency_disabledif_empty, and setting_dependency_disabledif_not_empty.

Definition at line 204 of file setting_dependency.class.php.

Here is the caller graph for this function:

---

Field Documentation

$value [protected]

Definition at line 174 of file setting_dependency.class.php.

---

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

• C:/xampp/htdocs/moodle/backup/util/settings/setting_dependency.class.php