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

Inheritance diagram for DataConnector_mysqli:

Public Member Functions
	loadToolConsumer ($consumer)
	Load tool consumer object. More...

	saveToolConsumer ($consumer)
	Save tool consumer object. More...

	deleteToolConsumer ($consumer)
	Delete tool consumer object. More...

	getToolConsumers ()
	Load all tool consumers from the database. More...

	loadContext ($context)
	Load context object. More...

	saveContext ($context)
	Save context object. More...

	deleteContext ($context)
	Delete context object. More...

	loadResourceLink ($resourceLink)
	Load resource link object. More...

	saveResourceLink ($resourceLink)
	Save resource link object. More...

	deleteResourceLink ($resourceLink)
	Delete resource link object. More...

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

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

	loadConsumerNonce ($nonce)
	Load nonce object. More...

	saveConsumerNonce ($nonce)
	Save nonce object. More...

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

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

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

	loadUserResult ($userresult)
	Load user object. More...

	saveUserResult ($userresult)
	Save user object. More...

	deleteUserResult ($userresult)
	Delete user object. More...

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

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

	loadToolConsumer ($consumer)
	Load tool consumer object. More...

	saveToolConsumer ($consumer)
	Save tool consumer object. More...

	deleteToolConsumer ($consumer)
	Delete tool consumer object. More...

	getToolConsumers ()
	Load tool consumer objects. More...

	loadContext ($context)
	Load context object. More...

	saveContext ($context)
	Save context object. More...

	deleteContext ($context)
	Delete context object. More...

	loadResourceLink ($resourceLink)
	Load resource link object. More...

	saveResourceLink ($resourceLink)
	Save resource link object. More...

	deleteResourceLink ($resourceLink)
	Delete resource link object. More...

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

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

	loadConsumerNonce ($nonce)
	Load nonce object. More...

	saveConsumerNonce ($nonce)
	Save nonce object. More...

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

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

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

	loadUserResult ($userresult)
	Load user object. More...

	saveUserResult ($userresult)
	Save user object. More...

	deleteUserResult ($userresult)
	Delete user object. More...

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

Additional Inherited Members
Static Public Member Functions inherited from DataConnector
static	getDataConnector ($db=null, $dbTableNamePrefix='', $type='')
	Create data connector object. More...

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

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

Data Fields inherited from DataConnector
const	CONSUMER_TABLE_NAME = 'lti2_consumer'
	Default name for database table used to store tool consumers. More...

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

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

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

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

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

Static Protected Member Functions inherited from DataConnector
static	getConsumerKey ($key)
	Return a hash of a consumer key for values longer than 255 characters. More...

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

	$dbTableNamePrefix = ''
	Prefix for database table names. More...

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

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

Detailed Description

Class to represent an LTI Data Connector for MySQLi.

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 27 of file DataConnector_mysqli.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

Definition at line 429 of file DataConnector_mysqli.php.

◆ deleteResourceLink()

deleteResourceLink ( $resourceLink )

Delete resource link object.

Parameters

ResourceLink $resourceLink ResourceLink object

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

Definition at line 616 of file DataConnector_mysqli.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

Definition at line 853 of file DataConnector_mysqli.php.

◆ deleteToolConsumer()

deleteToolConsumer ( $consumer )

Delete tool consumer object.

Parameters

ToolConsumer $consumer Consumer object

Returns: bool True if the tool consumer object was successfully deleted

Definition at line 186 of file DataConnector_mysqli.php.

◆ deleteUserResult()

deleteUserResult ( $userresult )

Delete user object.

Parameters

UserResult $userresult UserResult object

Returns: bool True if the user object was successfully deleted

Definition at line 949 of file DataConnector_mysqli.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.

Definition at line 973 of file DataConnector_mysqli.php.

Referenced by DataConnector_mysqli\loadConsumerNonce(), DataConnector_mysqli\loadContext(), DataConnector_mysqli\loadResourceLink(), DataConnector_mysqli\loadToolConsumer(), DataConnector_mysqli\loadUserResult(), DataConnector_mysqli\saveConsumerNonce(), DataConnector_mysqli\saveContext(), DataConnector_mysqli\saveResourceLink(), DataConnector_mysqli\saveResourceLinkShareKey(), DataConnector_mysqli\saveToolConsumer(), and DataConnector_mysqli\saveUserResult().

