Files external functions. More...

Inheritance diagram for core_files_external:

Static Public Member Functions
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	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information.

static	get_files ($contextid, $component, $filearea, $itemid, $filepath, $filename, $modified=null, $contextlevel=null, $instanceid=null)
	Return moodle files listing.

static	get_files_parameters ()
	Returns description of get_files parameters.

static	get_files_returns ()
	Returns description of get_files returns.

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	upload ($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent, $contextlevel, $instanceid)
	Uploading a file to moodle.

static	upload_parameters ()
	Returns description of upload parameters.

static	upload_returns ()
	Returns description of upload returns.

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 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.

Detailed Description

Files external functions.

Copyright: 2011 Jerome Mouneyrac

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

Since: Moodle 2.2

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

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

static core_files_external::get_files	(	$contextid,
		$component,
		$filearea,
		$itemid,
		$filepath,
		$filename,
		$modified = null,
		$contextlevel = null,
		$instanceid = null )

static

Return moodle files listing.

Parameters

int	$contextid	context id
int	$component	component
int	$filearea	file area
int	$itemid	item id
string	$filepath	file path
string	$filename	file name
int	$modified	timestamp to return files changed after this time.
string	$contextlevel	The context level for the file location.
int	$instanceid	The instance id for where the file is located.

Return values

array

Since: Moodle 2.9 Returns additional fields (timecreated, filesize, author, license); Moodle 2.2

◆ get_files_parameters()

static core_files_external::get_files_parameters ( )

static

Returns description of get_files parameters.

Return values

external_function_parameters

Since: Moodle 2.2

◆ get_files_returns()

static core_files_external::get_files_returns ( )

static

Returns description of get_files returns.

Return values

external_single_structure

Since: Moodle 2.9 Returns additional fields for files (timecreated, filesize, author, license); Moodle 2.2

◆ 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

◆ upload()

static core_files_external::upload	(	$contextid,
		$component,
		$filearea,
		$itemid,
		$filepath,
		$filename,
		$filecontent,
		$contextlevel,
		$instanceid )

static

Uploading a file to moodle.

Parameters

int	$contextid	context id
string	$component	component
string	$filearea	file area
int	$itemid	item id
string	$filepath	file path
string	$filename	file name
string	$filecontent	file content
string	$contextlevel	Context level (block, course, coursecat, system, user or module)
int	$instanceid	Instance id of the item associated with the context level

Return values

array

Since: Moodle 2.2

◆ upload_parameters()

static core_files_external::upload_parameters ( )

static

Returns description of upload parameters.

Return values

external_function_parameters

Since: Moodle 2.2

◆ upload_returns()

static core_files_external::upload_returns ( )

static

Returns description of upload returns.

Return values

external_single_structure

Since: Moodle 2.2

◆ 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

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

files/externallib.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ external_function_info()

◆ get_context_from_params()

◆ get_context_parameters()

◆ get_files()

◆ get_files_parameters()

◆ get_files_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ upload()

◆ upload_parameters()

◆ upload_returns()

◆ validate_context()

◆ validate_parameters()