Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
webservice_server Class Reference

Abstract web service base class. More...

Inheritance diagram for webservice_server:
webservice_server_interface

Public Member Functions

 __construct ($authmethod)
 Constructor. More...
 
 run ()
 Process request from client.
 

Protected Member Functions

 authenticate_by_token ($tokentype)
 User authentication by token. More...
 
 authenticate_user ()
 Authenticate user using username+password or token. More...
 
 set_web_service_call_settings ()
 Intercept some moodlewssettingXXX $_GET and $_POST parameter that are related to the web service call and are not the function parameters.
 

Protected Attributes

integer $authmethod
 Authentication method one of WEBSERVICE_AUTHMETHOD_*.
 
string $password = null
 Password of the local user.
 
stdClass $restricted_context
 Restricted context.
 
int $restricted_serviceid = null
 Restrict call to one service id.
 
string $token = null
 Authentication token.
 
int $userid = null
 The local user.
 
string $username = null
 Name of local user.
 
string $wsname = null
 Name of the web server plugin.
 

Detailed Description

Abstract web service base class.

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

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