Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Public Attributes | List of all members
webservice_parameter_exception Class Reference

Web service parameter exception class. More...

Inheritance diagram for webservice_parameter_exception:
moodle_exception

Public Member Functions

 __construct ($errorcode=null, $a='', $debuginfo=null)
 Constructor. More...
 

Public Attributes

mixed $a
 Extra words and phrases that might be required in the error string.
 
string $debuginfo
 Optional information to aid the debugging process.
 
string $errorcode
 The name of the string from error.php to print.
 
string $link
 The url where the user will be prompted to continue. More...
 
string $module
 The name of module.
 

Detailed Description

Web service parameter exception class.

Deprecated:
since Moodle 2.2 - use moodle exception instead This exception must be thrown to the web service client when a web service parameter is invalid The error string is gotten from webservice.php

Constructor & Destructor Documentation

◆ __construct()

webservice_parameter_exception::__construct (   $errorcode = null,
  $a = '',
  $debuginfo = null 
)

Constructor.

Parameters
string$errorcodeThe name of the string from webservice.php to print
string$aThe name of the parameter
string$debuginfoOptional information to aid debugging

Member Data Documentation

◆ $link

string moodle_exception::$link
inherited

The url where the user will be prompted to continue.

If no url is provided the user will be directed to the site index page.


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