mod_data_external Class Reference

Database module external functions. More...

Inheritance diagram for mod_data_external:

Static Public Member Functions
static	add_entry ($databaseid, $groupid, $data)
	Adds a new entry to a database.
static	add_entry_parameters ()
	Returns description of method parameters.
static	add_entry_returns ()
	Returns description of method result value.
static	approve_entry ($entryid, $approve=true)
	Approves or unapproves an entry.
static	approve_entry_parameters ()
	Returns description of method parameters.
static	approve_entry_returns ()
	Returns description of method result value.
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly.
static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute.
static	delete_entry ($entryid)
	Deletes an entry.
static	delete_entry_parameters ()
	Returns description of method parameters.
static	delete_entry_returns ()
	Returns description of method result value.
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information.
static	get_data_access_information ($databaseid, $groupid=0)
	Return access information for a given database.
static	get_data_access_information_parameters ()
	Returns description of method parameters.
static	get_data_access_information_returns ()
	Returns description of method result value.
static	get_databases_by_courses ($courseids=array())
	Returns a list of databases in a provided list of courses, if no list is provided all databases that the user can view will be returned.
static	get_databases_by_courses_parameters ()
	Describes the parameters for get_databases_by_courses.
static	get_databases_by_courses_returns ()
	Describes the get_databases_by_courses return value.
static	get_entries ($databaseid, $groupid=0, $returncontents=false, $sort=null, $order=null, $page=0, $perpage=0)
	Return access information for a given feedback.
static	get_entries_parameters ()
	Returns description of method parameters.
static	get_entries_returns ()
	Returns description of method result value.
static	get_entry ($entryid, $returncontents=false)
	Return one entry record from the database, including contents optionally.
static	get_entry_parameters ()
	Returns description of method parameters.
static	get_entry_returns ()
	Returns description of method result value.
static	get_fields ($databaseid)
	Return the list of configured fields for the given database.
static	get_fields_parameters ()
	Returns description of method parameters.
static	get_fields_returns ()
	Returns description of method result value.
static	search_entries ($databaseid, $groupid=0, $returncontents=false, $search='', $advsearch=[], $sort=null, $order=null, $page=0, $perpage=0)
	Return access information for a given feedback.
static	search_entries_parameters ()
	Returns description of method parameters.
static	search_entries_returns ()
	Returns description of method result value.
static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls.
static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish!
static	update_entry ($entryid, $data)
	Updates an existing entry.
static	update_entry_parameters ()
	Returns description of method parameters.
static	update_entry_returns ()
	Returns description of method result value.
static	validate_context ($context)
	Makes sure user may execute functions in this context.
static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.
static	view_database ($databaseid)
	Simulate the data/view.php web interface page: trigger events, completion, etc...
static	view_database_parameters ()
	Returns description of method parameters.
static	view_database_returns ()
	Returns description of method result value.

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters.
static	get_context_parameters ()
	Returns a prepared structure to use a context parameters.
static	validate_database ($databaseid)
	Utility function for validating a database.

Detailed Description

Database module external functions.

Copyright

2015 Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Since

Moodle 2.9

Member Function Documentation

add_entry()

static mod_data_external::add_entry ( $databaseid, $groupid, $data )

static

Adds a new entry to a database.

Parameters

int	$databaseid	the data instance id
int	$groupid	(optional) group id, 0 means that the function will determine the user group
array	$data	the fields data to be created

Return values

array

of warnings and status result

Since

Moodle 3.3

Exceptions

moodle_exception

add_entry_parameters()

static mod_data_external::add_entry_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

add_entry_returns()

static mod_data_external::add_entry_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

approve_entry()

static mod_data_external::approve_entry ( $entryid, $approve = true )

static

Approves or unapproves an entry.

Parameters

int	$entryid	the record entry id id
bool	$approve	whether to approve (true) or unapprove the entry

Return values

array

of warnings and the entries

Since

Moodle 3.3

Exceptions

moodle_exception

approve_entry_parameters()

static mod_data_external::approve_entry_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

approve_entry_returns()

static mod_data_external::approve_entry_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

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

delete_entry()

static mod_data_external::delete_entry ( $entryid )

static

Deletes an entry.

Parameters

int

$entryid

the record entry id

Return values

array

of warnings success status

Since

Moodle 3.3

Exceptions

moodle_exception

delete_entry_parameters()

static mod_data_external::delete_entry_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

delete_entry_returns()

static mod_data_external::delete_entry_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

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

Exceptions

coding_exception

for any property and/or method that is missing or invalid

Since

Moodle 2.0

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

invalid_parameter_exception

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_data_access_information()

