ToolProxy Class Reference

Class to represent an LTI Tool Proxy. More...

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

Data Fields
	$id = null
	Local id of tool consumer. More...

Detailed Description

Class to represent an LTI Tool Proxy.

Author

Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright

IMS Global Learning Consortium Inc

Date

2016

Version

3.0.2

Licence:

GNU Lesser General Public License, version 3 (http://www.gnu.org/licenses/lgpl.html)

Definition at line 17 of file ToolProxy.php.

Constructor & Destructor Documentation

__construct	(		$dataConnector,
			$id = null
	)

Class constructor.

Parameters

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

Definition at line 64 of file ToolProxy.php.

References ToolProxy\$id, DataConnector\getRandomString(), and ToolProxy\initialize().

Member Function Documentation

getConsumer

(

)

Get tool consumer.

Returns

ToolConsumer Tool consumer object for this context.

Definition at line 132 of file ToolProxy.php.

References ToolConsumer\fromRecordId(), and ToolProxy\getDataConnector().

getDataConnector

(

)

Get the data connector.

Returns

DataConnector Data connector object

Definition at line 161 of file ToolProxy.php.

References ToolProxy\$id, and ToolProxy\initialize().

Referenced by ToolProxy\getConsumer().

getRecordId

(

)

Get the tool proxy record ID.

Returns

int Tool Proxy record ID value

Definition at line 108 of file ToolProxy.php.

initialise

(

)

Initialise the tool proxy.

Pseudonym for initialize().

Definition at line 96 of file ToolProxy.php.

References ToolProxy\initialize().

initialize

(

)

Initialise the tool proxy.

Definition at line 80 of file ToolProxy.php.

Referenced by ToolProxy\__construct(), ToolProxy\getDataConnector(), and ToolProxy\initialise().

setConsumerId

(

$consumerId

)

Set tool consumer ID.

Parameters

int

$consumerId

Tool Consumer ID for this resource link.

Definition at line 148 of file ToolProxy.php.

setRecordId

(

$recordId

)

Sets the tool proxy record ID.

Parameters

int

$recordId

Tool Proxy record ID value

Definition at line 120 of file ToolProxy.php.

Field Documentation

int $id = null

Local id of tool consumer.

Consumer ID value.

Definition at line 25 of file ToolProxy.php.

Referenced by ToolProxy\__construct(), and ToolProxy\getDataConnector().

---

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

• ToolProxy.php