Class to represent an LTI Data Connector for PostgreSQL. More...

Inheritance diagram for DataConnector_pg:

Public Member Functions
	loadPlatform ($platform)
	Load platform object.

	savePlatform ($platform)
	Save platform object.

	deletePlatform ($platform)
	Delete platform object.

	getPlatforms ()
	Load all platforms from the database.

	loadContext ($context)
	Load context object.

	saveContext ($context)
	Save context object.

	deleteContext ($context)
	Delete context object.

	loadResourceLink ($resourceLink)
	Load resource link object.

	saveResourceLink ($resourceLink)
	Save resource link object.

	deleteResourceLink ($resourceLink)
	Delete resource link object.

	getUserResultSourcedIDsResourceLink ($resourceLink, $localOnly, $idScope)
	Get array of user objects.

	getSharesResourceLink ($resourceLink)
	Get array of shares defined for this resource link.

	loadPlatformNonce ($nonce)
	Load nonce object.

	savePlatformNonce ($nonce)
	Save nonce object.

	deletePlatformNonce ($nonce)
	Delete nonce object.

	loadAccessToken ($accessToken)
	Load access token object.

	saveAccessToken ($accessToken)
	Save access token object.

	loadResourceLinkShareKey ($shareKey)
	Load resource link share key object.

	saveResourceLinkShareKey ($shareKey)
	Save resource link share key object.

	deleteResourceLinkShareKey ($shareKey)
	Delete resource link share key object.

	loadUserResult ($userresult)
	Load user object.

	saveUserResult ($userresult)
	Save user object.

	deleteUserResult ($userresult)
	Delete user object.

	loadTool ($tool)
	Load tool object.

	saveTool ($tool)
	Save tool object.

	deleteTool ($tool)
	Delete tool object.

	getTools ()
	Load tool objects.

	escape ($value, $addQuotes=true)
	Escape a string for use in a database query.

Public Member Functions inherited from DataConnector
	loadToolConsumer ($consumer)
	Load tool consumer object.

	saveToolConsumer ($consumer)
	Save tool consumer object.

	deleteToolConsumer ($consumer)
	Delete tool consumer object.

	getToolConsumers ()
	Load tool consumer objects.

	loadPlatform ($platform)
	Load platform object.

	savePlatform ($platform)
	Save platform object.

	deletePlatform ($platform)
	Delete platform object.

	getPlatforms ()
	Load platform objects.

	loadContext ($context)
	Load context object.

	saveContext ($context)
	Save context object.

	deleteContext ($context)
	Delete context object.

	loadResourceLink ($resourceLink)
	Load resource link object.

	saveResourceLink ($resourceLink)
	Save resource link object.

	deleteResourceLink ($resourceLink)
	Delete resource link object.

	getUserResultSourcedIDsResourceLink ($resourceLink, $localOnly, $idScope)
	Get array of user objects.

	getSharesResourceLink ($resourceLink)
	Get array of shares defined for this resource link.

	loadConsumerNonce ($nonce)
	Load nonce object.

	saveConsumerNonce ($nonce)
	Save nonce object.

	deleteConsumerNonce ($nonce)
	Delete nonce object.

	loadPlatformNonce ($nonce)
	Load nonce object.

	savePlatformNonce ($nonce)
	Save nonce object.

	deletePlatformNonce ($nonce)
	Delete nonce object.

	loadAccessToken ($accessToken)
	Load access token object.

	saveAccessToken ($accessToken)
	Save access token object.

	loadResourceLinkShareKey ($shareKey)
	Load resource link share key object.

	saveResourceLinkShareKey ($shareKey)
	Save resource link share key object.

	deleteResourceLinkShareKey ($shareKey)
	Delete resource link share key object.

	loadUserResult ($userresult)
	Load user object.

	saveUserResult ($userresult)
	Save user object.

	deleteUserResult ($userresult)
	Delete user object.

	loadTool ($tool)
	Load tool object.

	saveTool ($tool)
	Save tool object.

	deleteTool ($tool)
	Delete tool object.

	getTools ()
	Load tool objects.

	escape ($value, $addQuotes=true)
	Escape a string for use in a database query.

Additional Inherited Members
Static Public Member Functions inherited from DataConnector
static	useMemcache ($host=null, $port=-1)
	Set/check whether memcached should be used when available.

