Moodle APIs: mod_glossary_external Class Reference

Since: Moodle 3.2

◆ add_entry_returns()

static mod_glossary_external::add_entry_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.2

◆ call_external_function()

static external_api::call_external_function	(	$function,
		$args,
		$ajaxonly = `false`
	)

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array containing keys for error (bool), exception and data.

◆ clean_returnvalue()

static external_api::clean_returnvalue	(	external_description	$description,
			$response
	)

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author: 2010 Jerome Mouneyrac

Since: Moodle 2.0

◆ external_function_info()

static external_api::external_function_info	(	$function,
		$strictness = `MUST_EXIST`
	)

staticinherited

Returns detailed function information.

Parameters

string \| object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass description or false if not found or exception thrown

Since: Moodle 2.0

◆ fill_entry_details()

static mod_glossary_external::fill_entry_details	(	$entry,
		$context
	)

staticprotected

Fill in an entry object.

This adds additional required fields for the external function to return.

Parameters

stdClass	$entry	The entry.
context	$context	The context the entry belongs to.

Return values

void

◆ get_authors()

static mod_glossary_external::get_authors	(	$id,
		$from,
		$limit,
		$options
	)

static

Get the authors of a glossary.

Parameters

int	$id	The glossary ID.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, authors and warnings.

Since: Moodle 3.1

Exceptions

◆ get_authors_parameters()

static mod_glossary_external::get_authors_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_authors_returns()

static mod_glossary_external::get_authors_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_browse_modes_from_display_format()

static mod_glossary_external::get_browse_modes_from_display_format ( $format )

staticprotected

Get the browse modes from the display format.

This returns some of the terms that can be used when reporting a glossary being viewed.

Parameters

string $format The display format of the glossary.

Return values

array Containing some of all of the following: letter, cat, date, author.

◆ get_categories()

static mod_glossary_external::get_categories	(	$id,
		$from,
		$limit
	)

static

Get the categories of a glossary.

Parameters

int	$id	The glossary ID.
int	$from	Start returning records from here.
int	$limit	Number of records to return.

Return values

array Containing count, categories and warnings.

Since: Moodle 3.1

Exceptions

◆ get_categories_parameters()

static mod_glossary_external::get_categories_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_categories_returns()

static mod_glossary_external::get_categories_returns ( )

static

Returns the description of the external function return value.

Return values

invalid_parameter_exception

Since: Moodle 3.1

◆ get_context_from_params()

