Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
external_settings Class Reference

Singleton to handle the external settings. More...

Public Member Functions

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

Static Public Member Functions

static get_instance ()
 Return only one instance. More...
 

Static Public Attributes

static object $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
Since
Moodle 2.3

Member Function Documentation

◆ get_file()

external_settings::get_file ( )

Get file.

Return values
string

◆ get_fileurl()

external_settings::get_fileurl ( )

Get fileurl.

Return values
boolean

◆ get_filter()

external_settings::get_filter ( )

Get filter.

Return values
boolean

◆ get_instance()

static external_settings::get_instance ( )
static

Return only one instance.

Return values
external_settings

◆ get_lang()

external_settings::get_lang ( )

Get lang.

Return values
string

◆ get_raw()

external_settings::get_raw ( )

Get raw.

Return values
boolean

◆ set_file()

external_settings::set_file (   $file)

Set file.

Parameters
string$file

◆ set_fileurl()

external_settings::set_fileurl (   $fileurl)

Set fileurl.

Parameters
boolean$fileurl

◆ set_filter()

external_settings::set_filter (   $filter)

Set filter.

Parameters
boolean$filter

◆ set_lang()

external_settings::set_lang (   $lang)

Set lang.

Parameters
string$lang

◆ set_raw()

external_settings::set_raw (   $raw)

Set raw.

Parameters
boolean$raw

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