static	getDataConnector ($db=null, $dbTableNamePrefix='', $type='')
	Create data connector object.

static	getRandomString ($length=8)
	Generate a random string.

static	quoted ($value, $addQuotes=true)
	Quote a string for use in a database query.

Data Fields inherited from DataConnector
const	PLATFORM_TABLE_NAME = 'lti2_consumer'
	Default name for database table used to store platforms.

const	CONSUMER_TABLE_NAME = self::PLATFORM_TABLE_NAME
	Default name for database table used to store platforms.

const	CONTEXT_TABLE_NAME = 'lti2_context'
	Default name for database table used to store contexts.

const	RESOURCE_LINK_TABLE_NAME = 'lti2_resource_link'
	Default name for database table used to store resource links.

const	USER_RESULT_TABLE_NAME = 'lti2_user_result'
	Default name for database table used to store users.

const	RESOURCE_LINK_SHARE_KEY_TABLE_NAME = 'lti2_share_key'
	Default name for database table used to store resource link share keys.

const	NONCE_TABLE_NAME = 'lti2_nonce'
	Default name for database table used to store nonce values.

const	ACCESS_TOKEN_TABLE_NAME = 'lti2_access_token'
	Default name for database table used to store access token values.

const	TOOL_TABLE_NAME = 'lti2_tool'
	Default name for database table used to store tools.

Protected Member Functions inherited from DataConnector
	__construct ($db, $dbTableNamePrefix='')
	Class constructor.

	fixPlatformSettings ($platform, $isSave)
	Adjust the settings for any platform properties being stored as a setting value.

	fixToolSettings ($tool, $isSave)
	Adjust the settings for any tool properties being stored as a setting value.

Protected Attributes inherited from DataConnector
	$db = null
	Database connection.

	$dbTableNamePrefix = ''
	Prefix for database table names.

	$dateFormat = 'Y-m-d'
	SQL date format (default = 'Y-m-d')

	$timeFormat = 'H:i:s'
	SQL time format (default = 'H:i:s')

Detailed Description

Class to represent an LTI Data Connector for PostgreSQL.

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 29 of file DataConnector_pg.php.

Member Function Documentation

◆ deleteContext()

deleteContext ( $context )

Delete context object.

Parameters

Context $context Context object

Returns: bool True if the Context object was successfully deleted

Reimplemented from DataConnector.

Definition at line 472 of file DataConnector_pg.php.

◆ deletePlatform()

deletePlatform ( $platform )

Delete platform object.

Parameters

Platform $platform Platform object

Returns: bool True if the platform object was successfully deleted

Reimplemented from DataConnector.

Definition at line 223 of file DataConnector_pg.php.

◆ deletePlatformNonce()

deletePlatformNonce ( $nonce )

Delete nonce object.

Parameters

PlatformNonce $nonce Nonce object

Returns: bool True if the nonce object was successfully deleted

Reimplemented from DataConnector.

Definition at line 843 of file DataConnector_pg.php.

◆ deleteResourceLink()

deleteResourceLink ( $resourceLink )

Delete resource link object.

Parameters

ResourceLink $resourceLink ResourceLink object

Returns: bool True if the resource link object was successfully deleted

Reimplemented from DataConnector.

Definition at line 659 of file DataConnector_pg.php.

◆ deleteResourceLinkShareKey()

deleteResourceLinkShareKey ( $shareKey )

Delete resource link share key object.

Parameters

ResourceLinkShareKey $shareKey Resource link share key object

Returns: bool True if the resource link share key object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1001 of file DataConnector_pg.php.

◆ deleteTool()

deleteTool ( $tool )

Delete tool object.

Parameters

Tool $tool Tool object

Returns: bool True if the tool object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1261 of file DataConnector_pg.php.

◆ deleteUserResult()

deleteUserResult ( $userresult )

Delete user object.

Parameters

UserResult $userresult UserResult object

Returns: bool True if the user object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1097 of file DataConnector_pg.php.

◆ escape()

escape	(	$value,
		$addQuotes = `true`
	)

Escape a string for use in a database query.

