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.

	getUserId ()
	Get the User ID.

	getContextId ()
	Get the Context ID.

Protected Attributes
	$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

Definition at line 14 of file ApiTool.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $tool )

Class constructor.

Parameters

Tool | null $tool

Reimplemented in CanvasApiToolProvider, and ApiToolProvider.

Definition at line 29 of file ApiTool.php.

References ApiTool\$tool.

Member Function Documentation

◆ getContextId()

getContextId ( )

Get the Context ID.

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

Definition at line 59 of file ApiTool.php.

◆ getUserId()

getUserId ( )

Get the User ID.

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

Reimplemented in CanvasApiTool.

Definition at line 49 of file ApiTool.php.

◆ isConfigured()

isConfigured ( )

Check if the API hook has been configured.

Returns: bool True if the API hook has been configured

Definition at line 39 of file ApiTool.php.

Field Documentation

◆ $tool

Tool null $tool = null

protected

Tool object.

Definition at line 22 of file ApiTool.php.

Referenced by ApiTool\__construct(), and CanvasApiToolProvider\__construct().

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

ApiTool.php

Public Member Functions

Protected Attributes