◆ getSharesResourceLink()

getSharesResourceLink ( $resourceLink )

Get array of shares defined for this resource link.

Parameters

ResourceLink $resourceLink ResourceLink object

Returns: ResourceLinkShare[] Array of ResourceLinkShare objects

Definition at line 705 of file DataConnector_mysqli.php.

◆ getToolConsumers()

getToolConsumers ( )

Load all tool consumers from the database.

Returns: ToolConsumer[] An array of the ToolConsumer objects

Definition at line 275 of file DataConnector_mysqli.php.

◆ 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	$idScope	Scope value to use for user IDs

Returns: UserResult[] Array of UserResult objects

Definition at line 664 of file DataConnector_mysqli.php.

References UserResult\fromResourceLink().

◆ loadConsumerNonce()

loadConsumerNonce ( $nonce )

Load nonce object.

Parameters

ConsumerNonce $nonce Nonce object

Returns: bool True if the nonce object was successfully loaded

Definition at line 746 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ loadContext()

loadContext ( $context )

Load context object.

Parameters

Context $context Context object

Returns: bool True if the context object was successfully loaded

Definition at line 343 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ loadResourceLink()

loadResourceLink ( $resourceLink )

Load resource link object.

Parameters

ResourceLink $resourceLink ResourceLink object

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

Definition at line 481 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ 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

Definition at line 796 of file DataConnector_mysqli.php.

◆ loadToolConsumer()

loadToolConsumer ( $consumer )

Load tool consumer object.

Parameters

ToolConsumer $consumer ToolConsumer object

Returns: bool True if the tool consumer object was successfully loaded

Definition at line 40 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ loadUserResult()

loadUserResult ( $userresult )

Load user object.

Parameters

UserResult $userresult UserResult object

Returns: bool True if the user object was successfully loaded

Definition at line 877 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape(), and ToolProvider\ID_SCOPE_ID_ONLY.

◆ saveConsumerNonce()

saveConsumerNonce ( $nonce )

Save nonce object.

Parameters

ConsumerNonce $nonce Nonce object

Returns: bool True if the nonce object was successfully saved

Definition at line 775 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ saveContext()

saveContext ( $context )

Save context object.

Parameters

Context $context Context object

Returns: bool True if the context object was successfully saved

Definition at line 389 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ saveResourceLink()

saveResourceLink ( $resourceLink )

Save resource link object.

Parameters

ResourceLink $resourceLink ResourceLink object

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

Definition at line 548 of file DataConnector_mysqli.php.

References DataConnector_mysqli\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

Definition at line 830 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ saveToolConsumer()

saveToolConsumer ( $consumer )

Save tool consumer object.

Parameters

ToolConsumer $consumer Consumer object

Returns: bool True if the tool consumer object was successfully saved

Definition at line 115 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape().

◆ saveUserResult()

saveUserResult ( $userresult )

Save user object.

Parameters

UserResult $userresult UserResult object

Returns: bool True if the user object was successfully saved

Definition at line 914 of file DataConnector_mysqli.php.

References DataConnector_mysqli\escape(), and ToolProvider\ID_SCOPE_ID_ONLY.

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

DataConnector_mysqli.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ deleteContext()

◆ deleteResourceLink()

◆ deleteResourceLinkShareKey()

◆ deleteToolConsumer()

◆ deleteUserResult()

◆ escape()

◆ getSharesResourceLink()

◆ getToolConsumers()

◆ getUserResultSourcedIDsResourceLink()

◆ loadConsumerNonce()

◆ loadContext()

◆ loadResourceLink()

◆ loadResourceLinkShareKey()

◆ loadToolConsumer()

◆ loadUserResult()

◆ saveConsumerNonce()

◆ saveContext()

◆ saveResourceLink()

◆ saveResourceLinkShareKey()

◆ saveToolConsumer()

◆ saveUserResult()