Any single quotes in the value passed will be replaced with two single quotes. If a null value is passed, a string of 'null' is returned (which will never be enclosed in quotes irrespective of the value of the $addQuotes parameter.

Parameters

string	$value	Value to be escaped
bool	$addQuotes	If true the returned string will be enclosed in single quotes (optional, default is true)

Returns: string The escaped string.

Reimplemented from DataConnector.

Definition at line 1362 of file DataConnector_pg.php.

Referenced by DataConnector_pg\loadPlatform(), DataConnector_pg\loadResourceLink(), DataConnector_pg\loadTool(), DataConnector_pg\saveAccessToken(), DataConnector_pg\saveContext(), DataConnector_pg\savePlatform(), DataConnector_pg\saveResourceLink(), DataConnector_pg\saveResourceLinkShareKey(), DataConnector_pg\saveTool(), and DataConnector_pg\saveUserResult().

◆ getPlatforms()

getPlatforms ( )

Load all platforms from the database.

Returns: Platform[] An array of the Platform objects

Reimplemented from DataConnector.

Definition at line 312 of file DataConnector_pg.php.

References DataConnector\fixPlatformSettings(), and Util\jsonDecode().

◆ getSharesResourceLink()

getSharesResourceLink ( $resourceLink )

Get array of shares defined for this resource link.

Parameters

ResourceLink $resourceLink ResourceLink object

Returns: ResourceLinkShare[] Array of ResourceLinkShare objects

Reimplemented from DataConnector.

Definition at line 748 of file DataConnector_pg.php.

◆ getTools()

getTools ( )

Load tool objects.

Returns: Tool[] Array of all defined Tool objects

Reimplemented from DataConnector.

Definition at line 1279 of file DataConnector_pg.php.

References DataConnector\fixToolSettings(), and Util\jsonDecode().

◆ getUserResultSourcedIDsResourceLink()

getUserResultSourcedIDsResourceLink	(	$resourceLink,
		$localOnly,
		$idScope
	)

Get array of user objects.

Obtain an array of UserResult objects for users with a result sourcedId. The array may include users from other resource links which are sharing this resource link. It may also be optionally indexed by the user ID of a specified scope.

Parameters

ResourceLink	$resourceLink	Resource link object
bool	$localOnly	True if only users within the resource link are to be returned (excluding users sharing this resource link)
int \| null	$idScope	Scope value to use for user IDs

Returns: UserResult[] Array of UserResult objects

Reimplemented from DataConnector.

Definition at line 707 of file DataConnector_pg.php.

◆ loadAccessToken()

loadAccessToken ( $accessToken )

Load access token object.

Parameters

AccessToken $accessToken Access token object

Returns: bool True if the nonce object was successfully loaded

Reimplemented from DataConnector.

Definition at line 867 of file DataConnector_pg.php.

References Util\jsonDecode().

◆ loadContext()

loadContext ( $context )

Load context object.

Parameters

Context $context Context object

Returns: bool True if the context object was successfully loaded

Reimplemented from DataConnector.

Definition at line 386 of file DataConnector_pg.php.

References Util\jsonDecode().

◆ loadPlatform()

loadPlatform ( $platform )

Load platform object.

Parameters

Platform $platform Platform object

Returns: bool True if the platform object was successfully loaded

Reimplemented from DataConnector.

Definition at line 42 of file DataConnector_pg.php.

References DataConnector_pg\escape(), DataConnector\fixPlatformSettings(), and Util\jsonDecode().

◆ loadPlatformNonce()

loadPlatformNonce ( $nonce )

Load nonce object.

Parameters

PlatformNonce $nonce Nonce object

Returns: bool True if the nonce object was successfully loaded

Reimplemented from DataConnector.

Definition at line 789 of file DataConnector_pg.php.

◆ loadResourceLink()

loadResourceLink ( $resourceLink )

Load resource link object.

Parameters

ResourceLink $resourceLink ResourceLink object

Returns: bool True if the resource link object was successfully loaded

Reimplemented from DataConnector.

Definition at line 521 of file DataConnector_pg.php.

References DataConnector_pg\escape(), and Util\jsonDecode().

◆ loadResourceLinkShareKey()

loadResourceLinkShareKey ( $shareKey )

Load resource link share key object.

Parameters

ResourceLinkShareKey $shareKey ResourceLink share key object

Returns: bool True if the resource link share key object was successfully loaded

Reimplemented from DataConnector.

Definition at line 943 of file DataConnector_pg.php.

◆ loadTool()

loadTool ( $tool )

Load tool object.

Parameters

Tool $tool Tool object

Returns: bool True if the tool object was successfully loaded

Reimplemented from DataConnector.

Definition at line 1121 of file DataConnector_pg.php.

References DataConnector_pg\escape(), DataConnector\fixToolSettings(), and Util\jsonDecode().

◆ loadUserResult()

loadUserResult ( $userresult )

Load user object.

Parameters

UserResult $userresult UserResult object

Returns: bool True if the user object was successfully loaded

Reimplemented from DataConnector.

Definition at line 1025 of file DataConnector_pg.php.

References Tool\ID_SCOPE_ID_ONLY.

◆ saveAccessToken()

saveAccessToken ( $accessToken )

Save access token object.

Parameters

AccessToken $accessToken Access token object

Returns: bool True if the access token object was successfully saved

Reimplemented from DataConnector.

Definition at line 905 of file DataConnector_pg.php.

References DataConnector_pg\escape().

◆ saveContext()

saveContext ( $context )

Save context object.

Parameters

Context $context Context object

Returns: bool True if the context object was successfully saved

Reimplemented from DataConnector.

Definition at line 432 of file DataConnector_pg.php.

References DataConnector_pg\escape().

◆ savePlatform()

savePlatform ( $platform )

Save platform object.

Parameters

Platform $platform Platform object

Returns: bool True if the platform object was successfully saved

Reimplemented from DataConnector.

Definition at line 151 of file DataConnector_pg.php.

References DataConnector_pg\escape(), and DataConnector\fixPlatformSettings().

◆ savePlatformNonce()

savePlatformNonce ( $nonce )

Save nonce object.

Parameters

PlatformNonce $nonce Nonce object

Returns: bool True if the nonce object was successfully saved

Reimplemented from DataConnector.

Definition at line 822 of file DataConnector_pg.php.

◆ saveResourceLink()

saveResourceLink ( $resourceLink )

Save resource link object.

Parameters

ResourceLink $resourceLink ResourceLink object

Returns: bool True if the resource link object was successfully saved

Reimplemented from DataConnector.

Definition at line 591 of file DataConnector_pg.php.

References DataConnector_pg\escape().

◆ saveResourceLinkShareKey()

saveResourceLinkShareKey ( $shareKey )

Save resource link share key object.

Parameters

ResourceLinkShareKey $shareKey Resource link share key object

Returns: bool True if the resource link share key object was successfully saved

Reimplemented from DataConnector.

Definition at line 978 of file DataConnector_pg.php.

References DataConnector_pg\escape().

◆ saveTool()

saveTool ( $tool )

Save tool object.

Parameters

Tool $tool Tool object

Returns: bool True if the tool object was successfully saved

Reimplemented from DataConnector.

Definition at line 1198 of file DataConnector_pg.php.

References DataConnector_pg\escape(), and DataConnector\fixToolSettings().

◆ saveUserResult()

saveUserResult ( $userresult )

Save user object.

Parameters

UserResult $userresult UserResult object

Returns: bool True if the user object was successfully saved

Reimplemented from DataConnector.

Definition at line 1062 of file DataConnector_pg.php.

References DataConnector_pg\escape(), and Tool\ID_SCOPE_ID_ONLY.

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

DataConnector_pg.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ deleteContext()

◆ deletePlatform()

◆ deletePlatformNonce()

◆ deleteResourceLink()

◆ deleteResourceLinkShareKey()

◆ deleteTool()

◆ deleteUserResult()

◆ escape()

◆ getPlatforms()

◆ getSharesResourceLink()

◆ getTools()

◆ getUserResultSourcedIDsResourceLink()

◆ loadAccessToken()

◆ loadContext()

◆ loadPlatform()

◆ loadPlatformNonce()

◆ loadResourceLink()

◆ loadResourceLinkShareKey()

◆ loadTool()

◆ loadUserResult()

◆ saveAccessToken()

◆ saveContext()

◆ savePlatform()

◆ savePlatformNonce()

◆ saveResourceLink()

◆ saveResourceLinkShareKey()

◆ saveTool()

◆ saveUserResult()