ceLTIc\LTI\ApiHook\ApiTool Class Reference

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

Inheritance diagram for ceLTIc\LTI\ApiHook\ApiTool:

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

Protected Attributes
Tool	$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()

ceLTIc\LTI\ApiHook\ApiTool::__construct

(

?Tool

$tool

)

Class constructor.

Parameters

Tool | null

$tool

Member Function Documentation

getContextId()

string ceLTIc\LTI\ApiHook\ApiTool::getContextId

(

)

Get the Context ID.

Returns

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

getUserId()

string ceLTIc\LTI\ApiHook\ApiTool::getUserId

(

)

Get the User ID.

Returns

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

Reimplemented in ceLTIc\LTI\ApiHook\canvas\CanvasApiTool.

isConfigured()

bool ceLTIc\LTI\ApiHook\ApiTool::isConfigured

(

)

Check if the API hook has been configured.

Returns

bool True if the API hook has been configured

Member Data Documentation

$tool

Tool ceLTIc\LTI\ApiHook\ApiTool::$tool = null

protected

Tool object.