LTI Integration Library  3.1.0
PHP class library for building LTI integrations
Public Member Functions | Protected Attributes
ApiToolProvider Class Reference

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

Inheritance diagram for ApiToolProvider:
CanvasApiToolProvider

Public Member Functions

 __construct ($toolProvider)
 Class constructor. More...
 
 getUserId ()
 Get the User ID. More...
 
 getContextId ()
 Get the Context ID. More...
 

Protected Attributes

 $toolProvider = null
 Tool Provider object. More...
 

Detailed Description

Class to implement tool consumer 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
Version
3.1.0
Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 13 of file ApiToolProvider.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $toolProvider)

Class constructor.

Parameters
\ceLtic\LTI\ToolProvider | null$toolProvider

Definition at line 28 of file ApiToolProvider.php.

References ApiToolProvider\$toolProvider.

Member Function Documentation

◆ getContextId()

getContextId ( )

Get the Context ID.

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

Definition at line 48 of file ApiToolProvider.php.

◆ getUserId()

getUserId ( )

Get the User ID.

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

Definition at line 38 of file ApiToolProvider.php.

Field Documentation

◆ $toolProvider

ceLtic LTI ToolProvider null $toolProvider = null
protected

Tool Provider object.

Definition at line 21 of file ApiToolProvider.php.

Referenced by ApiToolProvider\__construct().

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