https://docs.moodle.org/dev/api.php?action=feedcontributions&feedformat=atom&user=Cameron1729
MoodleDocs - User contributions [en]
2026-07-29T10:15:25Z
User contributions
MediaWiki 1.43.5
https://docs.moodle.org/dev/index.php?title=Deprecation&diff=61236
Deprecation
2021-09-08T06:16:53Z
<p>Cameron1729: Added a point about moving/renaming classes</p>
<hr />
<div>== What is deprecation? ==<br />
[http://en.wikipedia.org/wiki/Deprecation Deprecation], in its programming sense, is the process of taking older code and marking it as no longer being useful within the codebase, usually because it has been superseded by newer code. The deprecated code is not immediately removed from the codebase because doing so may cause regression errors.<br />
== Why is deprecation needed? ==<br />
In an open source project, the end use of the codebase varies. People may have customisations and plugins that depend on a function that has been targeted for deprecation. Rather than simply removing a function, we must gracefully deprecate the function over a period covered by a number of released versions.<br />
== What is Moodle's deprecation policy? ==<br />
* Deprecations should only be on master, not on stables (exceptions may be made for some external service integrations)<br />
* Deprecations apply to all public APIs, classes, and files.<br />
* Removal of a function, class, or file may only be considered after a minimum of 4 major releases since the deprecation. Example: anything deprecated in 3.2 means that it will be removed in 3.6<br />
* All deprecations should emit debugging notices where possible<br />
* All deprecations should be noted in the relevant upgrade.txt<br />
== Moodle Core deprecation process ==<br />
Once it is decided that a function should be deprecated, a two-step process should be followed.<br />
<br />
Note that both steps should always happen as earlier as possible in the 6-months period between major releases, so all developers will have time to adjust their code and ensure it will work in the next release. Obviously, no changes will be allowed after code freeze (the APIs must remain 100% unmodified after it).<br />
=== Step 1. Immediate action ===<br />
Deprecation affects only the current master version, in other words, the deprecation only becomes effective after the next [[Releases|major release]].<br />
* If the function is not a member of a class (in other words, it is an independent function), it should be moved, with its PHPDoc and all comments, to ''lib/deprecatedlib.php'', which is included everywhere. If the function is a class member, it will need to be deprecated in its current location.<br />
** Deprecated behat step definitions should be moved to lib/tests/behat/behat_deprecated.php, including a call to behat_deprecated::deprecated_message() proposing an alternative to the deprecated method.<br />
* If an entire class is being moved (for example, moving multiple class definitions from a monolithic file in to individual files), follow the process for [[Plugin files#db.2Frenamedclasses.php|renaming classes]].<br />
* A debugging message should be added to the function so that, when [[:en:Debugging|developer debugging mode]] is on, attention is drawn to the deprecation. The message should state that the function being called has been deprecated. The message should help a developer whose code currently calls the function that has gone. Tell them what they should do instead.<br />
debugging('foobar() is deprecated. Please use foobar::blah() instead.', DEBUG_DEVELOPER);<br />
* If the deprecated function has been replaced with a new function, ideally the new function should be called from the deprecated function, so that the new functionality is used. This will make maintenance easier moving forward.<br />
* A <tt>@deprecated</tt> tag should be added to the PHPDoc for the function description so that IDEs describing the function will note that it is deprecated, documenting which version it was deprecated in and the MDL issue associated with it. See the guidelines in [[Coding_style#.40deprecated_.28and_.40todo.29]].<br />
* If the function is an external function, then an additional deprecation-specific method needs to be created and set to return true. See the docs on that process here: https://docs.moodle.org/dev/Adding_a_web_service_to_a_plugin#Deprecation. You should continue to add the <tt>@deprecated since x.x</tt> tag to the docs of all three of the relevant external methods (parameters, main method, returns) to make it clear to IDEs that the function is deprecated.<br />
* There will need to be an issue associated with the initial part of the deprecation. A second issue needs to be created to finish the job. The first issue will be linked to second issue. The second issue needs to be a sub-task of an appropriate [https://tracker.moodle.org/issues/?jql=%28summary%20~%20%22meta%22%20or%20type%20%3D%20Epic%29%20AND%20summary%20~%20%22together%20deprecated%22%20order%20by%20created&runQuery=true&clear=true deprecation META]. For example, if the current version is 3.1.2, the function will be marked as deprecated in 3.2 and should normally be removed for 3.6, so the second issue should be an issue in a deprecation epic for the 3.6 version (MDL-54740). This second issue should include instructions on how to remove the function so that when it comes time to do so, the task is trivial for any developer.<br />
* A <tt>@todo</tt> tag can be added linking to the issues created for further action. (optional)<br />
* A <tt>@see</tt> tag can be added to point to the new apis that can be used. (optional)<br />
* Check the body of the function being deprecated and look for additional function calls which have no other non-deprecated uses and may also be considered for deprecation. If they belong to the same code area they can be deprecated in the same issue.<br />
* Last but not least, every deprecation should be documented in the corresponding upgrade.txt files '''at least''' once but, '''ideally''', both on this initial/immediate deprecation and also on the final deprecation/removal.<br />
Longer deprecation periods can be considered for functions that are widely used.<br />
=== Step 2. Final deprecation ===<br />
* If a function has been marked as deprecated for 3.x (eg. 3.1) and set for removal at 3.x+4 (eg. 3.5), soon after the release of 3.x+3.1 (eg. 3.4.1), the 3.x+4 deprecation META will be processed. This means that the deprecated function will undergo final deprecation before 3.x+4, but only in the master version. This allows any potential regressions caused by the final deprecation of the function to be exposed as soon as possible.<br />
* When a function undergoes final deprecation, all content of the function should be removed. In the skeleton that remains, an error statement should be included that indicates that the function cannot be used anymore. You can also direct developers to the new function(s) in this message.<br />
throw new coding_exception('check_potential_filename() can not be used any more, please use new file API');<br />
* All function parameters should be removed<br />
* The content of the PHPDoc should be removed, leaving only the <tt>@deprecated</tt> tag with the notice and, optionally, the replacement information. This includes all <tt>@param</tt>, <tt>@return</tt>, and other tags, as well as the description.<br />
* External functions deprecation process is different from the standard deprecation and functions should be completely removed.<br />
* Last but not least, every deprecation should be documented in the corresponding upgrade.txt files '''at least''' once but, '''ideally''', both on the initial/immediate deprecation and also on this final deprecation/removal.<br />
== See also... ==<br />
* [[String deprecation]]<br />
* [[Process]]<br />
* [[Release process]]<br />
[[Category:Processes]]<br />
[[Category:Core development]]</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=File_System_API&diff=52788
File System API
2017-08-01T03:34:34Z
<p>Cameron1729: /* Introduction */</p>
<hr />
<div>{{Moodle 3.3}}<br />
As standard Moodle uses the locally available file system for all files.<br />
Since Moodle 3.3 it is possible to extend the file system component of the File Storage API to support alternative File Systems.<br />
<br />
== Introduction ==<br />
<br />
Moodle ships with a file system API which enables the internal Moodle File Storage system to set, and retrieve files, and file content.<br />
The standard file system implementation uses the Moodle filedir, which is a locally available directory on disk, and which can be shared between clustered servers via network file systems such as NFS.<br />
<br />
Since Moodle 3.3 it is possible to use alternative file systems, including remote file systems. These are easy to setup and configure, and allow for greater scalability which does not depends so heavily upon traditional network file systems. See config-dist.php for more details. <br />
<br />
Please note that the file *must* exist remotely and a local file is *optional*. The remote file is seen as canonical and this system is *not* designed to be used to cater to a split brain solution where some files are present in one place, and some files are present in another.<br />
<br />
All files accessed via the standard File Storage API is processed using this API, however the existing tempdir, cachedir, and localcachedir parameters remain separate.<br />
<br />
== Defining a new filesystem ==<br />
<br />
All file system implementations must extend the <code>file_system</code> class, and define the required abstract functions.<br />
<br />
It is entirely up to the individual implementation how it handles storage, saving, and retrieval of files from it's file system, however certain key concepts apply.<br />
<br />
=== Concepts ===<br />
<br />
==== Moodle File API ====<br />
<br />
The Moodle File API is broken into different components, each having a related but fundamentally separate purpose.<br />
<br />
===== File Storage API =====<br />
<br />
The File Storage API is responsible for all interactions with the rest of Moodle.<br />
<br />
Files can be accessed using this API.<br />
<br />
===== Stored File =====<br />
<br />
Any file stored in Moodle's File Storage can be represented as a <code>stored_file</code>.<br />
<br />
The <code>stored_file</code> class holds various metadata about the files in the repository.<br />
<br />
==== Content Hash ====<br />
<br />
The Moodle File Storage API performs de-duplication by generating a '''checksum''' of the content of the file.<br />
The checksum can be generated using the '''file_storage::hash_from_path''' and '''file_storage::hash_from_string''' functions.<br />
<br />
This checksum, referred to as a '''Content Hash''' (typically <code>$contenthash</code>) is stored for each file in the Moodle File Storage Database tables.<br />
<br />
Files are always referred to using this content hash, and can be both stored and fetched using it.<br />
<br />
Helper functions allow conversion of <code>stored_file</code> objects into a content hash.<br />
<br />
==== Distinction between local and remote file paths ====<br />
<br />
The file system API makes the distinction between a '''local''', and a '''remote''' file path.<br />
<br />
''Local'' file paths '''''must''''' be capable of existing on disk.<br />
''Remote'' file paths may be either the valid local path, or a [http://au1.php.net/manual/en/wrappers.php:Supported Protocol].<br />
<br />
'''''Note:''''' Several functions offer a <code>$fetchifnotfound</code><br />
option.<br />
This is particularly useful when dealing with remote file systems which do not keep a local copy of the file on disk.<br />
These functions should only be called with a truthful value '''if the file is required locally'''.<br />
<br />
It is also advisable when dealing with remote file systems to initially store the file on disk in this path as there is a strong possibility that subsequent actions will attempt to read the file further - for example, in order to generate an image thumbnail.<br />
<br />
===== Local file paths =====<br />
<br />
Local file paths '''''must''''' be formatted as a standard local file path. They '''''must not''''' be a streamable URL.<br />
This is because some PHP functions are unable to work with seekable, or streamable resources and can '''only''' work with local files.<br />
These include, but are not limited to:<br />
* The <code>ZipArchive</code> used in the <code>zip_packer</code>; and<br />
* <code>curl_file_create</code>, used to add files to a curl request; and<br />
* <code>finfo</code>, used to determine mime information about files.<br />
<br />
Additionally there are some cases which may suffer performance issues when dealing with streamable files. This includes:<br />
* <code>getimagesize()</code> which must fetch the entire image first in order to determine size.<br />
===== Remote file paths =====<br />
<br />
Remote file paths '''may''' be formatted as a standard local file path. They '''may''' be a streamable URL.<br />
<br />
See the PHP documentation on [http://au1.php.net/manual/en/wrappers.php:Supported Protocols] for more information on the accepted formats.<br />
<br />
Remote files may be passed into PHP functions such as:<br />
* <code>file_get_contents</code>; and<br />
* <code>readfile</code>.<br />
<br />
=== Explanation of required functions ===<br />
<br />
==== setup_instance ====<br />
<br />
The <code>setup_instance()</code> function is called during instantiation and allows you to setup any required configuration for your file system implementation.<br />
<br />
An example implementation might look like:<br />
<code><br />
protected function setup_instance() {<br />
// Setup the client.<br />
self::$client = new Awesome\Remote\File\Storage\System();<br />
<br />
// Create a directory for use during the current request.<br />
// This directory will be automatically removed at the end of the request.<br />
self::$filedir = make_request_directory();<br />
}<br />
</code><br />
<br />
==== get_local_filepath_from_hash ====<br />
<br />
The <code>get_local_filepath_from_hash</code> function is responsible for returning the correct path to the file in disk.<br />
<br />
This path must be consistent for each contenthash.<br />
<br />
The file '''does not''' need to exist on disk unless the <code>$fetchifnotfound</code> parameter is truthy.<br />
<br />
An example implementation might look like:<br />
<code><br />
protected function get_local_path_from_hash($contenthash, $fetchifnotfound = false) {<br />
$path = self::$filedir . DIRECTORY_SEPARATOR . $contenthash;<br />
<br />
if ($fetchifnotfound && !is_readable($path)) {<br />
$this->fetch_local_copy($contenthash, $path);<br />
}<br />
<br />
return $path;<br />
}<br />
</code><br />
<br />
==== get_remote_filepath_from_hash =====<br />
<br />
The <code>get_remote_filepath_from_hash($contenthash)</code> function is responsible for returning the correct path to the file.<br />
<br />
The returned path must be in either:<br />
* a local file format; or<br />
* a remote file path as per the [http://au1.php.net/manual/en/wrappers.php:Supported Protocol] documentation.<br />
<br />
Remote paths should not be passed outside of the File System implementation.<br />
<br />
An example implementation might look like:<br />
<code><br />
protected function get_remote_path_from_hash($contenthash, $fetchifnotfound = false) {<br />
return $this->get_presigned_url($contenthash, '+6 hours');<br />
}<br />
</code><br />
<br />
''Note'': If using a one-time/pre-signed URL, please ensure that the lifetime of the URL is sufficient for larger files.<br />
<br />
==== add_file_to_pool ====<br />
<br />
The <code>add_file_to_pool</code> function is responsible for storing the provided local file on disk into your file system.<br />
<br />
It is your responsibility to:<br />
* generate the file's contenthash (if it is not provided);<br />
* check whether an existing file with the same contenthash exists in the file system;<br />
* ensure that the contenthash matches if there is a matching file; and<br />
* copy the file to your file system; and<br />
* ensure that file permissions are correct.<br />
<br />
==== add_string_to_pool ====<br />
<br />
Similar to <code>add_file_to_pool</code>, the <code>add_string_to_pool</code> function is responsible for storing the provided string content into your file system.<br />
<br />
==== copy_content_from_storedfile ====<br />
<br />
The <code>copy_content_from_storedfile</code> function is responsible for copying an existing file in the file system to a new local file.<br />
<br />
If you are using a local file system, you will likely just copy the file:<br />
<br />
<code><br />
public function copy_content_from_storedfile(stored_file $file, $target) {<br />
return copy($this->get_local_filepath_from_storedfile($file), $target);<br />
}<br />
</code><br />
<br />
However, if you are implementing a remote file system, you can likely make certain performance improvements by downloading the file straight to the intended target:<br />
<code><br />
public function copy_content_from_storedfile(stored_file $file, $target) {<br />
if ($this->is_readable_locally_from_storedfile($file, false)) {<br />
return copy($this->get_local_filepath_from_storedfile($file), $target);<br />
} else {<br />
return $this->fetch_local_copy($file->get_contenthash(), $target);<br />
}<br />
}<br />
</code><br />
<br />
==== remove_file ====<br />
<br />
The <code>remove_file</code> function is responsible for removing a file.<br />
A file system '''may''' choose to implement it's own trash mechanism, as in the case of <code>filesystem_filedir</code></div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Output_functions&diff=51182
Output functions
2016-11-28T08:33:30Z
<p>Cameron1729: </p>
<hr />
<div>This page tries to explain a bit how dynamic data should be sent from Moodle to the browser in an organised and standard way. Obviously it's possible to have your own output methods but, thinking that you are going to share your code (yep, this is an OpenSource project!) and in the collaborative way we try to build and maintain the system every day, it would be really better to follow the basic guidelines explained below.<br />
<br />
By using them you will be helping to have better, more secure and readable code. Spend some minutes trying to understand them, please!<br />
<br />
Of course, these functions can be discussed, modified and new functions can arrive if there are some good reasons for it. Just discuss it in the [http://moodle.org/mod/forum/view.php?id=55 General developer forum] at [http://moodle.org moodle.org].<br />
<br />
For each of the functions below we'll try to explain when they should be used, explaining the most important parameters supported and their meaning. Let's review them!<br />
<br />
=== p() and s() ===<br />
<br />
function s($var, $strip=false)<br />
function p($var, $strip=false)<br />
<br />
These functions share the same code so they will be explained together. The only difference is that s() returns the string while p() prints it directly.<br />
<br />
These functions should be used to:<br />
<br />
* print all the '''values of form fields''' like <nowiki><input></nowiki> or <nowiki><textarea></nowiki> tags.<br />
* to '''show plain (non html) text''' that has been introduced by the user (search string, quiz responses...).<br />
* in general, all the '''dynamic data, not being html''', that doesn't need to be cleaned nor processed by filters<br />
<br />
It is important not to use these functions for strings that contain html markup.<br />
<br />
The functions replace certain characters that would have special meaning in html ( <, >, ", ', and &) by html entities so that they are displayed as intended. Note that even though the value of form fields printed with p() will have these characters converted to html entities, the submitted values will contain the original characters again.<br />
<br />
The key parameter for this function is:<br />
<br />
* '''strip''': it decides if we want to strip slashes from the string or no. By default it's 'false' so no strip will be performed. We should set such parameter to 'true' only when data to be processed isn't coming from database but from http requests (forms, links...).<br />
<br />
=== format_text() ===<br />
<br />
function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid_do_not_use = null) <br />
<br />
This function should be used to:<br />
<br />
* print '''any html/plain/markdown/moodle text''', needing any of the features below. Mainly used for long strings like posts, answers, glossary items...<br />
<br />
Note that this function is really '''heavy''' because it supports '''cleaning''' of dangerous contents, delegates processing to enabled '''content filter'''s, supports different '''formats''' of text (HTML, PLAIN, MARKDOWN, MOODLE) and performs a lot of '''automatic conversions''' like adding smilies, build links. Also, it includes a strong '''cache mechanism''' (DB based) that will alleviate the server from a lot of work processing the same texts time and again.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''format''': To tell the function about how the data has been entered. It defaults to FORMAT_MOODLE that is a cool format to process plain text because it features automatic link conversion, smilies and good conversion to html output. Other formats are FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN. See [[Formatting options]].<br />
<br />
* '''options''': Here we can specify how we want the process to be performed. You only need to define them if they are different from the default value assumed. Main options are:<br />
**'''options->noclean''': To decide if we want to skip the clean-up of text, '''un-protecting us''' from attacks and other security flaws (defaults to false, so protection is enabled. You '''shouldn't set it to true ever''' unless you are 200% sure that only controlled users can edit it (mainly admins). '''Never use it for general text places''' (posts...) or you will be, sooner or later, attacked! Note that this option is ignored for FORMAT_PLAIN, the text is never cleaned.<br />
**'''options->trusted''': Indicates that this content is trusted and does not need clean-up (but only if $CFG->enabletrusttext is true). This argument is ignored if 'noclean' is specified.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
**'''options->context''': If text is filtered (and this happens by default), it is very important to specify context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related information such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->para''': To decide if you want every paragraph automatically enclosed between html paragraph tags (<nowiki><p>...</p></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->newlines''': To decide if linefeeds in text should be converted to html newlines (<nowiki><br /></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->nocache''': If true the string will not be cached and will be formatted every call. Default false.<br />
**'''options->overflowdiv ''': If set to true the formatted text will be encased in a div with the class no-overflow before being returned. Default false.<br />
**'''options->allowid''' : If true then id attributes will not be removed, even when using htmlpurifier. Default false.<br />
**'''options->blanktarget''' : If true all <a> tags will have target="_blank" added unless target is explicitly specified. Default false.<br />
* '''courseid_do_not_use''': This parameter was earlier used to help applying filters but now is replaced with more precise $options->context, see above<br />
<br />
=== format_string() ===<br />
<br />
function format_string ($string, $striplinks = true, $options = null )<br />
<br />
This function should be used to:<br />
<br />
* print '''short strings (non html) that need filter processing''' (activity titles, post subjects, glossary concepts...).<br />
<br />
All enabled '''heading filters''' will be applied to the string.<br />
<br />
Please note that this function is basically one stripped version of the full format_text() function detailed above and '''it doesn't offer any of its options or protections'''. It simply filters the strings and returns the result, so we must ensure that text being processed has been properly cleaned at input time, using the proper xxx_param() functions.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''striplinks''': To decide if, after the text has been processed by filters, we must delete any link from the result text. Used when we want to show the text inside menus, page titles... (defaults to true).<br />
* '''options'''<br />
**'''options->context''': Context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related informatin such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->escape''': To decide if you want to escape HTML entities. True by default.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
<br />
<br />
<br />
Note: in earlier versions of Moodle the third argument was integer $courseid. It is still supported for legacy - if the third argument is an integer instead of array or object it is considered to be course id and is this course's context is passed to the filters being applied.<br />
<br />
=== print_textarea() ===<br />
<br />
function print_textarea($usehtmleditor, $rows, $cols, $width, <br />
$height, $name, $value=<nowiki>''</nowiki>, $courseid=0, $return=false)<br />
<br />
This function should be used to:<br />
<br />
* display <nowiki><textarea></nowiki> fields when we want to allow users (based in their preferences and browser capabilities) '''to use the visual HTML editor''' instead of one standard 'plain' area.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''usehtmleditor''': to decide if the HTML editor must be showed. The value of this parameter must be calculated by the can_use_html_editor() function.<br />
* '''rows, cols''': to be applied if the standard textarea is showed.<br />
* '''width, height''': to be applied if the HTML editor is used.<br />
* '''name''': the name of the field that will contain the text once the form is submitted.<br />
* '''value''': the initial value of the textarea.<br />
* '''courseid''': This parameter should be passed always to help the editor to know where it is working. This parameter will become less and less important Moodle was 100% of the current course using some session or global variable (it's one work in progress just now) but, for now, it's recommended to set it always in the function call.<br />
* '''return''': to decide if the generated html code must be returned to the caller (true) or printed directly (false). Defaults to false.</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Output_functions&diff=51181
Output functions
2016-11-28T08:28:56Z
<p>Cameron1729: Add new options element.</p>
<hr />
<div>This page tries to explain a bit how dynamic data should be sent from Moodle to the browser in an organised and standard way. Obviously it's possible to have your own output methods but, thinking that you are going to share your code (yep, this is an OpenSource project!) and in the collaborative way we try to build and maintain the system every day, it would be really better to follow the basic guidelines explained below.<br />
<br />
By using them you will be helping to have better, more secure and readable code. Spend some minutes trying to understand them, please!<br />
<br />
Of course, these functions can be discussed, modified and new functions can arrive if there are some good reasons for it. Just discuss it in the [http://moodle.org/mod/forum/view.php?id=55 General developer forum] at [http://moodle.org moodle.org].<br />
<br />
For each of the functions below we'll try to explain when they should be used, explaining the most important parameters supported and their meaning. Let's review them!<br />
<br />
=== p() and s() ===<br />
<br />
function s($var, $strip=false)<br />
function p($var, $strip=false)<br />
<br />
These functions share the same code so they will be explained together. The only difference is that s() returns the string while p() prints it directly.<br />
<br />
These functions should be used to:<br />
<br />
* print all the '''values of form fields''' like <nowiki><input></nowiki> or <nowiki><textarea></nowiki> tags.<br />
* to '''show plain (non html) text''' that has been introduced by the user (search string, quiz responses...).<br />
* in general, all the '''dynamic data, not being html''', that doesn't need to be cleaned nor processed by filters<br />
<br />
It is important not to use these functions for strings that contain html markup.<br />
<br />
The functions replace certain characters that would have special meaning in html ( <, >, ", ', and &) by html entities so that they are displayed as intended. Note that even though the value of form fields printed with p() will have these characters converted to html entities, the submitted values will contain the original characters again.<br />
<br />
The key parameter for this function is:<br />
<br />
* '''strip''': it decides if we want to strip slashes from the string or no. By default it's 'false' so no strip will be performed. We should set such parameter to 'true' only when data to be processed isn't coming from database but from http requests (forms, links...).<br />
<br />
=== format_text() ===<br />
<br />
function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid_do_not_use = null) <br />
<br />
This function should be used to:<br />
<br />
* print '''any html/plain/markdown/moodle text''', needing any of the features below. Mainly used for long strings like posts, answers, glossary items...<br />
<br />
Note that this function is really '''heavy''' because it supports '''cleaning''' of dangerous contents, delegates processing to enabled '''content filter'''s, supports different '''formats''' of text (HTML, PLAIN, MARKDOWN, MOODLE) and performs a lot of '''automatic conversions''' like adding smilies, build links. Also, it includes a strong '''cache mechanism''' (DB based) that will alleviate the server from a lot of work processing the same texts time and again.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''format''': To tell the function about how the data has been entered. It defaults to FORMAT_MOODLE that is a cool format to process plain text because it features automatic link conversion, smilies and good conversion to html output. Other formats are FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN. See [[Formatting options]].<br />
<br />
* '''options''': Here we can specify how we want the process to be performed. You only need to define them if they are different from the default value assumed. Main options are:<br />
**'''options->noclean''': To decide if we want to skip the clean-up of text, '''un-protecting us''' from attacks and other security flaws (defaults to false, so protection is enabled. You '''shouldn't set it to true ever''' unless you are 200% sure that only controlled users can edit it (mainly admins). '''Never use it for general text places''' (posts...) or you will be, sooner or later, attacked! Note that this option is ignored for FORMAT_PLAIN, the text is never cleaned.<br />
**'''options->trusted''': Indicates that this content is trusted and does not need clean-up (but only if $CFG->enabletrusttext is true). This argument is ignored if 'noclean' is specified.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
**'''options->context''': If text is filtered (and this happens by default), it is very important to specify context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related information such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->para''': To decide if you want every paragraph automatically enclosed between html paragraph tags (<nowiki><p>...</p></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->newlines''': To decide if linefeeds in text should be converted to html newlines (<nowiki><br /></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->nocache''': If true the string will not be cached and will be formatted every call. Default false.<br />
**'''options->overflowdiv ''': If set to true the formatted text will be encased in a div with the class no-overflow before being returned. Default false.<br />
**'''options->allowid''' : If true then id attributes will not be removed, even when using htmlpurifier. Default false.<br />
* '''courseid_do_not_use''': This parameter was earlier used to help applying filters but now is replaced with more precise $options->context, see above<br />
<br />
=== format_string() ===<br />
<br />
function format_string ($string, $striplinks = true, $options = null )<br />
<br />
This function should be used to:<br />
<br />
* print '''short strings (non html) that need filter processing''' (activity titles, post subjects, glossary concepts...).<br />
<br />
All enabled '''heading filters''' will be applied to the string.<br />
<br />
Please note that this function is basically one stripped version of the full format_text() function detailed above and '''it doesn't offer any of its options or protections'''. It simply filters the strings and returns the result, so we must ensure that text being processed has been properly cleaned at input time, using the proper xxx_param() functions.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''striplinks''': To decide if, after the text has been processed by filters, we must delete any link from the result text. Used when we want to show the text inside menus, page titles... (defaults to true).<br />
* '''options'''<br />
**'''options->context''': Context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related informatin such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->escape''': To decide if you want to escape HTML entities. True by default.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
<br />
<br />
<br />
Note: in earlier versions of Moodle the third argument was integer $courseid. It is still supported for legacy - if the third argument is an integer instead of array or object it is considered to be course id and is this course's context is passed to the filters being applied.<br />
<br />
=== print_textarea() ===<br />
<br />
function print_textarea($usehtmleditor, $rows, $cols, $width, <br />
$height, $name, $value=<nowiki>''</nowiki>, $courseid=0, $return=false)<br />
<br />
This function should be used to:<br />
<br />
* display <nowiki><textarea></nowiki> fields when we want to allow users (based in their preferences and browser capabilities) '''to use the visual HTML editor''' instead of one standard 'plain' area.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''usehtmleditor''': to decide if the HTML editor must be showed. The value of this parameter must be calculated by the can_use_html_editor() function.<br />
* '''rows, cols''': to be applied if the standard textarea is showed.<br />
* '''width, height''': to be applied if the HTML editor is used.<br />
* '''name''': the name of the field that will contain the text once the form is submitted.<br />
* '''value''': the initial value of the textarea.<br />
* '''courseid''': This parameter should be passed always to help the editor to know where it is working. This parameter will become less and less important Moodle was 100% of the current course using some session or global variable (it's one work in progress just now) but, for now, it's recommended to set it always in the function call.<br />
* '''return''': to decide if the generated html code must be returned to the caller (true) or printed directly (false). Defaults to false.</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Output_functions&diff=50595
Output functions
2016-07-06T09:24:10Z
<p>Cameron1729: /* format_string() */</p>
<hr />
<div>This page tries to explain a bit how dynamic data should be sent from Moodle to the browser in an organised and standard way. Obviously it's possible to have your own output methods but, thinking that you are going to share your code (yep, this is an OpenSource project!) and in the collaborative way we try to build and maintain the system every day, it would be really better to follow the basic guidelines explained below.<br />
<br />
By using them you will be helping to have better, more secure and readable code. Spend some minutes trying to understand them, please!<br />
<br />
Of course, these functions can be discussed, modified and new functions can arrive if there are some good reasons for it. Just discuss it in the [http://moodle.org/mod/forum/view.php?id=55 General developer forum] at [http://moodle.org moodle.org].<br />
<br />
For each of the functions below we'll try to explain when they should be used, explaining the most important parameters supported and their meaning. Let's review them!<br />
<br />
=== p() and s() ===<br />
<br />
function s($var, $strip=false)<br />
function p($var, $strip=false)<br />
<br />
These functions share the same code so they will be explained together. The only difference is that s() returns the string while p() prints it directly.<br />
<br />
These functions should be used to:<br />
<br />
* print all the '''values of form fields''' like <nowiki><input></nowiki> or <nowiki><textarea></nowiki> tags.<br />
* to '''show plain (non html) text''' that has been introduced by the user (search string, quiz responses...).<br />
* in general, all the '''dynamic data, not being html''', that doesn't need to be cleaned nor processed by filters<br />
<br />
It is important not to use these functions for strings that contain html markup.<br />
<br />
The functions replace certain characters that would have special meaning in html ( <, >, ", ', and &) by html entities so that they are displayed as intended. Note that even though the value of form fields printed with p() will have these characters converted to html entities, the submitted values will contain the original characters again.<br />
<br />
The key parameter for this function is:<br />
<br />
* '''strip''': it decides if we want to strip slashes from the string or no. By default it's 'false' so no strip will be performed. We should set such parameter to 'true' only when data to be processed isn't coming from database but from http requests (forms, links...).<br />
<br />
=== format_text() ===<br />
<br />
function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid_do_not_use = null) <br />
<br />
This function should be used to:<br />
<br />
* print '''any html/plain/markdown/moodle text''', needing any of the features below. Mainly used for long strings like posts, answers, glossary items...<br />
<br />
Note that this function is really '''heavy''' because it supports '''cleaning''' of dangerous contents, delegates processing to enabled '''content filter'''s, supports different '''formats''' of text (HTML, PLAIN, MARKDOWN, MOODLE) and performs a lot of '''automatic conversions''' like adding smilies, build links. Also, it includes a strong '''cache mechanism''' (DB based) that will alleviate the server from a lot of work processing the same texts time and again.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''format''': To tell the function about how the data has been entered. It defaults to FORMAT_MOODLE that is a cool format to process plain text because it features automatic link conversion, smilies and good conversion to html output. Other formats are FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN. See [[Formatting options]].<br />
<br />
* '''options''': Here we can specify how we want the process to be performed. You only need to define them if they are different from the default value assumed. Main options are:<br />
**'''options->noclean''': To decide if we want to skip the clean-up of text, '''un-protecting us''' from attacks and other security flaws (defaults to false, so protection is enabled. You '''shouldn't set it to true ever''' unless you are 200% sure that only controlled users can edit it (mainly admins). '''Never use it for general text places''' (posts...) or you will be, sooner or later, attacked! Note that this option is ignored for FORMAT_PLAIN, the text is never cleaned.<br />
**'''options->trusted''': Indicates that this content is trusted and does not need clean-up (but only if $CFG->enabletrusttext is true). This argument is ignored if 'noclean' is specified.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
**'''options->context''': If text is filtered (and this happens by default), it is very important to specify context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related information such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->para''': To decide if you want every paragraph automatically enclosed between html paragraph tags (<nowiki><p>...</p></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->newlines''': To decide if linefeeds in text should be converted to html newlines (<nowiki><br /></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->nocache''': If true the string will not be cached and will be formatted every call. Default false.<br />
**'''options->overflowdiv ''': If set to true the formatted text will be encased in a div with the class no-overflow before being returned. Default false.<br />
**'''options->allowid''' : If true then id attributes will not be removed, even when using htmlpurifier. Default false.<br />
* '''courseid_do_not_use''': This parameter was earlier used to help applying filters but now is replaced with more precise $options->context, see above<br />
<br />
=== format_string() ===<br />
<br />
function format_string ($string, $striplinks = true, $options = null )<br />
<br />
This function should be used to:<br />
<br />
* print '''short strings (non html) that need filter processing''' (activity titles, post subjects, glossary concepts...).<br />
<br />
All enabled '''heading filters''' will be applied to the string.<br />
<br />
Please note that this function is basically one stripped version of the full format_text() function detailed above and '''it doesn't offer any of its options or protections'''. It simply filters the strings and returns the result, so we must ensure that text being processed has been properly cleaned at input time, using the proper xxx_param() functions.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''striplinks''': To decide if, after the text has been processed by filters, we must delete any link from the result text. Used when we want to show the text inside menus, page titles... (defaults to true).<br />
* '''options'''<br />
**'''options->context''': Context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related informatin such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
<br />
<br />
Note: in earlier versions of Moodle the third argument was integer $courseid. It is still supported for legacy - if the third argument is an integer instead of array or object it is considered to be course id and is this course's context is passed to the filters being applied.<br />
<br />
=== print_textarea() ===<br />
<br />
function print_textarea($usehtmleditor, $rows, $cols, $width, <br />
$height, $name, $value=<nowiki>''</nowiki>, $courseid=0, $return=false)<br />
<br />
This function should be used to:<br />
<br />
* display <nowiki><textarea></nowiki> fields when we want to allow users (based in their preferences and browser capabilities) '''to use the visual HTML editor''' instead of one standard 'plain' area.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''usehtmleditor''': to decide if the HTML editor must be showed. The value of this parameter must be calculated by the can_use_html_editor() function.<br />
* '''rows, cols''': to be applied if the standard textarea is showed.<br />
* '''width, height''': to be applied if the HTML editor is used.<br />
* '''name''': the name of the field that will contain the text once the form is submitted.<br />
* '''value''': the initial value of the textarea.<br />
* '''courseid''': This parameter should be passed always to help the editor to know where it is working. This parameter will become less and less important Moodle was 100% of the current course using some session or global variable (it's one work in progress just now) but, for now, it's recommended to set it always in the function call.<br />
* '''return''': to decide if the generated html code must be returned to the caller (true) or printed directly (false). Defaults to false.</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Output_functions&diff=50594
Output functions
2016-07-06T09:23:46Z
<p>Cameron1729: /* format_string() */</p>
<hr />
<div>This page tries to explain a bit how dynamic data should be sent from Moodle to the browser in an organised and standard way. Obviously it's possible to have your own output methods but, thinking that you are going to share your code (yep, this is an OpenSource project!) and in the collaborative way we try to build and maintain the system every day, it would be really better to follow the basic guidelines explained below.<br />
<br />
By using them you will be helping to have better, more secure and readable code. Spend some minutes trying to understand them, please!<br />
<br />
Of course, these functions can be discussed, modified and new functions can arrive if there are some good reasons for it. Just discuss it in the [http://moodle.org/mod/forum/view.php?id=55 General developer forum] at [http://moodle.org moodle.org].<br />
<br />
For each of the functions below we'll try to explain when they should be used, explaining the most important parameters supported and their meaning. Let's review them!<br />
<br />
=== p() and s() ===<br />
<br />
function s($var, $strip=false)<br />
function p($var, $strip=false)<br />
<br />
These functions share the same code so they will be explained together. The only difference is that s() returns the string while p() prints it directly.<br />
<br />
These functions should be used to:<br />
<br />
* print all the '''values of form fields''' like <nowiki><input></nowiki> or <nowiki><textarea></nowiki> tags.<br />
* to '''show plain (non html) text''' that has been introduced by the user (search string, quiz responses...).<br />
* in general, all the '''dynamic data, not being html''', that doesn't need to be cleaned nor processed by filters<br />
<br />
It is important not to use these functions for strings that contain html markup.<br />
<br />
The functions replace certain characters that would have special meaning in html ( <, >, ", ', and &) by html entities so that they are displayed as intended. Note that even though the value of form fields printed with p() will have these characters converted to html entities, the submitted values will contain the original characters again.<br />
<br />
The key parameter for this function is:<br />
<br />
* '''strip''': it decides if we want to strip slashes from the string or no. By default it's 'false' so no strip will be performed. We should set such parameter to 'true' only when data to be processed isn't coming from database but from http requests (forms, links...).<br />
<br />
=== format_text() ===<br />
<br />
function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid_do_not_use = null) <br />
<br />
This function should be used to:<br />
<br />
* print '''any html/plain/markdown/moodle text''', needing any of the features below. Mainly used for long strings like posts, answers, glossary items...<br />
<br />
Note that this function is really '''heavy''' because it supports '''cleaning''' of dangerous contents, delegates processing to enabled '''content filter'''s, supports different '''formats''' of text (HTML, PLAIN, MARKDOWN, MOODLE) and performs a lot of '''automatic conversions''' like adding smilies, build links. Also, it includes a strong '''cache mechanism''' (DB based) that will alleviate the server from a lot of work processing the same texts time and again.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''format''': To tell the function about how the data has been entered. It defaults to FORMAT_MOODLE that is a cool format to process plain text because it features automatic link conversion, smilies and good conversion to html output. Other formats are FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN. See [[Formatting options]].<br />
<br />
* '''options''': Here we can specify how we want the process to be performed. You only need to define them if they are different from the default value assumed. Main options are:<br />
**'''options->noclean''': To decide if we want to skip the clean-up of text, '''un-protecting us''' from attacks and other security flaws (defaults to false, so protection is enabled. You '''shouldn't set it to true ever''' unless you are 200% sure that only controlled users can edit it (mainly admins). '''Never use it for general text places''' (posts...) or you will be, sooner or later, attacked! Note that this option is ignored for FORMAT_PLAIN, the text is never cleaned.<br />
**'''options->trusted''': Indicates that this content is trusted and does not need clean-up (but only if $CFG->enabletrusttext is true). This argument is ignored if 'noclean' is specified.<br />
**'''options->filter''': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
**'''options->context''': If text is filtered (and this happens by default), it is very important to specify context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related information such as name and description should have course context even when they are displayed on front page or system pages.<br />
**'''options->para''': To decide if you want every paragraph automatically enclosed between html paragraph tags (<nowiki><p>...</p></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->newlines''': To decide if linefeeds in text should be converted to html newlines (<nowiki><br /></nowiki>) (defaults to true). This option only applies to FORMAT_MOODLE.<br />
**'''options->nocache''': If true the string will not be cached and will be formatted every call. Default false.<br />
**'''options->overflowdiv ''': If set to true the formatted text will be encased in a div with the class no-overflow before being returned. Default false.<br />
**'''options->allowid''' : If true then id attributes will not be removed, even when using htmlpurifier. Default false.<br />
* '''courseid_do_not_use''': This parameter was earlier used to help applying filters but now is replaced with more precise $options->context, see above<br />
<br />
=== format_string() ===<br />
<br />
function format_string ($string, $striplinks = true, $options = null )<br />
<br />
This function should be used to:<br />
<br />
* print '''short strings (non html) that need filter processing''' (activity titles, post subjects, glossary concepts...).<br />
<br />
All enabled '''heading filters''' will be applied to the string.<br />
<br />
Please note that this function is basically one stripped version of the full format_text() function detailed above and '''it doesn't offer any of its options or protections'''. It simply filters the strings and returns the result, so we must ensure that text being processed has been properly cleaned at input time, using the proper xxx_param() functions.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''striplinks''': To decide if, after the text has been processed by filters, we must delete any link from the result text. Used when we want to show the text inside menus, page titles... (defaults to true).<br />
* '''options'''<br />
**'''options->context''': Context (id or object) for applying filters. If context is not specified it will be taken from $PAGE->context and may potentially result in displaying the same text differently on different pages. For example all module-related information should have module context even when it appears in course-level reports, all course-related informatin such as name and description should have course context even when they are displayed on front page or system pages.<br />
**''options->filter'': To decide if you want to allow filters to process the text (defaults to true). This is ignored by FORMAT_PLAIN for which filters are never applied.<br />
<br />
<br />
Note: in earlier versions of Moodle the third argument was integer $courseid. It is still supported for legacy - if the third argument is an integer instead of array or object it is considered to be course id and is this course's context is passed to the filters being applied.<br />
<br />
=== print_textarea() ===<br />
<br />
function print_textarea($usehtmleditor, $rows, $cols, $width, <br />
$height, $name, $value=<nowiki>''</nowiki>, $courseid=0, $return=false)<br />
<br />
This function should be used to:<br />
<br />
* display <nowiki><textarea></nowiki> fields when we want to allow users (based in their preferences and browser capabilities) '''to use the visual HTML editor''' instead of one standard 'plain' area.<br />
<br />
Some interesting parameters for this function are:<br />
<br />
* '''usehtmleditor''': to decide if the HTML editor must be showed. The value of this parameter must be calculated by the can_use_html_editor() function.<br />
* '''rows, cols''': to be applied if the standard textarea is showed.<br />
* '''width, height''': to be applied if the HTML editor is used.<br />
* '''name''': the name of the field that will contain the text once the form is submitted.<br />
* '''value''': the initial value of the textarea.<br />
* '''courseid''': This parameter should be passed always to help the editor to know where it is working. This parameter will become less and less important Moodle was 100% of the current course using some session or global variable (it's one work in progress just now) but, for now, it's recommended to set it always in the function call.<br />
* '''return''': to decide if the generated html code must be returned to the caller (true) or printed directly (false). Defaults to false.</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Web_service_API_functions&diff=50138
Web service API functions
2016-05-19T06:50:45Z
<p>Cameron1729: </p>
<hr />
<div>{{Moodle_2.0}}<br />
<br />
{| class = "wikitable"<br />
|+Color meaning<br />
|-<br />
| style="background:#D4FFDF;" | Implemented<br />
|-<br />
| style="background:#ffdead;" | Must be implemented<br />
|-<br />
| style="background:#ffdfcd;" | Suggested<br />
|}<br />
<br />
<br />
==Web service protocols==<br />
<br />
<br />
{| class="wikitable sortable"<br />
! Name !! Moodle Ver. !! class="unsortable" |Description !! class="unsortable" |CORS !! |Issue<br />
|-<br />
| style="background:#D4FFDF;" | REST (returning XML) || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | XML data accessed through a REST API (not restful) || Supported (3.0 and onwards) || <br />
|-<br />
| style="background:#D4FFDF;" | REST (returning JSON) || style="background:#D4FFDF;" | 2.2 || style="background:#D4FFDF;" | JSON data accessed through a REST API (not restful) || Supported (3.0 and onwards)|| MDL-29242<br />
|-<br />
| style="background:#ffdfcd;" | REST (returning JSONP) || style="background:#ffdfcd;" | 2.X || style="background:#ffdfcd;" | Would be very useful for client-side JavaScript || Not supported || MDL-29913<br />
|-<br />
| style="background:#ffdfcd;" | JSON || style="background:#ffdfcd;" | 2.X || style="background:#ffdfcd;" | JSON server receives a JSON encoded params and return JSON encoded values. || Not supported || MDL-21341<br />
|-<br />
| style="background:#ffdead;" | SOAP|| style="background:#ffdead;" | 2.0 || style="background:#ffdead;" | Very important for interoperating with Java and .Net applications. There was a partial implementation JAVA/.Net in Moodle 2.0, but it does not work for anything but the most trivial functions. It is fully working with PHP clients.|| Not supported || MDL-20804, MDL-28988, MDL-28989<br />
|-<br />
| style="background:#D4FFDF;" | XMLRPC|| style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | XML remote-procedure call. || Not supported || <br />
|}<br />
<br />
==Web service functions==<br />
<br />
=== Naming convention ===<br />
<br />
We updated (regularised) the naming convention in Moodle 2.2. See MDL-29106 for those details.<br />
<br />
All functions should be named as follows:<br />
<br />
* wsfunction = fullcomponent_methodname <br />
* fullcomponent = [https://docs.moodle.org/dev/Frankenstyle frankenstyle] (eg core_xxxx or mod_xxx etc)<br />
* methodname = verb_noun(s)<br />
* verb = get|create|delete|update<br />
* noun = moodle objects, usually plural (eg posts, discussions, users, courses etc)<br />
<br />
=== Core web service functions ===<br />
{| class="wikitable sortable"<br />
!Area!! Moodle 2.2 name !! Moodle 2.0/2.1 name !! Introduced in !! class="unsortable" |Description !! class="unsortable" | Issue<br />
|-<br />
| core<br />
| style="background:#D4FFDF;" | core_fetch_notifications || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return a list of notifications for the current session || <br />
|-<br />
| core<br />
| style="background:#D4FFDF;" | core_get_component_strings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Return all raw strings (with {$a->xxx}) for a specific component - similar to core get_component_strings() call || MDL-35997<br />
|-<br />
| core<br />
| style="background:#D4FFDF;" | core_get_fragment || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return a fragment for inclusion, such as a JavaScript page. || <br />
|-<br />
| core<br />
| style="background:#D4FFDF;" | core_get_string() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Return a translated string - similar to core get_string() call || MDL-35997<br />
|-<br />
| core<br />
| style="background:#D4FFDF;" | core_get_strings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Return some translated strings - like several core get_string() calls || MDL-35997<br />
|-<br />
| core<br />
| style="background:#D4FFDF;" | core_update_inplace_editable || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Generic service to update title || <br />
<br />
|-<br />
| core_badges<br />
| style="background:#D4FFDF;" | core_badges_get_user_badges || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns the list of badges awarded to a user. || <br />
|-<br />
| core_calendar<br />
| style="background:#D4FFDF;" | core_calendar_create_calendar_events() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Create calendar events || MDL-37101<br />
|-<br />
| core_calendar<br />
| style="background:#D4FFDF;" | core_calendar_delete_calendar_events() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Delete calendar events || MDL-37077<br />
|-<br />
| core_calendar<br />
| style="background:#D4FFDF;" | core_calendar_get_calendar_events() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Get calendar events || MDL-37100<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_add_cohort_members() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Add members to cohort || MDL-29472<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_create_cohorts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Create cohorts || MDL-29472<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_delete_cohort_members() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Delete members from cohort || MDL-29472<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_delete_cohorts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Delete cohorts || MDL-29472<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_get_cohort_members() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Get cohort members || MDL-29472<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_get_cohorts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Get cohorts || MDL-29472<br />
|-<br />
| core_cohort<br />
| style="background:#D4FFDF;" | core_cohort_update_cohorts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Update cohorts || MDL-29472<br />
|-<br />
| core_comment<br />
| style="background:#D4FFDF;" | core_comment_get_comments() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Return all the comments for an specific component, context. || MDL-49203 <br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_add_competency_to_course || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Add competency to a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_add_competency_to_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Add a competency to a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_add_competency_to_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Add competency to a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_add_related_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a relationship between competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_approve_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Approve a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_competency_framework_viewed || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Notify a competency framework as being viewed || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_competency_viewed || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Report a competency as being viewed || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_complete_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Complete a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_competencies || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count the competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_competencies_in_course || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count competencies in a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_competencies_in_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count the competencies in a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_competency_frameworks || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count the competency frameworks || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_courses_using_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count courses using a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_templates || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count templates || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_count_templates_using_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Count templates using a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_create_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_create_competency_framework || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a competency framework || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_create_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_create_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_create_user_evidence_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Link an evidence of prior learning with a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_competency_framework || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete a competency framework || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_evidence || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete an evidence || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_user_evidence || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete an evidence of prior learning || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_delete_user_evidence_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Remove a link between an evidence of prior learning and a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_duplicate_competency_framework || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Duplicate a competency framework || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_duplicate_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Duplicate a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_get_scale_values || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get the values for a scale || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_grade_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Rate a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_grade_competency_in_course || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Rate a user's competency in a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_grade_competency_in_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Rate a user's competency in a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_competencies || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_competencies_in_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List the competencies of a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_competency_frameworks || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List the competency frameworks || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_course_competencies || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List the competencies in a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_plan_competencies || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List a learning plan's competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_templates || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List templates || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_templates_using_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List templates using a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_list_user_plans || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List a user's learning plans || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_move_down_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Move a competency down in its branch || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_move_up_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Move a competency up in its branch || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_plan_cancel_review_request || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Cancel the review request of a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_plan_request_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Request the review of a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_plan_start_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Start the review of a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_plan_stop_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Stop the review of a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_read_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Fetch a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_read_competency_framework || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Fetch a competency framework || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_read_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Fetch a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_read_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Fetch a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_read_user_evidence || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Fetch an evidence of prior learning || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_remove_competency_from_course || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Remove competency from a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_remove_competency_from_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Remove a competency from a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_remove_competency_from_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Remove competency from template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_remove_related_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Remove a relationship between competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_reopen_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Reopen a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_reorder_course_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Reorder competencies in a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_reorder_plan_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Reopen a competency in a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_reorder_template_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Reorder competencies in a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_request_review_of_user_evidence_linked_competencies || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Request the review of the user's competencies linked to an evidence of prior learning || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_search_competencies || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Search for competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_set_course_competency_ruleoutcome || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Set the rule of course competencies || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_set_parent_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Relocate a competency to another parent || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_template_has_related_data || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Check whether a template has related data || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_template_viewed || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Report a template as being viewed || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_unapprove_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Unapprove a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_unlink_plan_from_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Unlink a learning plan from a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_update_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update a competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_update_competency_framework || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update a competency framework || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_update_course_competency_settings || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update the course competency settings || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_update_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update a learning plan || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_update_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update a template || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_cancel_review_request || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Cancel the review request of a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_plan_viewed || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Report the archive of user's competency as being viewed || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_request_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Request the review of a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_start_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Start the review of a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_stop_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Stop the review of a user's competency || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_viewed || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Report a user's competency as being viewed || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_viewed_in_course || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Report a user's competency as being viewed from a course || MDL-49458<br />
|-<br />
| core_competency<br />
| style="background:#D4FFDF;" | core_competency_user_competency_viewed_in_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Report a user's competency as being viewed from a learning plan || MDL-49458<br />
|-<br />
| core_completion<br />
| style="background:#D4FFDF;" | core_completion_get_activities_completion_status() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Return the activities completion status for a user in a course. || MDL-49314 <br />
|-<br />
| core_completion<br />
| style="background:#D4FFDF;" | core_completion_get_course_completion_status() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Returns course completion status. || MDL-49313 <br />
|-<br />
| core_completion<br />
| style="background:#D4FFDF;" | core_completion_mark_course_self_completed || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Update the course completion status for the current user (if course self-completion is enabled). || MDL-50930 <br />
|-<br />
| core_completion<br />
| style="background:#D4FFDF;" | core_completion_update_activity_completion_status_manually() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Update completion status for the current user in an activity, only for activities with manual tracking. || MDL-49444<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_create_categories() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | create categories || MDL-32941<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_create_courses() || style="background:#D4FFDF;" | moodle_course_create_courses() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Create new courses || <br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_delete_categories() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | delete categories || MDL-32941<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_delete_courses() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | delete courses || MDL-13130<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_delete_modules() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Deletes all specified module instances || MDL-30098 <br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_duplicate_course() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | duplicate a course || MDL-32233<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_get_categories() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | get categories || MDL-32941<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_get_contents() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.2 || style="background:#D4FFDF;" | get course content (modules + web service file urls) || MDL-28646<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_get_course_module || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Return information about a course module. || MDL-51371<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_get_course_module_by_instance || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Return information about a given module name and instance id. || MDL-51579<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_get_courses() || style="background:#D4FFDF;" | moodle_course_get_courses() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Return course details || <br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_import_course() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Import course data from a course into another course. Does not include any user data. || MDL-32919<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_search_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Search courses by (name, module, block, tag). || MDL-49942<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_update_categories() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | update categories || MDL-32941<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_update_courses() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Update courses. || MDL-30062<br />
|-<br />
| core_course<br />
| style="background:#D4FFDF;" | core_course_view_course() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Log that the course was viewed || MDL-49453 <br />
|-<br />
| core_enrol<br />
| style="background:#D4FFDF;" | core_enrol_get_course_enrolment_methods || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Get the list of course enrolment methods ||<br />
|-<br />
| core_enrol<br />
| style="background:#D4FFDF;" | core_enrol_get_enrolled_users() || style="background:#D4FFDF;" | moodle_user_get_users_by_courseid() || style="background:#D4FFDF;" | 2.1 || style="background:#D4FFDF;" | Get enrolled users by course id || <br />
|-<br />
| core_enrol<br />
| style="background:#D4FFDF;" | core_enrol_get_enrolled_users_with_capability() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | For each course and capability specified, return a list of the users that are enrolled in the course and have that capability || MDL-31859<br />
|-<br />
| core_enrol<br />
| style="background:#D4FFDF;" | core_enrol_get_users_courses() || style="background:#D4FFDF;" | moodle_enrol_get_users_courses() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | get list of course ids that a user is enrolled in (if you are allowed to see that) || <br />
|-<br />
| core_files<br />
| style="background:#D4FFDF;" | core_files_get_files() || style="background:#D4FFDF;" | moodle_file_get_files() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | browse moodle files || <br />
|-<br />
| core_grade<br />
| style="background:#D4FFDF;" | core_grade_get_grades() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.7 || style="background:#D4FFDF;" | Returns student course total grade and grades for activities. This function does not return category or manual items. This function is suitable for managers or teachers not students. || MDL-30085<br />
|-<br />
| core_grade<br />
| style="background:#D4FFDF;" | core_grade_update_grades() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.7 || style="background:#D4FFDF;" | Update a grade item and associated student grades. || MDL-30085<br />
|-<br />
| core_grading<br />
| style="background:#D4FFDF;" | core_grading_get_definitions() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Returns grading definitions for the course module ids and areaname provided as parameters. An optionall activeonly parameter can be provided so that only the active grading method is returned. || MDL-31890<br />
|-<br />
| core_grading<br />
| style="background:#D4FFDF;" | core_grading_get_gradingform_instances() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Returns the instances and fillings for the requested definition id. An optional since parameter allows the number of records returned to be reduced so that only those with a timemodified value >= since are returned || MDL-31890<br />
|-<br />
| core_grading<br />
| style="background:#D4FFDF;" | core_grading_save_definitions() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.8 || style="background:#D4FFDF;" | Accepts an array of areas as a parameter. The areas contain grading definitions with criteria for inserting and updating || MDL-31861<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_add_group_members() || style="background:#D4FFDF;" | moodle_group_add_groupmembers() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Adds group members || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_assign_grouping() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | assign groups from groupings || MDL-32662<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_create_groupings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | create groupings || MDL-32662<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_create_groups() || style="background:#D4FFDF;" | moodle_group_create_groups() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Creates new groups || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_delete_group_members() || style="background:#D4FFDF;" | moodle_group_delete_groupmembers() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Deletes group members || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_delete_groupings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | delete groupings || MDL-32662<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_delete_groups() || style="background:#D4FFDF;" | moodle_group_delete_groups() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Deletes all specified groups || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_activity_allowed_groups || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Gets a list of groups that the user is allowed to access within the specified activity. || MDL-50966<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_activity_groupmode || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns effective groupmode used in a given activity. || MDL-50964<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_course_groupings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | get all groupings in specified course || MDL-32662<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_course_groups() || style="background:#D4FFDF;" | moodle_group_get_course_groups() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Returns all groups in specified course || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_course_user_groups() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Returns all groups in specified course for the specified user. || MDL-48730 <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_group_members() || style="background:#D4FFDF;" | moodle_group_get_groupmembers() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Returns group members || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_groupings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | get groupings || MDL-32662<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_get_groups() || style="background:#D4FFDF;" | moodle_group_get_groups() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Returns group details. || <br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_unassign_grouping() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | unassign groups from groupings || MDL-32662<br />
|-<br />
| core_group<br />
| style="background:#D4FFDF;" | core_group_update_groupings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.3 || style="background:#D4FFDF;" | update groupings || MDL-32662<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_block_contacts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Block contacts || MDL-30070<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_create_contacts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Add contacts to the contact list || MDL-30070<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_delete_contacts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Remove contacts from the contact list || MDL-30070<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_delete_message || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Deletes a message. || <br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_get_blocked_users() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Retrieve a list of users blocked || MDL-48719 <br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_get_contacts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Retrieve the contact list || MDL-30070<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_get_messages() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.8 || style="background:#D4FFDF;" | Retrieve a list of messages sent and received by a user (conversations, notifications or both) || MDL-45374 <br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_mark_message_read() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Mark a single message as read, trigger message_viewed event. || MDL-49501<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_search_contacts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Search for contacts || MDL-30070<br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_send_instant_messages() || style="background:#D4FFDF;" | moodle_message_send_instantmessages() || style="background:#D4FFDF;" | 2.1 || style="background:#D4FFDF;" | Send instant messages || <br />
|-<br />
| core_message<br />
| style="background:#D4FFDF;" | core_message_unblock_contacts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Unblock contacts || MDL-30070<br />
|-<br />
| core_notes<br />
| style="background:#D4FFDF;" | core_notes_create_notes() || style="background:#D4FFDF;" | moodle_notes_create_notes() || style="background:#D4FFDF;" | 2.1 || style="background:#D4FFDF;" | Create notes || <br />
|-<br />
| core_notes<br />
| style="background:#D4FFDF;" | core_notes_delete_notes() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Delete Notes || MDL-30072<br />
|-<br />
| core_notes<br />
| style="background:#D4FFDF;" | core_notes_get_course_notes() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Returns all notes in specified course (or site) for the specified user. || MDL-49330<br />
|-<br />
| core_notes<br />
| style="background:#D4FFDF;" | core_notes_get_notes() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Retrieve Notes || MDL-30072<br />
|-<br />
| core_notes<br />
| style="background:#D4FFDF;" | core_notes_update_notes() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Update Notes || MDL-30072<br />
|-<br />
| core_notes<br />
| style="background:#D4FFDF;" | core_notes_view_notes() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Simulates the web interface view of notes/index.php: trigger events. || MDL-49504<br />
|-<br />
| core_output<br />
| style="background:#D4FFDF;" | core_output_load_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Load a template for a renderable ||<br />
|-<br />
| core_question<br />
| style="background:#D4FFDF;" | core_question_update_flag || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update the flag state of a question attempt. || <br />
|-<br />
| core_rating<br />
| style="background:#D4FFDF;" | core_rating_get_item_ratings() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Retrieve all the ratings for an item. || MDL-49347 <br />
|-<br />
| core_role<br />
| style="background:#D4FFDF;" | core_role_assign_roles() || style="background:#D4FFDF;" | moodle_role_assign() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Manual role assignments || <br />
|-<br />
| core_role<br />
| style="background:#D4FFDF;" | core_role_unassign_roles() || style="background:#D4FFDF;" | moodle_role_unassign() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Manual role unassignments || <br />
|-<br />
| core_tag<br />
| style="background:#D4FFDF;" | core_tag_get_tagindex || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Gets tag index page for one tag and one tag area || <br />
|-<br />
| core_tag<br />
| style="background:#D4FFDF;" | core_tag_get_tags || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Gets tags by their ids ||<br />
|-<br />
| core_tag<br />
| style="background:#D4FFDF;" | core_tag_update_tags || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Updates tags ||<br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_add_user_device() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Store mobile user devices information for PUSH Notifications. || MDL-41914 <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_add_user_private_files || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Copy files from a draft area to users private files area. ||<br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_create_users() || style="background:#D4FFDF;" | moodle_user_create_users() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Create users - admin function || <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_delete_users() || style="background:#D4FFDF;" | moodle_user_delete_users() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Delete users - admin function || <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_get_course_user_profiles() || style="background:#D4FFDF;" | moodle_user_get_course_participants_by_id() || style="background:#D4FFDF;" | 2.1 || style="background:#D4FFDF;" | Get course user profiles by id || <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_get_users() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Search users. - If you want to get multiple users for one specific field, use core_user_get_users_by_field(), it's designed for this purpose and it should be faster. || MDL-29938<br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_get_users_by_field() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Retrieve users information for a specified unique field - If you want to do a user search, use core_user_get_users() || MDL-35543<br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_get_users_by_id() || style="background:#D4FFDF;" | moodle_user_get_users_by_id() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Get users by id || <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_remove_user_device() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Remove a user device from the Moodle database. || MDL-48716 <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_update_users() || style="background:#D4FFDF;" | moodle_user_update_users() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Update users || <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_view_user_list() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Simulates the web-interface view of user/index.php (triggering events). || MDL-49498 <br />
|-<br />
| core_user<br />
| style="background:#D4FFDF;" | core_user_view_user_profile() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Simulates the web-interface view of user/view.php and user/profile.php (triggering events). || MDL-49499<br />
|-<br />
| core_webservice<br />
| style="background:#D4FFDF;" | core_webservice_get_site_info() || style="background:#D4FFDF;" | moodle_webservice_get_siteinfo() || style="background:#D4FFDF;" | 2.1 || style="background:#D4FFDF;" | Return some site info / user info / list web service functions || <br />
|-<br />
| enrol_guest<br />
| style="background:#D4FFDF;" | enrol_guest_get_instance_info || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return guest enrolment instance information. || <br />
|-<br />
| enrol_manual<br />
| style="background:#D4FFDF;" | enrol_manual_enrol_users() || style="background:#D4FFDF;" | moodle_enrol_manual_enrol_users() || style="background:#D4FFDF;" | 2.0 || style="background:#D4FFDF;" | Manual enrol users || <br />
|-<br />
| enrol_manual<br />
| style="background:#D4FFDF;" | enrol_manual_unenrol_users || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Manual unenrol users ||<br />
|-<br />
| enrol_self<br />
| style="background:#D4FFDF;" | enrol_self_enrol_user || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Self enrol the current user in the given course. || MDL-51568<br />
|-<br />
| enrol_self<br />
| style="background:#D4FFDF;" | enrol_self_get_instance_info || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | self enrolment instance information. ||<br />
|-<br />
| gradereport_user<br />
| style="background:#D4FFDF;" | gradereport_user_get_grades_table() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Get the user/s report grades table for a course || MDL-49036 <br />
|-<br />
| gradereport_user<br />
| style="background:#D4FFDF;" | gradereport_user_view_grade_report() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Trigger the grade_report_viewed event when a user view his grade report (this web service will be initially used by the mobile app so information can be logged in the Moodle side when a user see the same page in the app). || MDL-49500 <br />
|-<br />
| message_airnotifier<br />
| style="background:#D4FFDF;" | message_airnotifier_are_notification_preferences_configured || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.7 || style="background:#D4FFDF;" | Check if the users have notification preferences configured yet ||<br />
|-<br />
| message_airnotifier<br />
| style="background:#D4FFDF;" | message_airnotifier_is_system_configured || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.7 || style="background:#D4FFDF;" | Check whether the airnotifier settings have been configured ||<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_get_assignments() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Returns the courses and assignments for the users capability || MDL-31873<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_get_grades() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.4 || style="background:#D4FFDF;" | Returns grades from the assignment || MDL-31873<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_get_submission_status || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns information about an assignment submission status for a given user. || <br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_get_submissions || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Returns the submissions for assignments || MDL-31682<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_get_user_flags || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Returns the user_flags for assignments || MDL-40548<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_get_user_mappings || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Returns the user_mappings for assignments || MDL-40548<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_list_participants || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List the participants for a single assignment, with some summary info about their submissions. || <br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_lock_submissions || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Prevent students from making changes to a list of submissions || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_reveal_identities || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Reveal the identities for a blind marking assignment || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_revert_submissions_to_draft || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Reverts the list of submissions to draft status || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_save_grade || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Save a grade update for a single student. || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_save_grades || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.7 || style="background:#D4FFDF;" | Save grade updates for one or more students. || MDL-42425<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_save_submission || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Update the current students submission || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_save_user_extensions || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Save a list of assignment extensions || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_set_user_flags || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Sets the specified user_flags for an assignment || MDL-41738<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_submit_for_grading || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Submit the current students assignment for grading || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_submit_grading_form || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Submit the grading form data via ajax || <br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_unlock_submissions || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.6 || style="background:#D4FFDF;" | Allow students to make changes to a list of submissions || MDL-37148<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_view_grading_table || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the grading_table_viewed event. ||<br />
|-<br />
| mod_assign<br />
| style="background:#D4FFDF;" | mod_assign_view_submission_status || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the submission status viewed event. || <br />
|-<br />
| mod_book<br />
| style="background:#D4FFDF;" | mod_book_get_books_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of book instances in a provided set of courses. || MDL-50536<br />
|-<br />
| mod_book<br />
| style="background:#D4FFDF;" | mod_book_view_book || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-50013<br />
|-<br />
| mod_chat<br />
| style="background:#D4FFDF;" | mod_chat_get_chat_latest_messages || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Get the latest messages from the given chat sessio. || MDL-50853<br />
|-<br />
| mod_chat<br />
| style="background:#D4FFDF;" | mod_chat_get_chat_users || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Get the list of users in the given chat session. || MDL-50853<br />
|-<br />
| mod_chat<br />
| style="background:#D4FFDF;" | mod_chat_get_chats_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of chat instances in a provided set of courses. || MDL-50537<br />
|-<br />
| mod_chat<br />
| style="background:#D4FFDF;" | mod_chat_login_user || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Log a user into a chat room in the given chat. || MDL-50853<br />
|-<br />
| mod_chat<br />
| style="background:#D4FFDF;" | mod_chat_send_chat_message || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Send a message on the given chat session. || MDL-50853<br />
|-<br />
| mod_chat<br />
| style="background:#D4FFDF;" | mod_chat_view_chat || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-50853<br />
|-<br />
| mod_choice<br />
| style="background:#D4FFDF;" | mod_choice_delete_choice_responses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Delete the given submitted responses in a choice. || MDL-50944<br />
|-<br />
| mod_choice<br />
| style="background:#D4FFDF;" | mod_choice_get_choice_options || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Retrieve options for a specific choice. || MDL-50944<br />
|-<br />
| mod_choice<br />
| style="background:#D4FFDF;" | mod_choice_get_choice_results || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Retrieve users results for a given choice. || MDL-50944<br />
|-<br />
| mod_choice<br />
| style="background:#D4FFDF;" | mod_choice_get_choices_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of choice instances in a provided set of courses. || MDL-50132<br />
|-<br />
| mod_choice<br />
| style="background:#D4FFDF;" | mod_choice_submit_choice_response || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Submit responses to a specific choice item. || MDL-50944<br />
|-<br />
| mod_choice<br />
| style="background:#D4FFDF;" | mod_choice_view_choice || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status.. || MDL-50944<br />
|-<br />
| mod_data<br />
| style="background:#D4FFDF;" | mod_data_get_databases_by_courses() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Returns a list of database instances in a provided set of courses, if no courses are provided then all the database instances the user has access to will be returned. || MDL-49337<br />
|-<br />
| mod_folder<br />
| style="background:#D4FFDF;" | mod_folder_view_folder || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-50008<br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_add_discussion || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Add a new discussion into an existing forum. || MDL-50994<br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_add_discussion_post || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Create new posts into an existing discussion. || MDL-50995<br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_can_add_discussion || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Check if the current user can add discussions in the given forum (and optionally for the given group). || <br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_get_forum_discussion_posts() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.7 || style="background:#D4FFDF;" | Returns a list of forum posts for a discussion. || MDL-30106 <br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_get_forum_discussions_paginated() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.8 || style="background:#D4FFDF;" | Returns a list of forum discussions optionally sorted and paginated. || MDL-46458 <br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_get_forums_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.5 || style="background:#D4FFDF;" | Returns a list of forum instances in a provided set of courses, if no courses are provided then all the forum instances the user has access to will be returned. || MDL-37247 <br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_view_forum() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Trigger the course_module_viewed event when a user view a forum (this web service will be initially used by the mobile app so information can be logged in the Moodle side when a user see the same page in the app). || MDL-49502 <br />
|-<br />
| mod_forum<br />
| style="background:#D4FFDF;" | mod_forum_view_forum_discussion() || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 2.9 || style="background:#D4FFDF;" | Trigger the discussion_viewed event when a user view a forum discussion (this web service will be initially used by the mobile app so information can be logged in the Moodle side when a user see the same page in the app). || MDL-49503<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_authors || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get the authors in a glossary || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_categories || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get a glossary's categories || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_author || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries using author filtering || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_author_id || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries using author ID filtering || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_category || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries using category filtering || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_date || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries using date filtering || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_letter || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries using letter filtering || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_search || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries matching a search query || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_by_term || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries using term filtering || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entries_to_approve || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get entries to be approved || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_entry_by_id || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get an entry by ID || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_get_glossaries_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get the glossaries in courses || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_view_entry || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Notify that a glossary entry was viewed || MDL-50540<br />
|-<br />
| mod_glossary<br />
| style="background:#D4FFDF;" | mod_glossary_view_glossary || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Notify that a glossary was viewed || MDL-50540<br />
|-<br />
| mod_imscp<br />
| style="background:#D4FFDF;" | mod_imscp_get_imscps_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of imscp instances in a provided set of courses. || MDL-50541<br />
|-<br />
| mod_imscp<br />
| style="background:#D4FFDF;" | mod_imscp_view_imscp || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-50015<br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_create_tool_proxy || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a tool proxy || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_create_tool_type || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a tool type || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_delete_tool_proxy || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete a tool proxy || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_delete_tool_type || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Delete a tool type || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_get_ltis_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of lti instances in a provided set of courses. || MDL-50543<br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_get_tool_launch_data || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Return the launch data for a given external tool. || MDL-51615<br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_get_tool_proxy_registration_request || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get a registration request for a tool proxy || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_get_tool_types || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get a list of the tool types || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_is_cartridge || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Determine if the given url is for a cartridge || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_update_tool_type || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Update a tool type || <br />
|-<br />
| mod_lti<br />
| style="background:#D4FFDF;" | mod_lti_view_lti || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-51624<br />
|-<br />
| mod_page<br />
| style="background:#D4FFDF;" | mod_page_view_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-49791<br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_attempt_access_information || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return access information for a given attempt in a quiz. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_attempt_data || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns information for the given attempt page for a quiz attempt in progress. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_attempt_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns review information for the given finished attempt, can be used by users or teachers. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_attempt_summary || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns a summary of a quiz attempt before it is submitted. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_combined_review_options || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Combines the review options from a number of different quiz attempts. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_quiz_access_information || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return access information for a given quiz. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_quiz_feedback_for_grade || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get the feedback text that should be show to a student who got the given grade in the given quiz. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_quiz_required_qtypes || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return the potential question types that would be required for a given quiz. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_quizzes_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns a list of quizzes in a provided list of courses, if no list is provided all quizzes that the user can view will be returned. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_user_attempts || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Return a list of attempts for the given quiz and user. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_get_user_best_grade || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Get the best current grade for the given user on a quiz. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_process_attempt || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Process responses during an attempt at a quiz and also deals with attempts finishing. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_save_attempt || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Processes save requests during the quiz.This function is intended for the quiz auto-save feature. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_start_attempt || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Starts a new attempt at a quiz. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_view_attempt || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the attempt viewed event. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_view_attempt_review || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the attempt reviewed event. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_view_attempt_summary || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the attempt summary viewed event. || <br />
|-<br />
| mod_quiz<br />
| style="background:#D4FFDF;" | mod_quiz_view_quiz || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || <br />
|-<br />
| mod_resource<br />
| style="background:#D4FFDF;" | mod_resource_view_resource || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-49792<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_get_scorm_attempt_count || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Return the number of attempts done by a user in the given SCORM. || MDL-51017<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_get_scorm_sco_tracks || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Retrieves SCO tracking data for the given user id and attempt number. || MDL-50557<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_get_scorm_scoes || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list containing all the scoes data related to the given scorm id. || MDL-50351<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_get_scorm_user_data || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Retrieves user tracking and SCO data and default SCORM values. || MDL-50352<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_get_scorms_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of scorm instances in a provided set of courses. || MDL-50349<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_insert_scorm_tracks || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Saves a scorm tracking record. || MDL-50353<br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_launch_sco || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the SCO launched event. || <br />
|-<br />
| mod_scorm<br />
| style="background:#D4FFDF;" | mod_scorm_view_scorm || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status.. || MDL-50427<br />
|-<br />
| mod_survey<br />
| style="background:#D4FFDF;" | mod_survey_get_questions || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Get the complete list of questions for the survey, including subquestions. ||<br />
|-<br />
| mod_survey<br />
| style="background:#D4FFDF;" | mod_survey_get_surveys_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Returns a list of survey instances in a provided set of courses, if no courses are provided then all the survey instances the user has access to will be returned. ||<br />
|-<br />
| mod_survey<br />
| style="background:#D4FFDF;" | mod_survey_submit_answers || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Submit the answers for a given survey. ||<br />
|-<br />
| mod_survey<br />
| style="background:#D4FFDF;" | mod_survey_view_survey || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. ||<br />
|-<br />
| mod_url<br />
| style="background:#D4FFDF;" | mod_url_view_url || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || MDL-49793<br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_edit_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Save the contents of a page. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_get_page_contents || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns the contents of a page. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_get_page_for_editing || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Locks and retrieves info of page-section to be edited. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_get_subwiki_files || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns the list of files for a specific subwiki. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_get_subwiki_pages || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns the list of pages for a specific subwiki. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_get_subwikis || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns the list of subwikis the user can see in a specific wiki. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_get_wikis_by_courses || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns a list of wiki instances in a provided set of courses, if no courses are provided then all the wiki instances the user has access to will be returned. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_new_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Create a new page in a subwiki. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_view_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the page viewed event and update the module completion status. || <br />
|-<br />
| mod_wiki<br />
| style="background:#D4FFDF;" | mod_wiki_view_wiki || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Trigger the course module viewed event and update the module completion status. || <br />
|-<br />
| report_competency<br />
| style="background:#D4FFDF;" | report_competency_data_for_report || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the competency report in a course. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_competencies_manage_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the competencies manage page template || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_competency_frameworks_manage_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the competency frameworks manage page template || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_competency_summary || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load competency data for summary template. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_course_competencies_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the course competencies page template. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_plan_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the plan page template. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_plans_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the plans page template || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_related_competencies_section || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the related competencies template. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_template_competencies_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the template competencies page template. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_templates_manage_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the learning plan templates manage page template || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_user_competency_summary || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load a summary of a user competency. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_user_competency_summary_in_course || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load a summary of a user competency. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_user_competency_summary_in_plan || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load a summary of a user competency. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_user_evidence_list_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the user evidence list page template || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_data_for_user_evidence_page || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Load the data for the user evidence page template || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_list_courses_using_competency || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | List the courses using a competency || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_search_cohorts || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Search for cohorts. || <br />
|-<br />
| tool_lp<br />
| style="background:#D4FFDF;" | tool_lp_search_users || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Search for users. || <br />
|-<br />
| tool_mobile<br />
| style="background:#D4FFDF;" | tool_mobile_get_plugins_supporting_mobile || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.1 || style="background:#D4FFDF;" | Returns a list of Moodle plugins supporting the mobile app. || <br />
|-<br />
| tool_templatelibrary<br />
| style="background:#D4FFDF;" | tool_templatelibrary_list_templates || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | List/search templates by component. ||<br />
|-<br />
| tool_templatelibrary<br />
| style="background:#D4FFDF;" | tool_templatelibrary_load_canonical_template || style="background:#D4FFDF;" | || style="background:#D4FFDF;" | 3.0 || style="background:#D4FFDF;" | Load a canonical template by name (not the theme overidden one). ||<br />
|-<br />
|}<br />
This is the list of the integrated core functions. To see the roadmap, see to the tracker issue in the section bellow.<br />
<br />
New Web Services entries are automatically generated for each new major version via this script: https://github.com/moodlehq/moodlemobile-scripts/blob/master/ws-documenter.php<br />
<br />
=== API Roadmap===<br />
Tracker issue: MDL-29934<br />
<br />
= See also =<br />
* [[Web services API Changes]]<br />
* [[How to contribute a web service function to core]]<br />
* [[Web services|Web services developer documentation]]<br />
* [[:en:Web services|Web services user documentation]]<br />
<br />
[[Category:Web Services]]<br />
[[Category:API]]</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Moodle_3.1_release_notes&diff=50097
Moodle 3.1 release notes
2016-05-18T04:27:36Z
<p>Cameron1729: </p>
<hr />
<div>[[Releases]] > {{FULLPAGENAME}}<br />
<br />
Release date: 23 May 2016 (Not yet released)<br />
<br />
Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.1%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.1].<br />
<br />
Important: <br />
<br />
* PHP extension <tt>xmlreader</tt> is now required (MDL-51603).<br />
<br />
==Major features==<br />
<br />
===Highlights===<br />
<br />
* MDL-53451 - Competencies support in Moodle<br />
* MDL-52954 - Improvements to the Assignment grading user interface<br />
* MDL-31989 - [https://docs.moodle.org/31/en/Global_search Global Search] API allows to search forums, wikis and other content throughout the whole site. [https://docs.moodle.org/dev/Global_search Installation and setup] of SOLR server is required, <br />
* MDL-52002 - Significant performance improvements in gradebook calculations<br />
* MDL-48012 - [https://docs.moodle.org/31/en/Recycle_bin Recycle bin] plugin is now part of standard Moodle distribution: allow instructors to "undo" deletions of course modules and courses. [https://moodleassociation.org/ Moodle Users Association] project<br />
* MDL-49279 - Add support in moodle plugins for exporting "Mobile app addons"<br />
<br />
===Forum===<br />
<br />
* MDL-372 - Allow to [https://docs.moodle.org/31/en/Using_Forum#Pinned_posts "pin" discussions] to keep them always on the top of the list<br />
* MDL-34160 - Allow forum email subject to be customised<br />
* MDL-47365 - Add [https://docs.moodle.org/31/en/Using_Forum#Permalinks permalink] option to forum posts<br />
* MDL-51214 - Rename the News forum to [https://docs.moodle.org/31/en/Announcements "Announcements"]<br />
* MDL-44087 - Forum does not observe message notification settings for digest emails<br />
* MDL-53050 - Highlight the selected forum post when deep linking with a #anchor<br />
<br />
===Assignment===<br />
<br />
* MDL-52397 - ??? Assign feedback not sent if assign grade timemodified is set two days ago<br />
* MDL-52596 - Add a 'maxperpage' site wide setting for grading table size (to mitigate broken grading pages in large courses)<br />
* MDL-52269 - Not obvious to tell if an assignment is in blind marking if user holds the "mod/assign:viewblinddetails" capabilty<br />
* MDL-52270 - Difficult to cross reference users with their blind identities<br />
* MDL-44598 - List student names on 'grant extension' screen<br />
* MDL-52490 - Download selected assign submissions as a zip file<br />
* MDL-52290 - EditPDF - Also show the total page number in the pagination<br />
* MDL-52489 - "Download all submissions as a zip" should maintain the folder structure in students submissions<br />
<br />
===LTI===<br />
<br />
* MDL-52154 - Rework LTI admin screens<br />
* MDL-45064 - Option to add Preconfigured LTI Tool to Activity Chooser<br />
* MDL-52035 - Integrate LTI Provider support in Moodle<br />
* MDL-52821 - Compliance: Send tool_consumer_instance_description in LTI launch request<br />
<br />
===Feedback===<br />
<br />
* MDL-53738 - Feedback activity module will be enabled by default in new 3.1 installations. If you are upgrading to 3.1 we recommend you to enable it manually.<br />
* MDL-52094 - Various improvements to UI and bug fixes, including:<br />
** Performance improvement to download responses as raw data in multiple formats (CSV, Excel, etc.) - now available on "Show responses" page instead of "Analysis"<br />
** Allow any characters in labels, do not display empty labels<br />
** Do not display empty pages<br />
** Map frontpage feedback to multiple courses without leaving the form<br />
** Improved display of automatic question numbers<br />
** Disable "Response time" for anonymous feedbacks<br />
** Use moodleforms to display feedback<br />
<br />
===SCORM===<br />
<br />
* MDL-45712 - Add Result field to the SCORM Interactions Report<br />
* MDL-48680 - Add score and status submission events to SCORM activity<br />
* MDL-42473 - Add group support to SCORM activity<br />
<br />
===Quiz===<br />
<br />
* MDL-52738 - Quiz attempt/review page should have a previous button to match next<br />
* MDL-46092 - Add the OU styling of the Quiz navigation into Moodle core as the default<br />
* MDL-46091 - Rationalise confirmations when you start a quiz<br />
* MDL-52806 - Show right answers when manually grading automatically marked questions<br />
* MDL-53304 - Immediate feedback behaviours should not show a disabled check button when you can't use it<br />
<br />
===Other activity modules===<br />
<br />
* MDL-42190 - Workshop: Possibility to delete a submission<br />
* MDL-51306 - Folder: [https://docs.moodle.org/31/en/Folder_resource Bulk download all files within a folder activity as ZIP file]<br />
* MDL-52414 - Lesson: Allow Default Settings for [https://docs.moodle.org/31/en/Lesson_settings Lesson Module Settings]<br />
* MDL-51267 - URL/File: Make setting up a [https://docs.moodle.org/31/en/URL_resource_settings#General URL]/[https://docs.moodle.org/31/en/File_resource_settings#Uploading_files File] resource more obvious<br />
* MDL-50794 - Workshop: [https://docs.moodle.org/31/en/Workshop_settings Restricting file types as attachments] to a workshop<br />
<br />
===Gradebook===<br />
<br />
* MDL-48634 - Option to rescale existing grades when changing max points<br />
* MDL-52522 - grade_minmaxtouse should be respected for overridden categories<br />
* MDL-51900 - Tab Down Grade Column in Single View of Gradebook<br />
* MDL-52309 - Make Grade History report require user to submit parameters before the report starts running<br />
<br />
===Performance===<br />
<br />
* MDL-51374 - Do not purge entire databasemeta cache when there are structure changes (esp temp tables).<br />
* MDL-51603 - Refactor downloading of csv, ods, excel etc files in reports and exports across moodle to stream progressively<br />
* MDL-34925 - Improve bulk user export performance<br />
* MDL-50385 - Performance improvement to the grade history report<br />
<br />
===Tagging===<br />
<br />
* MDL-50851 - Introduce tag collections - ability to separate independent tag areas<br />
* MDL-52252 - Add tags to modules (Resources and Activities)<br />
* MDL-25742 - Allow to search wiki pages by tags<br />
* MDL-51283 - Rename "official" tags to "standard", allow admin to set for each tag area how to use standard tags<br />
* MDL-16855 - Add tag filtering to "Manage tags" page<br />
* MDL-52707 - Allow tags to be combined<br />
<br />
===Usability===<br />
<br />
* MDL-27628 - [https://docs.moodle.org/31/en/Course_meta_link Enrol meta:] Possible to add multiple courses without leaving the form<br />
* MDL-51818 - Move the profile 'Message' button to be next to the user picture<br />
* MDL-52258 - Calendar now shows duration in calendar block<br />
* MDL-53043 - Move user search box above the students list in the manual enrolments popup<br />
* MDL-35590 - Navigation block redesign to meet ARIA specification ([https://docs.moodle.org/dev/Tree documentation])<br />
* MDL-49963 - Allow to message all participants when there are more than one page in participants list<br />
* MDL-51354 - Help popup and improved name for events dropdown menu on the course and site logs pages<br />
* MDL-53026 - Use inplace editable for editing cohort names<br />
* MDL-51706 - Move plagiarism links to the top of the summary and full text outputs<br />
* MDL-53382 - "Show all" link on participants page should be moved beneath the page switcher<br />
<br />
===Other improvements===<br />
<br />
* MDL-53057 - Add [https://docs.moodle.org/31/en/File_system_repository#Using_a_File_System_repository_file search feature to the File system repository]<br />
* MDL-48506 - Improve memcached cache store so that it is multi-site safe<br />
* MDL-50661 - Restyle "Clean" theme to use Logo and Header in Frontpage with smaller logo option in other pages.<br />
* MDL-36652 - When downloading an Excel spreadsheet of student logs, have the course short name included in the file name. <br />
* MDL-53207 - Display stock avatar instead of own user picture from messages from fake users<br />
* MDL-52781 - ??? Improve core_user::fill_properties_cache()<br />
* MDL-51698 - Markup the crumb trail so search engines understand it and leverage it<br />
* MDL-53072 - Option to choose whether we include suspended users when auto-creating groups<br />
* MDL-52869 - Convert inline activity name edit to use the inplace editable element<br />
<br />
===For administrators===<br />
<br />
* MDL-26935 - New capability to control role renaming<br />
* MDL-28030 - Add config.php settings to allow plugins to rewrite output moodle_urls (eg clean / semantic urls)<br />
* MDL-52752 - Administrators can specify an alternate URL to use for MathJax<br />
* MDL-52219 - Completion tracking & availability should default to on for new installs<br />
* MDL-52990 - Enable all emails to be themed, ie add 4 wrapper mustache templates<br />
* MDL-53260 - Option to display CLI upgrade messages in English<br />
* MDL-52386 - Allow to control field for flagging enabled/disabled users in LDAP authentication (useful for Active Directory)<br />
* MDL-52383 - Calendar "Days to look ahead" should allow intervals up to 1 year<br />
* MDL-49934 - Admins or managers should be able to retrieve assignments info via get_assignments web service<br />
<br />
==Security issues==<br />
<br />
There are no security issues included in this release, please refer to [https://docs.moodle.org/dev/Moodle_3.0.4_release_notes Moodle 3.0.4 release notes]<br />
<br />
==For developers==<br />
* MDL-53451 - Competencies support in Moodle ([https://docs.moodle.org/dev/Competency_API documentation])<br />
* MDL-52954 - file_storage class can now convert between office documents ([https://docs.moodle.org/dev/File_API#Convert_between_file_formats_.28office_documents.29 documentation])<br />
* MDL-30811 - Introduce notification stack to moodle sessions<br />
* MDL-49279, MDL-50032 - Allow external functions to add themselves into services<br />
* MDL-51802 - Reusable element for inplace editing<br />
<br />
'''Changes to webservices XML-RPC API'''<br />
Due to MDL-53962, it is now '''critical''' to specify parameters for XML-RPC calls in the correct order. Previously Zend may have been able to work out the order, our new implementation, at this stage, cannot.<br />
<br />
* MDL-50887 - Antivirus: Implement plugins infrastructure for antivirus and create ClamAV plugin.<br />
* MDL-52237 - Add a callback to inject nodes in the user profile navigation<br />
* MDL-50464 - New renderer for RSS Client Block allows themes to customise its look<br />
* MDL-50851 - Significant changes to Tags API, tag areas can now implement callbacks to display tagged items<br />
* MDL-53274 - Throw exception (in developer mode) if page context is not set, otherwise it is not noticeable in AJAX calls<br />
* MDL-52826, MDL-52715 - Allow to use moodleforms in AJAX requests ([https://docs.moodle.org/dev/Fragment documentation])<br />
* MDL-52013 - Allow mod_assign plugins to add calendar events<br />
* MDL-51718 - Allow to specify scheme in moodle_url<br />
* MDL-51700 - Ajax service should clean the return values of the external functions<br />
* MDL-46891 - Upgrade to behat 3.x<br />
* MDL-48362 - Improve the enrol API to prevent logic in the UI ([https://docs.moodle.org/dev/Enrolment_plugins#Standard_Editing_UI documentation])<br />
* MDL-51324 - New course chooser element for moodleforms ([https://docs.moodle.org/dev/lib/formslib.php_Form_Definition#autocomplete documentation])<br />
* MDL-52996 - Allow Atto customisation for special-purpose plugins<br />
* MDL-53102 - Message-ID email headers not consistent or using correct domain<br />
* MDL-53311 - Changes to navigation tree structure<br />
* MDL-52651 - Add no referrer to links with _blank target attribute<br />
<br />
For full list of deprecations refer to lib/upgrade.txt and upgrade.txt files in the folder where the particular plugin is located. Here are the most major deprecations:<br />
<br />
* MDL-49414 - Remove deprecated web services<br />
* MDL-48621 - Deprecate the old events system<br />
* MDL-52207 - Delete Zend framework<br />
<br />
==See also==<br />
*[[Moodle 3.0 release notes]]<br />
<br />
[[Category:Release notes]]<br />
[[Category:Moodle 3.1]]<br />
<br />
[[fr:Notes de mise à jour de Moodle 3.1]]<br />
[[es:Notas de Moodle 3.1]]</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Moodle_libraries_credits&diff=49852
Moodle libraries credits
2016-04-21T05:35:12Z
<p>Cameron1729: Add credits for PHPExcel library</p>
<hr />
<div>Some of Moodle's libraries were written by other people, and are being redistributed as part of Moodle under their respective open source licenses that thankfully allow us to do so. Thanks to the authors of all these excellent products - without them Moodle would be missing important functionality. Copyright information for each package is included below:<br />
<br />
==ADOdb==<br />
<br />
''lib/adodb''<br />
<br />
Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.<br />
<br />
Version: 5.19<br />
<br />
Copyright © 2000-2006 John Lim (''jlim AT natsoft DOT com DOT my'')<br />
<br />
License: Dual LGPL and BSD-style<br />
<br />
http://adodb.sourceforge.net<br />
<br />
==Amazon S3==<br />
<br />
''repository/s3/S3.php''<br />
<br />
A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR. <br />
<br />
Version: 0.5.1<br />
<br />
Copyright (c) 2013, Donovan Schönknecht<br />
<br />
License: BSD 2-Clause<br />
<br />
https://github.com/tpyo/amazon-s3-php-class/releases<br />
<br />
==EvalMath==<br />
<br />
''lib/evalmath''<br />
<br />
Class to safely evaluate math expressions<br />
<br />
Copyright Miles Kaufmann<br />
<br />
License: BSD<br />
<br />
http://www.twmagic.com/<br />
<br />
==FLV player==<br />
<br />
''filter/mediaplugin/flvplayer.swf''<br />
<br />
Flash movie to play FLV files<br />
<br />
Copyright Jeroen Wijering <br />
<br />
License: GNU GPL<br />
<br />
http://www.jeroenwijering.com<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==FPDF Class==<br />
<br />
''lib/fpdf''<br />
<br />
Class to generate PDF files<br />
<br />
Version: 1.54<br />
<br />
Copyright Olivier PLATHEY<br />
<br />
License: Freeware<br />
<br />
http://www.setasign.com/products/fpdi/downloads<br />
<br />
==GeoIP==<br />
<br />
''lib/geoip''<br />
<br />
Library for precessing of GeoIP data files<br />
<br />
Version: 1.6<br />
<br />
Copyright MaxMind<br />
<br />
License: LGPL<br />
<br />
http://www.maxmind.com/app/php<br />
<br />
==Google APIs==<br />
<br />
"lib/google"<br />
<br />
Library Google APIs Client Library for PHP<br />
<br />
Version: 1.1.7<br />
<br />
License: Apache License Version 2.0<br />
<br />
https://github.com/google/google-api-php-client<br />
<br />
==Graph Class==<br />
<br />
''lib/graphlib.php''<br />
<br />
Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.<br />
<br />
Version: 1.6.3 (with modifications)<br />
<br />
Copyright © 2000 Herman Veluwenkamp (''hermanV AT mindless DOT com'')<br />
<br />
License: LGPL<br />
<br />
==Horde==<br />
<br />
''lib/horde''<br />
<br />
Library used by the inbound e-mail handling system.<br />
<br />
Version: 5.2.7<br />
<br />
Copyright © Horde LLC<br />
<br />
License: LGPL<br />
<br />
http://www.horde.org/<br />
<br />
==html2text==<br />
<br />
''lib/html2text''<br />
<br />
PHP script to convert HTML into an approximate text equivalent<br />
<br />
Version: 4.0.1<br />
<br />
Copyright © 2005-7 Jon Abernathy<br />
<br />
License: GNU GPL<br />
<br />
https://github.com/mtibben/html2text.git<br />
<br />
==htmlArea==<br />
<br />
''lib/editor''<br />
<br />
Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla<br />
<br />
Version: 3.0 beta (with modifications)<br />
<br />
Copyright © 2002 interactivetools.com, inc.<br />
<br />
License: htmlArea License (based on BSD license)<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==IP-Atlas==<br />
<br />
''lib/ipatlas''<br />
<br />
PHP scripts to show the location of an IP address on a map.<br />
<br />
Version: 1.0 (with modifications)<br />
<br />
Copyright © 2002 Ivan Kozik<br />
<br />
License: GNU GPL<br />
<br />
http://www.xpenguin.com/ip-atlas.php<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==Services_JSON==<br />
<br />
''lib/json''<br />
<br />
Allows PHP->JS communication via JSON<br />
<br />
Version: 1.3.1<br />
<br />
Copyright © 2005 Michal Migurski<br />
<br />
License: Modified BSD (GPL-compatible)<br />
<br />
http://pear.php.net/pepr/pepr-proposal-show.php?id=198<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==kses==<br />
<br />
''lib/kses.php''<br />
<br />
HTML/XHTML filter that only allows some elements and attributes<br />
<br />
Version: 0.2.2<br />
<br />
Copyright © 2002, 2003, 2005 Ulf Harnhammar<br />
<br />
License: GNU GPL<br />
<br />
http://sourceforge.net/projects/kses<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==MathJax==<br />
<br />
"Not actually included in Moodle. Moodle instead has a setting where the mathjax library is located. It is currently pointing to CDN by default."<br />
<br />
JavaScript filter library for displaying LaTeX, AsciiMath notation, and MathML.<br />
<br />
Version 2.6<br />
<br />
© Copyright 2015 The MathJax Consortium.<br />
<br />
License: Apache V2.0<br />
<br />
https://github.com/mathjax/MathJax<br />
<br />
==mimeTeX==<br />
<br />
''filter/tex''<br />
<br />
Compiled C program to convert TeX into GIFs<br />
<br />
Version: 1.4<br />
<br />
Copyright © 2002-2004 John Forkosh Associates, Inc<br />
<br />
License: GNU GPL<br />
<br />
http://www.forkosh.com/mimetex.html<br />
<br />
==Mustache.js==<br />
<br />
"lib/amd/src/mustache.js"<br />
<br />
JS library for displaying mustache templates.<br />
<br />
Version: 2.2.1<br />
<br />
Copyright (c) 2009 Chris Wanstrath (Ruby)<br />
<br />
Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)<br />
<br />
Copyright (c) 2010-2015 The mustache.js community<br />
<br />
License: MIT<br />
<br />
https://github.com/janl/mustache.js/releases<br />
<br />
==Mustache==<br />
<br />
"lib/mustache"<br />
<br />
PHP library for displaying mustache templates.<br />
<br />
Version: 2.10.0<br />
<br />
Copyright (c) 2010-2015 Justin Hileman<br />
<br />
License: MIT<br />
<br />
https://github.com/bobthecow/mustache.php/releases<br />
<br />
==mp3player==<br />
<br />
''lib/mp3player''<br />
<br />
Flash movie to play streaming MP3s<br />
<br />
Copyright © 2005 Andrew Walker<br />
<br />
License: GNU GPL<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==overlibmws==<br />
<br />
''lib/overlib.js''<br />
<br />
Javascript library to enable DHTML popups, floating windows, events etc<br />
<br />
Version: July 2004<br />
<br />
Copyright © 2002-2004 Foteos Macrides<br />
<br />
Copyright © 1998-2004 Erik Bosrup<br />
<br />
License: Artistic Open Source License<br />
<br />
http://www.macridesweb.com/oltest/<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
== password_compat ==<br />
<br />
''lib/password_compat''<br />
<br />
Provides forward compatibility with the password_* functions that ship with PHP 5.5.<br />
<br />
Copyright © 2012 Anthony Ferrara<br />
<br />
License: MIT License<br />
<br />
https://github.com/ircmaxell/password_compat<br />
<br />
==PclZip==<br />
<br />
''lib/pclzip''<br />
<br />
Class to create, manage and unpack zip files.<br />
<br />
Version: 2.4 RC1<br />
<br />
Copyright © 2004 Vincent Blavet (''vincent AT phpconcept DOT net'')<br />
<br />
License: GNU GPL<br />
<br />
http://www.phpconcept.net<br />
<br />
==PEAR OLE Classes==<br />
<br />
''lib/pear''<br />
<br />
Class to write Excel files<br />
<br />
Version: 0.5<br />
<br />
Copyright © 2004 Xavier Noguer<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/OLE<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==PEAR Spreadsheet_Excel_Writer==<br />
<br />
''lib/pear''<br />
<br />
Class to write Excel files<br />
<br />
Version: 0.9.1<br />
<br />
Copyright © 2004 Xavier Noguer and Mika Tuupola<br />
<br />
License: LGPL<br />
<br />
http://pear.php.net/package/Spreadsheet_Excel_Writer<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==PEAR HTML_Quickform==<br />
<br />
''lib/pear''<br />
<br />
Class to write forms<br />
<br />
Version: 3.2.6<br />
<br />
Copyright © 2004 Bertrand Mansion, Adam Daniel, Alexey Borzov<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_Quickform<br />
<br />
==PEAR HTML_Quickform_Renderer_Tableless==<br />
<br />
''lib/pear''<br />
<br />
Class to render forms without tables<br />
<br />
Version: 0.3.4<br />
<br />
Copyright © 2005 Mark Wiesemann<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_Quickform_Renderer_Tableless<br />
<br />
==PEAR HTML_QuickForm_DHTMLRulesTableless==<br />
<br />
''lib/pear''<br />
<br />
Class to render validation notices with dhtml<br />
<br />
Version: 0.1.2<br />
<br />
Copyright © 2005 Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless<br />
<br />
==PEAR HTML_Common==<br />
<br />
''lib/pear''<br />
<br />
Class with many common HTML functions (used by HTML Quickform)<br />
<br />
Version: 0.3.4<br />
<br />
Copyright © 2004 Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_Common<br />
<br />
==PEAR XML_Parser==<br />
<br />
''lib/pear''<br />
<br />
Class implementing one handy (sax-expat) XML parser<br />
<br />
Version: 1.3.2<br />
<br />
Copyright © 2004-2008 The PHP Group & Stephan Schmidt<br />
<br />
License: New BSD License<br />
<br />
http://pear.php.net/package/XML_Parser<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==PHPExcel==<br />
<br />
''lib/phpexcel/PHPExcel.php''<br />
<br />
Library to read, write and create spreadsheet documents in PHP.<br />
<br />
Version 1.8.1<br />
<br />
Copyright © 2006 - 2015 PHPExcel<br />
License: LGPL<br />
<br />
https://github.com/PHPOffice/PHPExcel<br />
<br />
==PHP mailer==<br />
<br />
''lib/class.phpmailer.php''<br />
<br />
Class for sending email using either sendmail, PHP mail(), or SMTP. Methods are based upon the standard AspEmail(tm) classes.<br />
<br />
Version 5.2.14<br />
<br />
Copyright © 2003 Brent R. Matzelle (''bmatzelle AT yahoo DOT com'')<br />
License: LGPL<br />
<br />
http://phpmailer.sourceforge.net<br />
https://github.com/PHPMailer/PHPMailer/releases<br />
<br />
==PHP Markdown==<br />
<br />
''lib/markdown.php''<br />
<br />
Functions to convert from the Markdown text format into clean XHTML.<br />
<br />
Version: 1.6.0 (with modifications)<br />
<br />
PHP Markdown Lib Copyright © 2004-2015 Michel Fortin https://michelf.ca/<br />
All rights reserved.<br />
<br />
Based on Markdown<br />
Copyright © 2003-2005 John Gruber https://daringfireball.net/<br />
All rights reserved.<br />
<br />
License: BSD<br />
<br />
http://www.michelf.com/projects/php-markdown/<br />
<br />
==Snoopy==<br />
<br />
''lib/snoopy''<br />
<br />
A PHP net client<br />
<br />
Version: 1.0<br />
<br />
Copyright © 1999-2000 Monte Ohrt (''monte AT ispi DOT net'')<br />
License: GNU LGPL<br />
<br />
http://snoopy.sourceforge.com<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==SMTP class==<br />
<br />
''lib/class.smtp.php''<br />
<br />
Class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.<br />
<br />
Version: 03/26/2001<br />
<br />
Copyright © 2001 Chris Ryan (''chris AT greatbridge DOT com'')<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==Spike PHPCoverage==<br />
<br />
''lib/spikephpcoverage''<br />
<br />
PHP code coverage reporting tool<br />
<br />
Version: 0.8.2 (with modifications)<br />
<br />
Copyright © 2004 SpikeSource Inc<br />
<br />
License: LGPL<br />
<br />
http://developer.spikesource.com/projects/phpcoverage<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==Typo3 Character Set Class==<br />
<br />
''lib/typo3''<br />
<br />
Class for conversion between charsets and multibyte-savy operations with strings.<br />
<br />
Version: 4.7.19<br />
<br />
Copyright © 2003-2005 Kasper Skaarhoj<br />
<br />
Licence: GNU GPL<br />
<br />
http://typo3.org/<br />
<br />
==Yahoo User Interface==<br />
<br />
''lib/yui''<br />
<br />
The Yahoo! User Interface Library is a set of utilities and controls, in JavaScript, for building richly interactive web applications using techniques such as DOM scripting, DHTML and AJAX. The YUI Library also includes several core CSS resources.Set of user-interface components using AJAX, DHTML etc. We use it for all our AJAX-related stuff.<br />
<br />
CVS version: 2.3.0<br />
<br />
Copyright (c) 2006, Yahoo! Inc.<br />
<br />
Licence: BSD<br />
<br />
http://developer.yahoo.com/yui/<br />
<br />
==Mustache.js==<br />
<br />
"lib/amd/src/mustache.js"<br />
<br />
JS library for displaying mustache templates.<br />
<br />
Version: 2.2.1<br />
<br />
Copyright (c) 2009 Chris Wanstrath (Ruby)<br />
<br />
Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)<br />
<br />
Copyright (c) 2010-2015 The mustache.js community<br />
<br />
License: MIT<br />
<br />
https://github.com/janl/mustache.js/releases<br />
<br />
<br />
[[Category:Credits]]</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=Moodle_libraries_credits&diff=49846
Moodle libraries credits
2016-04-20T09:01:30Z
<p>Cameron1729: </p>
<hr />
<div>Some of Moodle's libraries were written by other people, and are being redistributed as part of Moodle under their respective open source licenses that thankfully allow us to do so. Thanks to the authors of all these excellent products - without them Moodle would be missing important functionality. Copyright information for each package is included below:<br />
<br />
==ADOdb==<br />
<br />
''lib/adodb''<br />
<br />
Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.<br />
<br />
Version: 5.19<br />
<br />
Copyright © 2000-2006 John Lim (''jlim AT natsoft DOT com DOT my'')<br />
<br />
License: Dual LGPL and BSD-style<br />
<br />
http://adodb.sourceforge.net<br />
<br />
==Amazon S3==<br />
<br />
''repository/s3/S3.php''<br />
<br />
A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR. <br />
<br />
Version: 0.5.1<br />
<br />
Copyright (c) 2013, Donovan Schönknecht<br />
<br />
License: BSD 2-Clause<br />
<br />
https://github.com/tpyo/amazon-s3-php-class/releases<br />
<br />
==EvalMath==<br />
<br />
''lib/evalmath''<br />
<br />
Class to safely evaluate math expressions<br />
<br />
Copyright Miles Kaufmann<br />
<br />
License: BSD<br />
<br />
http://www.twmagic.com/<br />
<br />
==FLV player==<br />
<br />
''filter/mediaplugin/flvplayer.swf''<br />
<br />
Flash movie to play FLV files<br />
<br />
Copyright Jeroen Wijering <br />
<br />
License: GNU GPL<br />
<br />
http://www.jeroenwijering.com<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==FPDF Class==<br />
<br />
''lib/fpdf''<br />
<br />
Class to generate PDF files<br />
<br />
Version: 1.54<br />
<br />
Copyright Olivier PLATHEY<br />
<br />
License: Freeware<br />
<br />
http://www.setasign.com/products/fpdi/downloads<br />
<br />
==GeoIP==<br />
<br />
''lib/geoip''<br />
<br />
Library for precessing of GeoIP data files<br />
<br />
Version: 1.6<br />
<br />
Copyright MaxMind<br />
<br />
License: LGPL<br />
<br />
http://www.maxmind.com/app/php<br />
<br />
==Google APIs==<br />
<br />
"lib/google"<br />
<br />
Library Google APIs Client Library for PHP<br />
<br />
Version: 1.1.5<br />
<br />
License: Apache License Version 2.0<br />
<br />
https://github.com/google/google-api-php-client<br />
<br />
==Graph Class==<br />
<br />
''lib/graphlib.php''<br />
<br />
Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.<br />
<br />
Version: 1.6.3 (with modifications)<br />
<br />
Copyright © 2000 Herman Veluwenkamp (''hermanV AT mindless DOT com'')<br />
<br />
License: LGPL<br />
<br />
==Horde==<br />
<br />
''lib/horde''<br />
<br />
Library used by the inbound e-mail handling system.<br />
<br />
Version: 5.2.7<br />
<br />
Copyright © Horde LLC<br />
<br />
License: LGPL<br />
<br />
http://www.horde.org/<br />
<br />
==html2text==<br />
<br />
''lib/html2text''<br />
<br />
PHP script to convert HTML into an approximate text equivalent<br />
<br />
Version: 4.0.1<br />
<br />
Copyright © 2005-7 Jon Abernathy<br />
<br />
License: GNU GPL<br />
<br />
https://github.com/mtibben/html2text.git<br />
<br />
==htmlArea==<br />
<br />
''lib/editor''<br />
<br />
Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla<br />
<br />
Version: 3.0 beta (with modifications)<br />
<br />
Copyright © 2002 interactivetools.com, inc.<br />
<br />
License: htmlArea License (based on BSD license)<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==IP-Atlas==<br />
<br />
''lib/ipatlas''<br />
<br />
PHP scripts to show the location of an IP address on a map.<br />
<br />
Version: 1.0 (with modifications)<br />
<br />
Copyright © 2002 Ivan Kozik<br />
<br />
License: GNU GPL<br />
<br />
http://www.xpenguin.com/ip-atlas.php<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==Services_JSON==<br />
<br />
''lib/json''<br />
<br />
Allows PHP->JS communication via JSON<br />
<br />
Version: 1.3.1<br />
<br />
Copyright © 2005 Michal Migurski<br />
<br />
License: Modified BSD (GPL-compatible)<br />
<br />
http://pear.php.net/pepr/pepr-proposal-show.php?id=198<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==kses==<br />
<br />
''lib/kses.php''<br />
<br />
HTML/XHTML filter that only allows some elements and attributes<br />
<br />
Version: 0.2.2<br />
<br />
Copyright © 2002, 2003, 2005 Ulf Harnhammar<br />
<br />
License: GNU GPL<br />
<br />
http://sourceforge.net/projects/kses<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==MathJax==<br />
<br />
"Not actually included in Moodle. Moodle instead has a setting where the mathjax library is located. It is currently pointing to CDN by default."<br />
<br />
JavaScript filter library for displaying LaTeX, AsciiMath notation, and MathML.<br />
<br />
Version 2.6<br />
<br />
© Copyright 2015 The MathJax Consortium.<br />
<br />
License: Apache V2.0<br />
<br />
https://github.com/mathjax/MathJax<br />
<br />
==mimeTeX==<br />
<br />
''filter/tex''<br />
<br />
Compiled C program to convert TeX into GIFs<br />
<br />
Version: 1.4<br />
<br />
Copyright © 2002-2004 John Forkosh Associates, Inc<br />
<br />
License: GNU GPL<br />
<br />
http://www.forkosh.com/mimetex.html<br />
<br />
==Mustache.js==<br />
<br />
"lib/amd/src/mustache.js"<br />
<br />
JS library for displaying mustache templates.<br />
<br />
Version: 2.2.1<br />
<br />
Copyright (c) 2009 Chris Wanstrath (Ruby)<br />
<br />
Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)<br />
<br />
Copyright (c) 2010-2015 The mustache.js community<br />
<br />
License: MIT<br />
<br />
https://github.com/janl/mustache.js/releases<br />
<br />
==Mustache==<br />
<br />
"lib/mustache"<br />
<br />
PHP library for displaying mustache templates.<br />
<br />
Version: 2.10.0<br />
<br />
Copyright (c) 2010-2015 Justin Hileman<br />
<br />
License: MIT<br />
<br />
https://github.com/bobthecow/mustache.php/releases<br />
<br />
==mp3player==<br />
<br />
''lib/mp3player''<br />
<br />
Flash movie to play streaming MP3s<br />
<br />
Copyright © 2005 Andrew Walker<br />
<br />
License: GNU GPL<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==overlibmws==<br />
<br />
''lib/overlib.js''<br />
<br />
Javascript library to enable DHTML popups, floating windows, events etc<br />
<br />
Version: July 2004<br />
<br />
Copyright © 2002-2004 Foteos Macrides<br />
<br />
Copyright © 1998-2004 Erik Bosrup<br />
<br />
License: Artistic Open Source License<br />
<br />
http://www.macridesweb.com/oltest/<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
== password_compat ==<br />
<br />
''lib/password_compat''<br />
<br />
Provides forward compatibility with the password_* functions that ship with PHP 5.5.<br />
<br />
Copyright © 2012 Anthony Ferrara<br />
<br />
License: MIT License<br />
<br />
https://github.com/ircmaxell/password_compat<br />
<br />
==PclZip==<br />
<br />
''lib/pclzip''<br />
<br />
Class to create, manage and unpack zip files.<br />
<br />
Version: 2.4 RC1<br />
<br />
Copyright © 2004 Vincent Blavet (''vincent AT phpconcept DOT net'')<br />
<br />
License: GNU GPL<br />
<br />
http://www.phpconcept.net<br />
<br />
==PEAR OLE Classes==<br />
<br />
''lib/pear''<br />
<br />
Class to write Excel files<br />
<br />
Version: 0.5<br />
<br />
Copyright © 2004 Xavier Noguer<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/OLE<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==PEAR Spreadsheet_Excel_Writer==<br />
<br />
''lib/pear''<br />
<br />
Class to write Excel files<br />
<br />
Version: 0.9.1<br />
<br />
Copyright © 2004 Xavier Noguer and Mika Tuupola<br />
<br />
License: LGPL<br />
<br />
http://pear.php.net/package/Spreadsheet_Excel_Writer<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==PEAR HTML_Quickform==<br />
<br />
''lib/pear''<br />
<br />
Class to write forms<br />
<br />
Version: 3.2.6<br />
<br />
Copyright © 2004 Bertrand Mansion, Adam Daniel, Alexey Borzov<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_Quickform<br />
<br />
==PEAR HTML_Quickform_Renderer_Tableless==<br />
<br />
''lib/pear''<br />
<br />
Class to render forms without tables<br />
<br />
Version: 0.3.4<br />
<br />
Copyright © 2005 Mark Wiesemann<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_Quickform_Renderer_Tableless<br />
<br />
==PEAR HTML_QuickForm_DHTMLRulesTableless==<br />
<br />
''lib/pear''<br />
<br />
Class to render validation notices with dhtml<br />
<br />
Version: 0.1.2<br />
<br />
Copyright © 2005 Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless<br />
<br />
==PEAR HTML_Common==<br />
<br />
''lib/pear''<br />
<br />
Class with many common HTML functions (used by HTML Quickform)<br />
<br />
Version: 0.3.4<br />
<br />
Copyright © 2004 Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov<br />
<br />
License: PHP (plus special exemption for Moodle to make it compatible)<br />
<br />
http://pear.php.net/package/HTML_Common<br />
<br />
==PEAR XML_Parser==<br />
<br />
''lib/pear''<br />
<br />
Class implementing one handy (sax-expat) XML parser<br />
<br />
Version: 1.3.2<br />
<br />
Copyright © 2004-2008 The PHP Group & Stephan Schmidt<br />
<br />
License: New BSD License<br />
<br />
http://pear.php.net/package/XML_Parser<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==PHP mailer==<br />
<br />
''lib/class.phpmailer.php''<br />
<br />
Class for sending email using either sendmail, PHP mail(), or SMTP. Methods are based upon the standard AspEmail(tm) classes.<br />
<br />
Version 5.2.14<br />
<br />
Copyright © 2003 Brent R. Matzelle (''bmatzelle AT yahoo DOT com'')<br />
License: LGPL<br />
<br />
http://phpmailer.sourceforge.net<br />
https://github.com/PHPMailer/PHPMailer/releases<br />
<br />
==PHP Markdown==<br />
<br />
''lib/markdown.php''<br />
<br />
Functions to convert from the Markdown text format into clean XHTML.<br />
<br />
Version: 1.5.0 (with modifications)<br />
<br />
PHP Markdown Lib Copyright © 2004-2015 Michel Fortin https://michelf.ca/<br />
All rights reserved.<br />
<br />
Based on Markdown<br />
Copyright © 2003-2005 John Gruber https://daringfireball.net/<br />
All rights reserved.<br />
<br />
License: BSD<br />
<br />
http://www.michelf.com/projects/php-markdown/<br />
<br />
==Snoopy==<br />
<br />
''lib/snoopy''<br />
<br />
A PHP net client<br />
<br />
Version: 1.0<br />
<br />
Copyright © 1999-2000 Monte Ohrt (''monte AT ispi DOT net'')<br />
License: GNU LGPL<br />
<br />
http://snoopy.sourceforge.com<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==SMTP class==<br />
<br />
''lib/class.smtp.php''<br />
<br />
Class that can be used to connect and communicate with any SMTP server. It implements all the SMTP functions defined in RFC821 except TURN.<br />
<br />
Version: 03/26/2001<br />
<br />
Copyright © 2001 Chris Ryan (''chris AT greatbridge DOT com'')<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==Spike PHPCoverage==<br />
<br />
''lib/spikephpcoverage''<br />
<br />
PHP code coverage reporting tool<br />
<br />
Version: 0.8.2 (with modifications)<br />
<br />
Copyright © 2004 SpikeSource Inc<br />
<br />
License: LGPL<br />
<br />
http://developer.spikesource.com/projects/phpcoverage<br />
<br />
(This library is not currently used in Moodle)<br />
<br />
==Typo3 Character Set Class==<br />
<br />
''lib/typo3''<br />
<br />
Class for conversion between charsets and multibyte-savy operations with strings.<br />
<br />
Version: 4.7.19<br />
<br />
Copyright © 2003-2005 Kasper Skaarhoj<br />
<br />
Licence: GNU GPL<br />
<br />
http://typo3.org/<br />
<br />
==Yahoo User Interface==<br />
<br />
''lib/yui''<br />
<br />
The Yahoo! User Interface Library is a set of utilities and controls, in JavaScript, for building richly interactive web applications using techniques such as DOM scripting, DHTML and AJAX. The YUI Library also includes several core CSS resources.Set of user-interface components using AJAX, DHTML etc. We use it for all our AJAX-related stuff.<br />
<br />
CVS version: 2.3.0<br />
<br />
Copyright (c) 2006, Yahoo! Inc.<br />
<br />
Licence: BSD<br />
<br />
http://developer.yahoo.com/yui/<br />
<br />
==Mustache.js==<br />
<br />
"lib/amd/src/mustache.js"<br />
<br />
JS library for displaying mustache templates.<br />
<br />
Version: 2.2.1<br />
<br />
Copyright (c) 2009 Chris Wanstrath (Ruby)<br />
<br />
Copyright (c) 2010-2014 Jan Lehnardt (JavaScript)<br />
<br />
Copyright (c) 2010-2015 The mustache.js community<br />
<br />
License: MIT<br />
<br />
https://github.com/janl/mustache.js/releases<br />
<br />
<br />
[[Category:Credits]]</div>
Cameron1729
https://docs.moodle.org/dev/index.php?title=sandbox&diff=49845
sandbox
2016-04-20T08:47:38Z
<p>Cameron1729: </p>
<hr />
<div>For playing around in....<br />
a<br />
<br />
asdf</div>
Cameron1729