Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
admin_settingdependency Class Reference

Used to store details of the dependency between two settings elements. More...

Public Member Functions

 __construct ($settingname, $dependenton, $condition, $value)
 admin_settingdependency constructor. More...
 

Static Public Member Functions

static prepare_for_javascript ($dependencies)
 Gather together all the dependencies in a format suitable for initialising javascript. More...
 

Public Attributes

string $condition
 the condition to show/hide the element
 
string $dependenton
 the setting this is dependent on
 
string $settingname
 the name of the setting to be shown/hidden
 
string $value
 the value to compare against
 

Detailed Description

Used to store details of the dependency between two settings elements.

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

Constructor & Destructor Documentation

◆ __construct()

admin_settingdependency::__construct (   $settingname,
  $dependenton,
  $condition,
  $value 
)

admin_settingdependency constructor.

Parameters
string$settingname
string$dependenton
string$condition
string$value
Exceptions
coding_exception

Member Function Documentation

◆ prepare_for_javascript()

static admin_settingdependency::prepare_for_javascript (   $dependencies)
static

Gather together all the dependencies in a format suitable for initialising javascript.

Parameters
admin_settingdependency[]$dependencies
Return values
array

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