Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Classes | Functions
externallib.php File Reference

Support for external API. More...

Classes

class  external_api
 Base class for external api methods. More...
 
class  external_description
 Common ancestor of all parameter description classes. More...
 
class  external_files
 External structure representing a set of files. More...
 
class  external_format_value
 A pre-filled external_value class for text format. More...
 
class  external_function_parameters
 Description of top level - PHP function parameters. More...
 
class  external_multiple_structure
 Bulk array description class. More...
 
class  external_settings
 Singleton to handle the external settings. More...
 
class  external_single_structure
 Associative array description class. More...
 
class  external_util
 Utility functions for the external API. More...
 
class  external_value
 Scalar value description class. More...
 
class  external_warnings
 Standard Moodle web service warnings. More...
 
class  restricted_context_exception
 Exception indicating user is not allowed to use external function in the current context. More...
 

Functions

 external_create_service_token ($servicename, $context)
 Create and return a session linked token. More...
 
 external_delete_descriptions ($component)
 Delete all pre-built services (+ related tokens) and external functions information defined in the specified component. More...
 
 external_format_string ($str, $contextorid, $striplinks=true, $options=array())
 Format the string to be returned properly as requested by the either the web service server, either by an internally call. More...
 
 external_format_text ($text, $textformat, $contextorid, $component=null, $filearea=null, $itemid=null, $options=null)
 Format the text to be returned properly as requested by the either the web service server, either by an internally call. More...
 
 external_generate_token ($tokentype, $serviceorid, $userid, $contextorid, $validuntil=0, $iprestriction='')
 Generate a token. More...
 
 external_generate_token_for_current_user ($service)
 Generate or return an existing token for the current authenticated user. More...
 
 external_log_token_request ($token)
 Set the last time a token was sent and trigger the core::event::webservice_token_sent event. More...
 
 external_validate_format ($format)
 Validate text field format against known FORMAT_XXX. More...
 

Detailed Description

Support for external API.

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