Inheritance diagram for core_notes_external:

Static Public Member Functions
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly. More...

static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...

static	create_notes ($notes=array())
	Create notes about some users Note: code should be matching the /notes/edit.php checks and the /user/addnote.php checks. More...

static	create_notes_parameters ()
	Returns description of method parameters. More...

static	create_notes_returns ()
	Returns description of method result value. More...

static	delete_notes ($notes=array())
	Delete notes about users. More...

static	delete_notes_parameters ()
	Returns description of delete_notes parameters. More...

static	delete_notes_returns ()
	Returns description of delete_notes result value. More...

static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...

static	get_course_notes ($courseid, $userid=0)
	Get a list of course notes. More...

static	get_course_notes_parameters ()
	Returns description of method parameters. More...

static	get_course_notes_returns ()
	Returns description of method result value. More...

static	get_notes ($notes)
	Get notes about users. More...

static	get_notes_parameters ()
	Returns description of get_notes parameters. More...

static	get_notes_returns ()
	Returns description of get_notes result value. More...

static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls. More...

static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish! More...

static	update_notes ($notes=array())
	Update notes about users. More...

static	update_notes_parameters ()
	Returns description of update_notes parameters. More...

static	update_notes_returns ()
	Returns description of update_notes result value. More...

static	validate_context ($context)
	Makes sure user may execute functions in this context. More...

static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...

static	view_notes ($courseid, $userid=0)
	Simulates the web interface view of notes/index.php: trigger events. More...

static	view_notes_parameters ()
	Returns description of method parameters. More...

static	view_notes_returns ()
	Returns description of method result value. More...

Static Protected Member Functions
static	create_note_list ($courseid, $context, $userid, $state, $author=0)
	Create a notes list. More...

static	get_context_from_params ($param)
	Get context from passed parameters. More...

static	get_context_parameters ()
	Returns a prepared structure to use a context parameters. More...

static	get_note_structure ()
	Returns array of note structure. More...

Member Function Documentation

◆ 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

◆ create_note_list()

static core_notes_external::create_note_list	(	$courseid,
		$context,
		$userid,
		$state,
		$author = `0`
	)

staticprotected

Create a notes list.

Parameters

int	$courseid	ID of the Course
stdClass	$context	context object
int	$userid	ID of the User
int	$state
int	$author

Return values

array of notes

Since: Moodle 2.9

◆ create_notes()

static core_notes_external::create_notes ( $notes = array() )

static

Create notes about some users Note: code should be matching the /notes/edit.php checks and the /user/addnote.php checks.

(they are similar cheks)

Parameters

array $notes An array of notes to create.

Return values

array (success infos and fail infos)

Since: Moodle 2.2

◆ create_notes_parameters()

static core_notes_external::create_notes_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.2

◆ create_notes_returns()

static core_notes_external::create_notes_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.2

◆ delete_notes()

static core_notes_external::delete_notes ( $notes = array() )

static

Delete notes about users.

Note: code should be matching the /notes/delete.php checks.

Parameters

array $notes An array of ids for the notes to delete.

Return values

null

Since: Moodle 2.5

◆ delete_notes_parameters()

static core_notes_external::delete_notes_parameters ( )

static

Returns description of delete_notes parameters.

Return values

external_function_parameters

Since: Moodle 2.5

◆ delete_notes_returns()

static core_notes_external::delete_notes_returns ( )

static

Returns description of delete_notes result value.

Return values

external_description

Since: Moodle 2.5

◆ 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

◆ 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_course_notes()

static core_notes_external::get_course_notes	(	$courseid,
		$userid = `0`
	)

static

Get a list of course notes.

Parameters

int	$courseid	ID of the Course
int	$userid	ID of the User

Return values

array of site, course and personal notes and warnings

Since: Moodle 2.9

Exceptions

moodle_exception

◆ get_course_notes_parameters()

static core_notes_external::get_course_notes_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.9

◆ get_course_notes_returns()

static core_notes_external::get_course_notes_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.9

◆ get_note_structure()

static core_notes_external::get_note_structure ( )

staticprotected

Returns array of note structure.

Return values

external_description

Since: Moodle 2.9

◆ get_notes()

static core_notes_external::get_notes ( $notes )

static

Get notes about users.

Parameters

array $notes An array of ids for the notes to retrieve.

Return values

null

Since: Moodle 2.5

◆ get_notes_parameters()

static core_notes_external::get_notes_parameters ( )

static

Returns description of get_notes parameters.

Return values

external_function_parameters

Since: Moodle 2.5

◆ get_notes_returns()

static core_notes_external::get_notes_returns ( )

static

Returns description of get_notes result value.

Return values

external_description

Since: Moodle 2.5

◆ 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_notes()

static core_notes_external::update_notes ( $notes = array() )

static

Update notes about users.

Parameters

array $notes An array of ids for the notes to update.

Return values

array fail infos.

Since: Moodle 2.2

◆ update_notes_parameters()

static core_notes_external::update_notes_parameters ( )

static

Returns description of update_notes parameters.

Return values

external_function_parameters

Since: Moodle 2.5

◆ update_notes_returns()

static core_notes_external::update_notes_returns ( )

static

Returns description of update_notes result value.

Return values

external_description

Since: Moodle 2.5

◆ 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_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_notes()

static core_notes_external::view_notes	(	$courseid,
		$userid = `0`
	)

static

Simulates the web interface view of notes/index.php: trigger events.

Parameters

int	$courseid	id of the course
int	$userid	id of the user

Return values

array of warnings and status result

Since: Moodle 2.9

Exceptions

moodle_exception

◆ view_notes_parameters()

static core_notes_external::view_notes_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.9

◆ view_notes_returns()

static core_notes_external::view_notes_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.9

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

notes/externallib.php

Static Public Member Functions

Static Protected Member Functions

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ create_note_list()

◆ create_notes()

◆ create_notes_parameters()

◆ create_notes_returns()

◆ delete_notes()

◆ delete_notes_parameters()

◆ delete_notes_returns()

◆ external_function_info()

◆ get_context_from_params()

◆ get_context_parameters()

◆ get_course_notes()

◆ get_course_notes_parameters()

◆ get_course_notes_returns()

◆ get_note_structure()

◆ get_notes()

◆ get_notes_parameters()

◆ get_notes_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ update_notes()

◆ update_notes_parameters()

◆ update_notes_returns()

◆ validate_context()

◆ validate_parameters()

◆ view_notes()

◆ view_notes_parameters()

◆ view_notes_returns()