Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/ltiprovider/src/ToolProvider/ -> ToolProxy.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 194 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ToolProxy:: (9 methods):
  __construct()
  initialize()
  initialise()
  getRecordId()
  setRecordId()
  getConsumer()
  setConsumerId()
  getDataConnector()
  load()


Class: ToolProxy  - X-Ref

Class to represent an LTI Tool Proxy

__construct($dataConnector, $id = null)   X-Ref
Class constructor.

param: DataConnector   $dataConnector   Data connector
param: string                        $id              Tool Proxy ID (optional, default is null)

initialize()   X-Ref
Initialise the tool proxy.


initialise()   X-Ref
Initialise the tool proxy.

Pseudonym for initialize().

getRecordId()   X-Ref
Get the tool proxy record ID.

return: int Tool Proxy record ID value

setRecordId($recordId)   X-Ref
Sets the tool proxy record ID.

param: int $recordId  Tool Proxy record ID value

getConsumer()   X-Ref
Get tool consumer.

return: ToolConsumer Tool consumer object for this context.

setConsumerId($consumerId)   X-Ref
Set tool consumer ID.

param: int $consumerId  Tool Consumer ID for this resource link.

getDataConnector()   X-Ref
Get the data connector.

return: DataConnector  Data connector object

load($id)   X-Ref
Load the tool proxy from the database.

param: string  $id        The tool proxy id value
return: boolean True if the tool proxy was successfully loaded