ApiHook Class Reference

Trait to handle API hook registrations. More...

Inheritance diagram for ApiHook:

Static Public Member Functions
static	registerApiHook ($hookName, $familyCode, $className)
	Register the availability of an API hook.

Static Public Attributes
static	$USER_ID_HOOK = "UserId"
	User Id hook name.
static	$CONTEXT_ID_HOOK = "ContextId"
	Context Id hook name.
static	$GROUPS_SERVICE_HOOK = "Groups"
	Course Groups service hook name.
static	$MEMBERSHIPS_SERVICE_HOOK = "Memberships"
	Memberships service hook name.
static	$OUTCOMES_SERVICE_HOOK = "Outcomes"
	Outcomes service hook name.
static	$TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings"
	Tool Settings service hook name.
static	$ACCESS_TOKEN_SERVICE_HOOK = "AccessToken"
	Access Token service hook name.

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

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

Definition at line 12 of file ApiHook.php.

Member Function Documentation

registerApiHook()

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

static

Register the availability of an API hook.

Parameters

string	$hookName	Name of hook
string	$familyCode	Family code for current platform
string	$className	Name of implementing class

Definition at line 62 of file ApiHook.php.

Field Documentation

$ACCESS_TOKEN_SERVICE_HOOK

$ACCESS_TOKEN_SERVICE_HOOK = "AccessToken"

static

Access Token service hook name.

Definition at line 48 of file ApiHook.php.

$CONTEXT_ID_HOOK

$CONTEXT_ID_HOOK = "ContextId"

static

Context Id hook name.

Definition at line 23 of file ApiHook.php.

$GROUPS_SERVICE_HOOK

$GROUPS_SERVICE_HOOK = "Groups"

static

Course Groups service hook name.

Definition at line 28 of file ApiHook.php.

$MEMBERSHIPS_SERVICE_HOOK

$MEMBERSHIPS_SERVICE_HOOK = "Memberships"

static

Memberships service hook name.

Definition at line 33 of file ApiHook.php.

$OUTCOMES_SERVICE_HOOK

$OUTCOMES_SERVICE_HOOK = "Outcomes"

static

Outcomes service hook name.

Definition at line 38 of file ApiHook.php.

$TOOL_SETTINGS_SERVICE_HOOK

$TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings"

static

Tool Settings service hook name.

Definition at line 43 of file ApiHook.php.

$USER_ID_HOOK

$USER_ID_HOOK = "UserId"

static

User Id hook name.

Definition at line 18 of file ApiHook.php.

---

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

• ApiHook.php