A resource implementing the Context-level (ToolProxyBinding) Settings.
More...
|
| __construct ($service) |
| Class constructor.
|
|
| check_tool ($typeid, $body=null, $scopes=null) |
| Check to make sure the request is valid.
|
|
| check_tool_proxy ($toolproxyguid, $body=null) |
| Check to make sure the request is valid.
|
|
| check_type ($typeid, $contextid, $permissionrequested, $body=null) |
| Check to make sure the request is valid.
|
|
| execute ($response) |
| Execute the request for this resource.
|
|
| get_endpoint () |
| Get the resource fully qualified endpoint.
|
|
| get_formats () |
| Get the resource media types.
|
|
| get_id () |
| Get the resource ID.
|
|
| get_methods () |
| Get the resource methods.
|
|
| get_path () |
| Get the resource path.
|
|
| get_permissions ($ltitype) |
| get permissions from the config of the tool for that resource
|
|
| get_service () |
| Get the resource's service.
|
|
| get_template () |
| Get the resource template.
|
|
| get_type () |
| Get the resource type.
|
|
| get_variables () |
| Get the resource template variables.
|
|
| parse_value ($value) |
| Parse a value for custom parameter substitution variables.
|
|
|
const | HTTP_DELETE = 'DELETE' |
| HTTP Delete method.
|
|
const | HTTP_GET = 'GET' |
| HTTP Get method.
|
|
const | HTTP_POST = 'POST' |
| HTTP Post method.
|
|
const | HTTP_PUT = 'PUT' |
| HTTP Put method.
|
|
|
array | $formats |
| Media types supported by this resource.
|
|
string | $id |
| ID for this resource.
|
|
array | $methods |
| HTTP actions supported by this resource.
|
|
array | $params |
| Template variables parsed from the resource template.
|
|
string | $template |
| Template for this resource.
|
|
string | $type |
| Type for this resource.
|
|
array | $variables |
| Custom parameter substitution variables associated with this resource.
|
|
A resource implementing the Context-level (ToolProxyBinding) Settings.
- Since
- Moodle 2.8
- Copyright
- 2014 Vital Source Technologies http://vitalsource.com
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
ltiservice_toolsettings\local\resources\contextsettings::__construct |
( |
| $service | ) |
|
◆ check_tool()
mod_lti\local\ltiservice\resource_base::check_tool |
( |
| $typeid, |
|
|
| $body = null, |
|
|
| $scopes = null ) |
|
inherited |
Check to make sure the request is valid.
- Parameters
-
int | $typeid | The typeid we want to use |
string | $body | Body of HTTP request message |
string[] | $scopes | Array of scope(s) required for incoming request |
- Return values
-
◆ check_tool_proxy()
mod_lti\local\ltiservice\resource_base::check_tool_proxy |
( |
| $toolproxyguid, |
|
|
| $body = null ) |
|
inherited |
Check to make sure the request is valid.
- Parameters
-
string | $toolproxyguid | Consumer key |
string | $body | Body of HTTP request message |
- Return values
-
- Deprecated
- since Moodle 3.7 MDL-62599 - please do not use this function any more.
- See also
- resource_base\check_tool()
◆ check_type()
mod_lti\local\ltiservice\resource_base::check_type |
( |
| $typeid, |
|
|
| $contextid, |
|
|
| $permissionrequested, |
|
|
| $body = null ) |
|
inherited |
Check to make sure the request is valid.
- Parameters
-
int | $typeid | The typeid we want to use |
int | $contextid | The course we are at |
string | $permissionrequested | The permission to be checked |
string | $body | Body of HTTP request message |
- Return values
-
- Deprecated
- since Moodle 3.7 MDL-62599 - please do not use this function any more.
- See also
- resource_base\check_tool()
◆ execute()
ltiservice_toolsettings\local\resources\contextsettings::execute |
( |
| $response | ) |
|
◆ get_endpoint()
mod_lti\local\ltiservice\resource_base::get_endpoint |
( |
| ) |
|
|
inherited |
◆ get_formats()
mod_lti\local\ltiservice\resource_base::get_formats |
( |
| ) |
|
|
inherited |
Get the resource media types.
- Return values
-
◆ get_id()
mod_lti\local\ltiservice\resource_base::get_id |
( |
| ) |
|
|
inherited |
Get the resource ID.
- Return values
-
◆ get_methods()
mod_lti\local\ltiservice\resource_base::get_methods |
( |
| ) |
|
|
inherited |
Get the resource methods.
- Return values
-
◆ get_path()
mod_lti\local\ltiservice\resource_base::get_path |
( |
| ) |
|
|
inherited |
◆ get_permissions()
mod_lti\local\ltiservice\resource_base::get_permissions |
( |
| $ltitype | ) |
|
|
inherited |
◆ get_service()
mod_lti\local\ltiservice\resource_base::get_service |
( |
| ) |
|
|
inherited |
Get the resource's service.
- Return values
-
◆ get_template()
mod_lti\local\ltiservice\resource_base::get_template |
( |
| ) |
|
|
inherited |
Get the resource template.
- Return values
-
◆ get_type()
mod_lti\local\ltiservice\resource_base::get_type |
( |
| ) |
|
|
inherited |
Get the resource type.
- Return values
-
◆ get_variables()
mod_lti\local\ltiservice\resource_base::get_variables |
( |
| ) |
|
|
inherited |
Get the resource template variables.
- Return values
-
◆ parse_template()
mod_lti\local\ltiservice\resource_base::parse_template |
( |
| ) |
|
|
protectedinherited |
Parse the template for variables.
- Return values
-
◆ parse_value()
ltiservice_toolsettings\local\resources\contextsettings::parse_value |
( |
| $value | ) |
|
The documentation for this class was generated from the following file: