setting_dependency Class Reference

Inheritance diagram for setting_dependency:

Public Member Functions
	__construct (base_setting $setting, base_setting $dependentsetting, $defaultvalue=false)
	destroy ()
	process_change ($changetype, $oldvalue)
	get_setting ()
	get_dependent_setting ()
	enforce ()
	get_moodleform_properties ()
	is_locked ()
Data Fields
const	DISABLED_VALUE = 0
const	DISABLED_NOT_VALUE = 1
const	DISABLED_TRUE = 2
const	DISABLED_FALSE = 3
const	DISABLED_CHECKED = 4
const	DISABLED_NOT_CHECKED = 5
const	DISABLED_EMPTY = 6
const	DISABLED_NOT_EMPTY = 7
Protected Member Functions
	process_visibility_change ($oldvisibility)
	process_status_change ($oldstatus)
	process_value_change ($oldvalue)
Protected Attributes
	$setting
	$dependentsetting
	$defaultvalue
	$lastvalue

---

Detailed Description

Generic abstract dependency class

Copyright:

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

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

---

Constructor & Destructor Documentation

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

Creates the dependency object

Parameters:

base_setting	$setting	The parent setting or the primary setting if you prefer
base_setting	$dependentsetting	The dependent setting
mixed	$defaultvalue	The default value to assign if the dependency is unmet

Reimplemented in setting_dependency_disabledif_empty, setting_dependency_disabledif_not_empty, setting_dependency_disabledif_not_checked, and setting_dependency_disabledif_checked.

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

Here is the call graph for this function:

---

Member Function Documentation

destroy

(

)

Destroy all circular references. It helps PHP 5.2 a lot!

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

enforce

(

)

[abstract]

This function enforces the dependency

Reimplemented in setting_dependency_disabledif_equals2, setting_dependency_disabledif_not_equals, and setting_dependency_disabledif_equals.

get_dependent_setting

(

)

Gets the dependent setting

Returns:

backup_setting

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

Here is the caller graph for this function:

get_moodleform_properties

(

)

[abstract]

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

Returns:

array

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

get_setting

(

)

Gets the primary setting

Returns:

backup_setting

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

Here is the caller graph for this function:

is_locked

(

)

[abstract]

Returns true if the dependent setting is locked.

Returns:

bool

Reimplemented in setting_dependency_disabledif_empty, setting_dependency_disabledif_not_empty, setting_dependency_disabledif_equals2, and setting_dependency_disabledif_equals.

process_change	(	$	changetype,
		$	oldvalue
	)		[final]

Processes a change is setting called by the primary setting

Parameters:

int	$changetype
mixed	$oldvalue

Returns:

bool

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

Here is the call graph for this function:

process_status_change

(

$

oldstatus

)

[abstract, protected]

All dependencies must define how they would like to deal with a status change

Parameters:

int

$oldstatus

Reimplemented in setting_dependency_disabledif_equals2, and setting_dependency_disabledif_equals.

Here is the caller graph for this function:

process_value_change

(

$

oldvalue

)

[abstract, protected]

All dependencies must define how they would like to process a value change

Reimplemented in setting_dependency_disabledif_empty, setting_dependency_disabledif_not_empty, setting_dependency_disabledif_equals2, and setting_dependency_disabledif_equals.

Here is the caller graph for this function:

process_visibility_change

(

$

oldvisibility

)

[protected]

Processes a visibility change

Parameters:

bool

$oldvisibility

Returns:

bool

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

Here is the caller graph for this function:

---

Field Documentation

$defaultvalue [protected]

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

$dependentsetting [protected]

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

$lastvalue [protected]

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

$setting [protected]

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

const DISABLED_CHECKED = 4

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

const DISABLED_EMPTY = 6

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

const DISABLED_FALSE = 3

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

const DISABLED_NOT_CHECKED = 5

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

const DISABLED_NOT_EMPTY = 7

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

const DISABLED_NOT_VALUE = 1

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

const DISABLED_TRUE = 2

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

const DISABLED_VALUE = 0

Used to define the type of a dependency.

Note with these that checked and true, and not checked and false are equal. This is because the terminology differs but the resulting action is the same. Reduces code!

Definition at line 39 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