|
| __construct ($source, $endpoint, $simple=true) |
| Class constructor.
|
|
| get ($mode=self::MODE_CURRENT_LEVEL) |
| Get the tool settings.
|
|
| send ($method, $parameters=array(), $body=null) |
| Send a service request.
|
|
| set ($settings) |
| Set the tool settings.
|
|
|
boolean | $unsigned = false |
| Whether service request should be sent unsigned.
|
|
const | MODE_ALL_LEVELS = 2 |
| Settings at all levels mode.
|
|
const | MODE_CURRENT_LEVEL = 1 |
| Settings at current level mode.
|
|
const | MODE_DISTINCT_NAMES = 3 |
| Settings with distinct names at all levels mode.
|
|
◆ __construct()
IMSGlobal\LTI\ToolProvider\Service\ToolSettings::__construct |
( |
| $source, |
|
|
| $endpoint, |
|
|
| $simple = true ) |
Class constructor.
- Parameters
-
object | $source | The object to which the settings apply (ResourceLink, Context or ToolConsumer) |
string | $endpoint | Service endpoint |
boolean | $simple | True if the simple media type is to be used (optional, default is true) |
Reimplemented from IMSGlobal\LTI\ToolProvider\Service\Service.
◆ get()
IMSGlobal\LTI\ToolProvider\Service\ToolSettings::get |
( |
| $mode = self::MODE_CURRENT_LEVEL | ) |
|
Get the tool settings.
- Parameters
-
int | $mode | Mode for request (optional, default is current level only) |
- Return values
-
mixed | The array of settings if successful, otherwise false |
◆ send()
IMSGlobal\LTI\ToolProvider\Service\Service::send |
( |
| $method, |
|
|
| $parameters = array(), |
|
|
| $body = null ) |
|
inherited |
Send a service request.
- Parameters
-
string | $method | The action type constant (optional, default is GET) |
array | $parameters | Query parameters to add to endpoint (optional, default is none) |
string | $body | Body of request (optional, default is null) |
- Return values
-
HTTPMessage | HTTP object containing request and response details |
◆ set()
IMSGlobal\LTI\ToolProvider\Service\ToolSettings::set |
( |
| $settings | ) |
|
Set the tool settings.
- Parameters
-
array | $settings | An associative array of settings (optional, default is null) |
- Return values
-
HTTPMessage | HTTP object containing request and response details |
◆ $endpoint
string IMSGlobal\LTI\ToolProvider\Service\Service::$endpoint |
|
protectedinherited |
Service endpoint.
$endpoint
◆ $unsigned
boolean IMSGlobal\LTI\ToolProvider\Service\Service::$unsigned = false |
|
inherited |
Whether service request should be sent unsigned.
$unsigned
The documentation for this class was generated from the following file:
- lib/ltiprovider/src/ToolProvider/Service/ToolSettings.php