core_filters\external Class Reference

This is the external API for the filter component. More...

Inheritance diagram for core_filters\external:

Static Public Member Functions
static	get_available_in_context ($contexts)
	Returns the filters available in the given contexts.
static	get_available_in_context_parameters ()
	Returns description of get_available_in_context() parameters.
static	get_available_in_context_returns ()
	Returns description of get_available_in_context() result value.

Detailed Description

This is the external API for the filter component.

Copyright

2017 Juan Leyva

License

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

Member Function Documentation

get_available_in_context()

static core_filters\external::get_available_in_context ( $contexts )

static

Returns the filters available in the given contexts.

Parameters

array

$contexts

the list of contexts to check

Return values

array

with the filters information and warnings

Since

Moodle 3.4

get_available_in_context_parameters()

static core_filters\external::get_available_in_context_parameters ( )

static

Returns description of get_available_in_context() parameters.

Return values

external_function_parameters

Since

Moodle 3.4

get_available_in_context_returns()

static core_filters\external::get_available_in_context_returns ( )

static

Returns description of get_available_in_context() result value.

Return values

external_single_structure

Since

Moodle 3.4

---

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

• filter/classes/external.php