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

Step configuration detail class. More...

Static Public Member Functions

static get_default_value ($key)
 Get the default value for the specified key. More...
 
static get_defaultable_keys ()
 Get the list of keys which can be defaulted in the tour. More...
 
static get_placement_options ($default=null)
 Get the list of possible placement options. More...
 
static get_step_default_value ($key)
 Get the default value for the specified key for the step form. More...
 

Public Attributes

TOURDEFAULT const TOURDEFAULT = 'usetourdefault'
 

Detailed Description

Step configuration detail class.

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

Member Function Documentation

◆ get_default_value()

static tool_usertours\configuration::get_default_value (   $key)
static

Get the default value for the specified key.

Parameters
string$keyThe key for the specified value
Return values
mixed

◆ get_defaultable_keys()

static tool_usertours\configuration::get_defaultable_keys ( )
static

Get the list of keys which can be defaulted in the tour.

Return values
array

◆ get_placement_options()

static tool_usertours\configuration::get_placement_options (   $default = null)
static

Get the list of possible placement options.

Parameters
string$defaultThe default option.
Return values
array

◆ get_step_default_value()

static tool_usertours\configuration::get_step_default_value (   $key)
static

Get the default value for the specified key for the step form.

Parameters
string$keyThe key for the specified value
Return values
mixed

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