static mod_data_external::get_data_access_information ( $databaseid, $groupid = 0 )

static

Return access information for a given database.

Parameters

int	$databaseid	the database instance id
int	$groupid	(optional) group id, 0 means that the function will determine the user group

Return values

array

of warnings and access information

Since

Moodle 3.3

Exceptions

moodle_exception

get_data_access_information_parameters()

static mod_data_external::get_data_access_information_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

get_data_access_information_returns()

static mod_data_external::get_data_access_information_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

get_databases_by_courses()

static mod_data_external::get_databases_by_courses ( $courseids = array() )

static

Returns a list of databases in a provided list of courses, if no list is provided all databases that the user can view will be returned.

Parameters

array

$courseids

the course ids

Return values

array

the database details

Since

Moodle 2.9

get_databases_by_courses_parameters()

static mod_data_external::get_databases_by_courses_parameters ( )

static

Describes the parameters for get_databases_by_courses.

Return values

external_function_parameters

Since

Moodle 2.9

get_databases_by_courses_returns()

static mod_data_external::get_databases_by_courses_returns ( )

static

Describes the get_databases_by_courses return value.

Return values

external_single_structure

Since

Moodle 2.9

get_entries()

static mod_data_external::get_entries ( $databaseid, $groupid = 0, $returncontents = false, $sort = null, $order = null, $page = 0, $perpage = 0 )

static

Return access information for a given feedback.

Parameters

int	$databaseid	the data instance id
int	$groupid	(optional) group id, 0 means that the function will determine the user group
bool	$returncontents	Whether to return the entries contents or not
str	$sort	sort by this field
int	$order	the direction of the sorting
int	$page	page of records to return
int	$perpage	number of records to return per page

Return values

array

of warnings and the entries

Since

Moodle 3.3

Exceptions

moodle_exception

get_entries_parameters()

static mod_data_external::get_entries_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

get_entries_returns()

static mod_data_external::get_entries_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

get_entry()

static mod_data_external::get_entry ( $entryid, $returncontents = false )

static

Return one entry record from the database, including contents optionally.

Parameters

int	$entryid	the record entry id id
bool	$returncontents	whether to return the entries contents or not

Return values

array

of warnings and the entries

Since

Moodle 3.3

Exceptions

moodle_exception

get_entry_parameters()

static mod_data_external::get_entry_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

get_entry_returns()

static mod_data_external::get_entry_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

get_fields()

static mod_data_external::get_fields ( $databaseid )

static

Return the list of configured fields for the given database.

Parameters

int

$databaseid

the database id

Return values

array

of warnings and the fields

Since

Moodle 3.3

Exceptions

moodle_exception

get_fields_parameters()

static mod_data_external::get_fields_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

get_fields_returns()

static mod_data_external::get_fields_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

search_entries()

static mod_data_external::search_entries ( $databaseid, $groupid = 0, $returncontents = false, $search = '', $advsearch = [], $sort = null, $order = null, $page = 0, $perpage = 0 )

static

Return access information for a given feedback.

Parameters

int	$databaseid	the data instance id
int	$groupid	(optional) group id, 0 means that the function will determine the user group
bool	$returncontents	whether to return contents or not
str	$search	search text
array	$advsearch	advanced search data
str	$sort	sort by this field
int	$order	the direction of the sorting
int	$page	page of records to return
int	$perpage	number of records to return per page

Return values

array

of warnings and the entries

Since

Moodle 3.3

Exceptions

moodle_exception

search_entries_parameters()

static mod_data_external::search_entries_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

search_entries_returns()

static mod_data_external::search_entries_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

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

update_entry()

static mod_data_external::update_entry ( $entryid, $data )

static

Updates an existing entry.

Parameters

int	$entryid	the data instance id
array	$data	the fields data to be created

Return values

array

of warnings and status result

Since

Moodle 3.3

Exceptions

moodle_exception

update_entry_parameters()

static mod_data_external::update_entry_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

update_entry_returns()

static mod_data_external::update_entry_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

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_database()

static mod_data_external::validate_database ( $databaseid )

staticprotected

Utility function for validating a database.

Parameters

int

$databaseid

database instance id

Return values

array

array containing the database object, course, context and course module objects

Since

Moodle 3.3

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_database()

static mod_data_external::view_database ( $databaseid )

static

Simulate the data/view.php web interface page: trigger events, completion, etc...

Parameters

int

$databaseid

the data instance id

Return values

array

of warnings and status result

Since

Moodle 3.3

Exceptions

moodle_exception

view_database_parameters()

static mod_data_external::view_database_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.3

view_database_returns()

static mod_data_external::view_database_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.3

---

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

• mod/data/classes/external.php