static external_api::get_context_from_params ( $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters

array $param

Since: Moodle 2.6

Exceptions

Return values

context

◆ get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in core_competency\external, and tool_lp\external.

◆ get_entries_by_author()

static mod_glossary_external::get_entries_by_author	(	$id,
		$letter,
		$field,
		$sort,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries by author.

Parameters

int	$id	The glossary ID.
string	$letter	A letter, or a special keyword.
string	$field	The field to search from.
string	$sort	The direction of the order.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entries_by_author_id()

static mod_glossary_external::get_entries_by_author_id	(	$id,
		$authorid,
		$order,
		$sort,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries by author.

Parameters

int	$id	The glossary ID.
int	$authorid	The author ID.
string	$order	The way to order the results.
string	$sort	The direction of the order.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entries_by_author_id_parameters()

static mod_glossary_external::get_entries_by_author_id_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_author_id_returns()

static mod_glossary_external::get_entries_by_author_id_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_by_author_parameters()

static mod_glossary_external::get_entries_by_author_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_author_returns()

static mod_glossary_external::get_entries_by_author_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_by_category()

static mod_glossary_external::get_entries_by_category	(	$id,
		$categoryid,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries by category.

Parameters

int	$id	The glossary ID.
int	$categoryid	The category ID.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entries_by_category_parameters()

static mod_glossary_external::get_entries_by_category_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_category_returns()

static mod_glossary_external::get_entries_by_category_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_by_date()

static mod_glossary_external::get_entries_by_date	(	$id,
		$order,
		$sort,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries by date.

Parameters

int	$id	The glossary ID.
string	$order	The way to order the records.
string	$sort	The direction of the order.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entries_by_date_parameters()

static mod_glossary_external::get_entries_by_date_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_date_returns()

static mod_glossary_external::get_entries_by_date_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_by_letter()

static mod_glossary_external::get_entries_by_letter	(	$id,
		$letter,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries by letter.

Parameters

int	$id	The glossary ID.
string	$letter	A letter, or a special keyword.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entries_by_letter_parameters()

static mod_glossary_external::get_entries_by_letter_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_letter_returns()

static mod_glossary_external::get_entries_by_letter_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_by_search()

static mod_glossary_external::get_entries_by_search	(	$id,
		$query,
		$fullsearch,
		$order,
		$sort,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries using the search.

Parameters

int	$id	The glossary ID.
string	$query	The search query.
bool	$fullsearch	Whether or not full search is required.
string	$order	The way to order the results.
string	$sort	The direction of the order.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entries_by_search_parameters()

static mod_glossary_external::get_entries_by_search_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_search_returns()

static mod_glossary_external::get_entries_by_search_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_by_term()

static mod_glossary_external::get_entries_by_term	(	$id,
		$term,
		$from,
		$limit,
		$options
	)

static

Browse a glossary entries using a term matching the concept or alias.

Parameters

int	$id	The glossary ID.
string	$term	The term.
int	$from	Start returning records from here.
int	$limit	Number of records to return.
array	$options	Array of options.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

◆ get_entries_by_term_parameters()

static mod_glossary_external::get_entries_by_term_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_by_term_returns()

static mod_glossary_external::get_entries_by_term_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entries_to_approve()

static mod_glossary_external::get_entries_to_approve	(	$id,
		$letter,
		$order,
		$sort,
		$from,
		$limit
	)

static

Browse a glossary entries using a term matching the concept or alias.

Parameters

int	$id	The glossary ID.
string	$letter	A letter, or a special keyword.
string	$order	The way to order the records.
string	$sort	The direction of the order.
int	$from	Start returning records from here.
int	$limit	Number of records to return.

Return values

array Containing count, entries and warnings.

Since: Moodle 3.1

Exceptions

◆ get_entries_to_approve_parameters()

static mod_glossary_external::get_entries_to_approve_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entries_to_approve_returns()

static mod_glossary_external::get_entries_to_approve_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entry_by_id()

static mod_glossary_external::get_entry_by_id ( $id )

static

Get an entry.

Parameters

int $id The entry ID.

Return values

array Containing entry and warnings.

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ get_entry_by_id_parameters()

static mod_glossary_external::get_entry_by_id_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ get_entry_by_id_returns()

static mod_glossary_external::get_entry_by_id_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ get_entry_return_structure()

static mod_glossary_external::get_entry_return_structure ( $includecat = false )

staticprotected

Get the return value of an entry.

Parameters

bool $includecat Whether the definition should include category info.

Return values

external_definition

◆ get_glossaries_by_courses()

static mod_glossary_external::get_glossaries_by_courses ( $courseids = array() )

static

Returns a list of glossaries in a provided list of courses.

If no list is provided all glossaries that the user can view will be returned.

Parameters

array $courseids the course IDs.

Return values

array of glossaries

Since: Moodle 3.1

◆ get_glossaries_by_courses_parameters()

static mod_glossary_external::get_glossaries_by_courses_parameters ( )

static

Describes the parameters for get_glossaries_by_courses.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_glossaries_by_courses_returns()

static mod_glossary_external::get_glossaries_by_courses_returns ( )

static

Describes the get_glossaries_by_courses return value.

Return values

Since: Moodle 3.1

◆ set_context_restriction()

static external_api::set_context_restriction ( $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass $context the context restriction

Since: Moodle 2.0

◆ set_timeout()

static external_api::set_timeout ( $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int $seconds max expected time the next operation needs

Since: Moodle 2.0

◆ validate_context()

static external_api::validate_context ( $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass $context

Since: Moodle 2.0

◆ validate_glossary()

static mod_glossary_external::validate_glossary ( $id )

staticprotected

Validate a glossary via ID.

Parameters

int $id The glossary ID.

Return values

array Contains glossary, context, course and cm.

◆ validate_parameters()

static external_api::validate_parameters	(	external_description	$description,
			$params
	)

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since: Moodle 2.0

◆ view_entry()

static mod_glossary_external::view_entry ( $id )

static

Notify that the entry was viewed.

Parameters

int $id The entry ID.

Return values

array of warnings and status result

Since: Moodle 3.1

Exceptions

moodle_exception
invalid_parameter_exception

◆ view_entry_parameters()

static mod_glossary_external::view_entry_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ view_entry_returns()

static mod_glossary_external::view_entry_returns ( )

static

Returns the description of the external function return value.

Return values

Since: Moodle 3.1

◆ view_glossary()

static mod_glossary_external::view_glossary	(	$id,
		$mode
	)

static

Notify that the course module was viewed.

Parameters

int	$id	The glossary instance ID.
string	$mode	The view mode.

Return values

array of warnings and status result

Since: Moodle 3.1

Exceptions

◆ view_glossary_parameters()

static mod_glossary_external::view_glossary_parameters ( )

static

Returns the description of the external function parameters.

Return values

Since: Moodle 3.1

◆ view_glossary_returns()

static mod_glossary_external::view_glossary_returns ( )

static

Returns the description of the external function return value.

Return values