[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/backup/util/settings/ -> setting_dependency.class.php (summary)

(no description)

Copyright: 2010 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 610 lines (23 kb)
Included or required:0 times
Referenced: 4 times
Includes or requires: 0 files

Defines 7 classes

setting_dependency_disabledif_equals:: (6 methods):
  __construct()
  is_locked()
  process_value_change()
  process_status_change()
  enforce()
  get_moodleform_properties()

setting_dependency_disabledif_not_equals:: (2 methods):
  enforce()
  get_moodleform_properties()

setting_dependency_disabledif_equals2:: (6 methods):
  __construct()
  is_locked()
  process_value_change()
  process_status_change()
  enforce()
  get_moodleform_properties()

setting_dependency_disabledif_checked:: (2 methods):
  __construct()
  get_moodleform_properties()

setting_dependency_disabledif_not_checked:: (2 methods):
  __construct()
  get_moodleform_properties()

setting_dependency_disabledif_not_empty:: (4 methods):
  __construct()
  get_moodleform_properties()
  process_value_change()
  is_locked()

setting_dependency_disabledif_empty:: (4 methods):
  __construct()
  get_moodleform_properties()
  process_value_change()
  is_locked()

Defines 4 functions

  __construct()
  destroy()
  process_change()
  process_visibility_change()
  get_setting()
  get_dependent_setting()

Class: setting_dependency_disabledif_equals  - X-Ref

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

__construct(base_setting $setting, base_setting $dependentsetting, $value, $defaultvalue = false)   X-Ref
Creates the dependency

param: base_setting $setting
param: base_setting $dependentsetting
param: mixed $value
param: mixed $defaultvalue

is_locked()   X-Ref
Returns true if the dependent setting is locked.

return: bool

process_value_change($oldvalue)   X-Ref
Processes a value change in the primary setting

param: mixed $oldvalue
return: bool

process_status_change($oldstatus)   X-Ref
Processes a status change in the primary setting

param: mixed $oldstatus
return: bool

enforce()   X-Ref
Enforces the dependency if required.

return: bool True if there were changes

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

Class: setting_dependency_disabledif_not_equals  - X-Ref

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

enforce()   X-Ref
Enforces the dependency if required.

return: bool True if there were changes

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

Class: setting_dependency_disabledif_equals2  - X-Ref

__construct(base_setting $setting, base_setting $dependentsetting, array $value, $defaultvalue = false)   X-Ref
Creates the dependency

param: base_setting $setting
param: base_setting $dependentsetting
param: mixed $value
param: mixed $defaultvalue

is_locked()   X-Ref
Returns true if the dependent setting is locked.

return: bool

process_value_change($oldvalue)   X-Ref
Processes a value change in the primary setting

param: mixed $oldvalue
return: bool

process_status_change($oldstatus)   X-Ref
Processes a status change in the primary setting

param: mixed $oldstatus
return: bool

enforce()   X-Ref
Enforces the dependency if required.

return: bool True if there were changes

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

Class: setting_dependency_disabledif_checked  - X-Ref

A dependency that disables the secondary element if the primary element is
true or checked

__construct(base_setting $setting, base_setting $dependentsetting, $defaultvalue = false)   X-Ref
No description

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

Class: setting_dependency_disabledif_not_checked  - X-Ref

A dependency that disables the secondary element if the primary element is
false or not checked

__construct(base_setting $setting, base_setting $dependentsetting, $defaultvalue = false)   X-Ref
No description

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

Class: setting_dependency_disabledif_not_empty  - X-Ref

A dependency that disables the secondary setting if the value of the primary setting
is not empty.

__construct(base_setting $setting, base_setting $dependentsetting, $defaultvalue = false)   X-Ref
No description

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

process_value_change($oldvalue)   X-Ref
Processes a value change in the primary setting

param: mixed $oldvalue
return: bool

is_locked()   X-Ref
Returns true if the dependent setting is locked.

return: bool

Class: setting_dependency_disabledif_empty  - X-Ref

A dependency that disables the secondary setting if the value of the primary setting
is empty.

__construct(base_setting $setting, base_setting $dependentsetting, $defaultvalue = false)   X-Ref
No description

get_moodleform_properties()   X-Ref
Returns an array of properties suitable to be used to define a moodleforms
disabled command

return: array

process_value_change($oldvalue)   X-Ref
Processes a value change in the primary setting

param: mixed $oldvalue
return: bool

is_locked()   X-Ref
Returns true if the dependent setting is locked.

return: bool

Functions
Functions that are not part of a class:

__construct(base_setting $setting, base_setting $dependentsetting, $defaultvalue = false)   X-Ref
Creates the dependency object

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

destroy()   X-Ref
Destroy all circular references. It helps PHP 5.2 a lot!


process_change($changetype, $oldvalue)   X-Ref
Processes a change is setting called by the primary setting

param: int $changetype
param: mixed $oldvalue
return: bool

process_visibility_change($oldvisibility)   X-Ref
Processes a visibility change

param: bool $oldvisibility
return: bool

get_setting()   X-Ref
Gets the primary setting

return: backup_setting

get_dependent_setting()   X-Ref
Gets the dependent setting

return: backup_setting



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1