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

Trait to handle API hook registrations. More...

Inheritance diagram for ApiHook:
Context ResourceLink ToolProvider

Static Public Member Functions

static registerApiHook ($hookName, $familyCode, $className)
 Register the availability of an API hook. More...
 

Static Public Attributes

static $USER_ID_HOOK = "UserId"
 User Id hook name. More...
 
static $CONTEXT_ID_HOOK = "ContextId"
 Context Id hook name. More...
 
static $MEMBERSHIPS_SERVICE_HOOK = "Memberships"
 Memberships service hook name. More...
 
static $OUTCOMES_SERVICE_HOOK = "Outcomes"
 Outcomes service hook name. More...
 
static $TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings"
 Tool Settings service hook name. More...
 

Detailed Description

Trait to handle API hook registrations.

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 ApiHook.php.

Member Function Documentation

◆ registerApiHook()

static registerApiHook (   $hookName,
  $familyCode,
  $className 
)
static

Register the availability of an API hook.

Parameters
string$hookNameName of hook
string$familyCodeFamily code for current platform
string$classNameName of implementing class

Definition at line 53 of file ApiHook.php.

Field Documentation

◆ $CONTEXT_ID_HOOK

$CONTEXT_ID_HOOK = "ContextId"
static

Context Id hook name.

Definition at line 24 of file ApiHook.php.

◆ $MEMBERSHIPS_SERVICE_HOOK

$MEMBERSHIPS_SERVICE_HOOK = "Memberships"
static

Memberships service hook name.

Definition at line 29 of file ApiHook.php.

◆ $OUTCOMES_SERVICE_HOOK

$OUTCOMES_SERVICE_HOOK = "Outcomes"
static

Outcomes service hook name.

Definition at line 34 of file ApiHook.php.

◆ $TOOL_SETTINGS_SERVICE_HOOK

$TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings"
static

Tool Settings service hook name.

Definition at line 39 of file ApiHook.php.

◆ $USER_ID_HOOK

$USER_ID_HOOK = "UserId"
static

User Id hook name.

Definition at line 19 of file ApiHook.php.

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