ApiTool Class Reference

Class to implement tool specific functions for LTI messages. More...

Inheritance diagram for ApiTool:

Public Member Functions
	__construct ($tool)
	Class constructor.
	isConfigured ()
	Check if the API hook has been configured.
string	getUserId ()
	Get the User ID.
string	getContextId ()
	Get the Context ID.

Protected Attributes
ceLTIc LTI Tool null	$tool = null
	Tool object.

Detailed Description

Class to implement tool specific functions for LTI messages.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

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

Constructor & Destructor Documentation

__construct()

__construct

(

$tool

)

Class constructor.

Parameters

\ceLTIc\LTI\Tool | null

$tool

Reimplemented in CanvasApiToolProvider, and ApiToolProvider.

Member Function Documentation

getContextId()

string getContextId

(

)

Get the Context ID.

Returns

string Context ID value, or empty string if not available.

getUserId()

string getUserId

(

)

Get the User ID.

Returns

string User ID value, or empty string if not available.

Reimplemented in CanvasApiTool.

Member Data Documentation

$tool

ceLTIc LTI Tool null $tool = null

protected

Tool object.

$tool

Referenced by CanvasApiToolProvider\__construct().

---

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

• ApiTool.php