Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
core_external\external_settings Class Reference

Singleton to handle the external settings. More...

Public Member Functions

 get_file ()
 Get file.
 
 get_fileurl ()
 Get fileurl.
 
 get_filter ()
 Get filter.
 
 get_lang ()
 Get lang.
 
 get_raw ()
 Get raw.
 
 get_timezone ()
 Get timezone.
 
 set_file ($file)
 Set file.
 
 set_fileurl ($fileurl)
 Set fileurl.
 
 set_filter ($filter)
 Set filter.
 
 set_lang ($lang)
 Set lang.
 
 set_raw ($raw)
 Set raw.
 
 set_timezone ($timezone)
 Set timezone.
 

Static Public Member Functions

static get_instance ()
 Return only one instance.
 
static reset ()
 Reset the singleton instance.
 

Static Public Attributes

static settings null $instance = null
 the singleton instance
 

Protected Member Functions

 __construct ()
 Constructor - protected - can not be instanciated.
 

Detailed Description

Singleton to handle the external settings.

We use singleton to encapsulate the "logic".

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

Member Function Documentation

◆ get_file()

core_external\external_settings::get_file ( )

Get file.

Return values
string

◆ get_fileurl()

core_external\external_settings::get_fileurl ( )

Get fileurl.

Return values
bool

◆ get_filter()

core_external\external_settings::get_filter ( )

Get filter.

Return values
boolean

◆ get_instance()

static core_external\external_settings::get_instance ( )
static

Return only one instance.

Return values
self

◆ get_lang()

core_external\external_settings::get_lang ( )

Get lang.

Return values
string

◆ get_raw()

core_external\external_settings::get_raw ( )

Get raw.

Return values
boolean

◆ get_timezone()

core_external\external_settings::get_timezone ( )

Get timezone.

Return values
string

◆ set_file()

core_external\external_settings::set_file ( $file)

Set file.

Parameters
string$file

◆ set_fileurl()

core_external\external_settings::set_fileurl ( $fileurl)

Set fileurl.

Parameters
bool$fileurl

◆ set_filter()

core_external\external_settings::set_filter ( $filter)

Set filter.

Parameters
boolean$filter

◆ set_lang()

core_external\external_settings::set_lang ( $lang)

Set lang.

Parameters
string$lang

◆ set_raw()

core_external\external_settings::set_raw ( $raw)

Set raw.

Parameters
boolean$raw

◆ set_timezone()

core_external\external_settings::set_timezone ( $timezone)

Set timezone.

Parameters
string$timezone

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