Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_external Class Reference
Inheritance diagram for core_external:

Static Public Member Functions

static fetch_notifications ($contextid)
 Returns the list of notifications against the current session.
 
static fetch_notifications_parameters ()
 Returns description of fetch_notifications() parameters.
 
static fetch_notifications_returns ()
 Returns description of fetch_notifications() result value.
 
static format_string_parameters ($stringparams)
 Format the received string parameters to be sent to the core get_string() function.
 
static get_component_strings ($component, $lang=null)
 Return all lang strings of a component - call to core get_component_strings().
 
static get_component_strings_parameters ()
 Returns description of get_component_strings parameters.
 
static get_component_strings_returns ()
 Returns description of get_component_strings() result value.
 
static get_fragment ($component, $callback, $contextid, $args=null)
 Get a HTML fragment for inserting into something.
 
static get_fragment_parameters ()
 Returns description of get_fragment parameters.
 
static get_fragment_returns ()
 Returns description of get_fragment() result value.
 
static get_string ($stringid, $component='moodle', $lang=null, $stringparams=array())
 Return a core get_string() call.
 
static get_string_parameters ()
 Returns description of get_string parameters.
 
static get_string_returns ()
 Returns description of get_string() result value.
 
static get_strings ($strings)
 Return multiple call to core get_string()
 
static get_strings_parameters ()
 Returns description of get_string parameters.
 
static get_strings_returns ()
 Returns description of get_string() result value.
 
static get_user_dates ($contextid, $contextlevel, $instanceid, $timestamps)
 Format an array of timestamps.
 
static get_user_dates_parameters ()
 Returns description of get_user_dates parameters.
 
static get_user_dates_returns ()
 Returns description of get_user_dates() result value.
 
static update_inplace_editable ($component, $itemtype, $itemid, $value)
 Update any component's editable value assuming that component implements necessary callback.
 
static update_inplace_editable_parameters ()
 Parameters for function update_inplace_editable()
 
static update_inplace_editable_returns ()
 Return structure for update_inplace_editable()
 

Detailed Description

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

Member Function Documentation

◆ fetch_notifications()

static core_external::fetch_notifications ( $contextid)
static

Returns the list of notifications against the current session.

Return values
array
Since
Moodle 3.1

◆ fetch_notifications_parameters()

static core_external::fetch_notifications_parameters ( )
static

Returns description of fetch_notifications() parameters.

Return values
external_function_parameters
Since
Moodle 3.1

◆ fetch_notifications_returns()

static core_external::fetch_notifications_returns ( )
static

Returns description of fetch_notifications() result value.

Return values
core_external\external_description
Since
Moodle 3.1

◆ format_string_parameters()

static core_external::format_string_parameters ( $stringparams)
static

Format the received string parameters to be sent to the core get_string() function.

Parameters
array$stringparams
Return values
object|string
Since
Moodle 2.4

◆ get_component_strings()

static core_external::get_component_strings ( $component,
$lang = null )
static

Return all lang strings of a component - call to core get_component_strings().

Parameters
string$componentcomponent name
Return values
array
Since
Moodle 2.4

◆ get_component_strings_parameters()

static core_external::get_component_strings_parameters ( )
static

Returns description of get_component_strings parameters.

Return values
external_function_parameters
Since
Moodle 2.4

◆ get_component_strings_returns()

static core_external::get_component_strings_returns ( )
static

Returns description of get_component_strings() result value.

Return values
core_external\external_description
Since
Moodle 2.4

◆ get_fragment()

static core_external::get_fragment ( $component,
$callback,
$contextid,
$args = null )
static

Get a HTML fragment for inserting into something.

Initial use is for inserting mforms into a page using AJAX. This web service is designed to be called only via AJAX and not directly. Callbacks that are called by this web service are responsible for doing the appropriate security checks to access the information returned. This only does minimal validation on the context.

Parameters
string$componentName of the component.
string$callbackFunction callback name.
int$contextidContext ID this fragment is in.
array$argsoptional arguments for the callback.
Return values
arrayHTML and JavaScript fragments for insertion into stuff.
Since
Moodle 3.1

◆ get_fragment_parameters()

static core_external::get_fragment_parameters ( )
static

Returns description of get_fragment parameters.

Return values
external_function_parameters
Since
Moodle 3.1

◆ get_fragment_returns()

static core_external::get_fragment_returns ( )
static

Returns description of get_fragment() result value.

Return values
core_external\external_description
Since
Moodle 3.1

◆ get_string()

static core_external::get_string ( $stringid,
$component = 'moodle',
$lang = null,
$stringparams = array() )
static

Return a core get_string() call.

Parameters
string$identifierstring identifier
string$componentstring component
array$stringparamsthe string params
Return values
string
Since
Moodle 2.4

◆ get_string_parameters()

static core_external::get_string_parameters ( )
static

Returns description of get_string parameters.

Return values
external_function_parameters
Since
Moodle 2.4

◆ get_string_returns()

static core_external::get_string_returns ( )
static

Returns description of get_string() result value.

Return values
core_external\external_description
Since
Moodle 2.4

◆ get_strings()

static core_external::get_strings ( $strings)
static

Return multiple call to core get_string()

Parameters
array$stringsstrings to translate
Return values
array
Since
Moodle 2.4

◆ get_strings_parameters()

static core_external::get_strings_parameters ( )
static

Returns description of get_string parameters.

Return values
external_function_parameters
Since
Moodle 2.4

◆ get_strings_returns()

static core_external::get_strings_returns ( )
static

Returns description of get_string() result value.

Return values
core_external\external_description
Since
Moodle 2.4

◆ get_user_dates()

static core_external::get_user_dates ( $contextid,
$contextlevel,
$instanceid,
$timestamps )
static

Format an array of timestamps.

Parameters
int | null$contextidThe contenxt id
string | null$contextlevelThe context level
int | null$instanceidThe instnace id for the context level
array$timestampsTimestamps to format
Return values
array

◆ get_user_dates_parameters()

static core_external::get_user_dates_parameters ( )
static

Returns description of get_user_dates parameters.

Return values
external_function_parameters

◆ get_user_dates_returns()

static core_external::get_user_dates_returns ( )
static

Returns description of get_user_dates() result value.

Return values
core_external\external_description

◆ update_inplace_editable()

static core_external::update_inplace_editable ( $component,
$itemtype,
$itemid,
$value )
static

Update any component's editable value assuming that component implements necessary callback.

Since
Moodle 3.1
Parameters
string$component
string$itemtype
string$itemid
string$value

◆ update_inplace_editable_parameters()

static core_external::update_inplace_editable_parameters ( )
static

Parameters for function update_inplace_editable()

Since
Moodle 3.1
Return values
external_function_parameters

◆ update_inplace_editable_returns()

static core_external::update_inplace_editable_returns ( )
static

Return structure for update_inplace_editable()

Since
Moodle 3.1
Return values
core_external\external_description

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