IMSGlobal\LTI\ToolProvider\ToolProxy Class Reference

Public Member Functions
	__construct ($dataConnector, $id=null)
	Class constructor.
	getConsumer ()
	Get tool consumer.
	getDataConnector ()
	Get the data connector.
	getRecordId ()
	Get the tool proxy record ID.
	initialise ()
	Initialise the tool proxy.
	initialize ()
	Initialise the tool proxy.
	setConsumerId ($consumerId)
	Set tool consumer ID.
	setRecordId ($recordId)
	Sets the tool proxy record ID.

Public Attributes
string	$id = null
	Local id of tool consumer.

Constructor & Destructor Documentation

__construct()

IMSGlobal\LTI\ToolProvider\ToolProxy::__construct	(		$dataConnector,
			$id = null )

Class constructor.

Parameters

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

Member Function Documentation

getConsumer()

IMSGlobal\LTI\ToolProvider\ToolProxy::getConsumer

(

)

Get tool consumer.

Return values

ToolConsumer

Tool consumer object for this context.

getDataConnector()

IMSGlobal\LTI\ToolProvider\ToolProxy::getDataConnector

(

)

Get the data connector.

Return values

DataConnector

Data connector object

getRecordId()

IMSGlobal\LTI\ToolProvider\ToolProxy::getRecordId

(

)

Get the tool proxy record ID.

Return values

int	Tool Proxy record ID value

initialise()

IMSGlobal\LTI\ToolProvider\ToolProxy::initialise

(

)

Initialise the tool proxy.

Pseudonym for initialize().

setConsumerId()

IMSGlobal\LTI\ToolProvider\ToolProxy::setConsumerId

(

$consumerId

)

Set tool consumer ID.

Parameters

int

$consumerId

Tool Consumer ID for this resource link.

setRecordId()

IMSGlobal\LTI\ToolProvider\ToolProxy::setRecordId

(

$recordId

)

Sets the tool proxy record ID.

Parameters

int

$recordId

Tool Proxy record ID value

Member Data Documentation

$id

string IMSGlobal\LTI\ToolProvider\ToolProxy::$id = null

Local id of tool consumer.

$id

---

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

• lib/ltiprovider/src/ToolProvider/ToolProxy.php