webservice_server Class Reference

Inheritance diagram for webservice_server:

Collaboration diagram for webservice_server:

Public Member Functions
	__construct ($authmethod)
Protected Member Functions
	authenticate_user ()
	authenticate_by_token ($tokentype)
Protected Attributes
	$wsname = null
	$username = null
	$password = null
	$userid = null
	$authmethod
	$token = null
	$restricted_context
	$restricted_serviceid = null

---

Detailed Description

Abstract web service base class.

Author:

Petr Skoda (skodak)

Definition at line 688 of file lib.php.

---

Constructor & Destructor Documentation

__construct

(

$

authmethod

)

Contructor

Parameters:

integer

$authmethod

authentication method one of WEBSERVICE_AUTHMETHOD_*

Reimplemented in webservice_soap_server, webservice_xmlrpc_server, and webservice_amf_server.

Definition at line 718 of file lib.php.

---

Member Function Documentation

authenticate_by_token

(

$

tokentype

)

[protected]

Definition at line 830 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

authenticate_user

(

)

[protected]

Authenticate user using username+password or token. This function sets up $USER global. It is safe to use has_capability() after this. This method also verifies user is allowed to use this server.

Returns:

void

Definition at line 731 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$authmethod [protected]

Definition at line 703 of file lib.php.

$password = null [protected]

Definition at line 697 of file lib.php.

$restricted_context [protected]

Definition at line 709 of file lib.php.

$restricted_serviceid = null [protected]

Definition at line 712 of file lib.php.

$token = null [protected]

Definition at line 706 of file lib.php.

$userid = null [protected]

Definition at line 700 of file lib.php.

$username = null [protected]

Definition at line 694 of file lib.php.

$wsname = null [protected]

Definition at line 691 of file lib.php.

---

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

• C:/xampp/htdocs/moodle/webservice/lib.php