DataConnector_pdo Class Reference

Class to represent an LTI Data Connector for PDO connections. More...

Inheritance diagram for DataConnector_pdo:

Public Member Functions
bool	loadPlatform ($platform)
	Load platform object.
bool	savePlatform ($platform)
	Save platform object.
bool	deletePlatform ($platform)
	Delete platform object.
Platform[]	getPlatforms ()
	Load platform objects.
bool	loadContext ($context)
	Load context object.
bool	saveContext ($context)
	Save context object.
bool	deleteContext ($context)
	Delete context object.
bool	loadResourceLink ($resourceLink)
	Load resource link object.
bool	saveResourceLink ($resourceLink)
	Save resource link object.
bool	deleteResourceLink ($resourceLink)
	Delete resource link object.
UserResult[]	getUserResultSourcedIDsResourceLink ($resourceLink, $localOnly, $idScope)
	Get array of user objects.
ResourceLinkShare[]	getSharesResourceLink ($resourceLink)
	Get array of shares defined for this resource link.
bool	loadPlatformNonce ($nonce)
	Load nonce object.
bool	savePlatformNonce ($nonce)
	Save nonce object.
bool	deletePlatformNonce ($nonce)
	Delete nonce object.
bool	loadAccessToken ($accessToken)
	Load access token object.
bool	saveAccessToken ($accessToken)
	Save access token object.
bool	loadResourceLinkShareKey ($shareKey)
	Load resource link share key object.
bool	saveResourceLinkShareKey ($shareKey)
	Save resource link share key object.
bool	deleteResourceLinkShareKey ($shareKey)
	Delete resource link share key object.
bool	loadUserResult ($userresult)
	Load user object.
bool	saveUserResult ($userresult)
	Save user object.
bool	deleteUserResult ($userresult)
	Delete user object.
bool	loadTool ($tool)
	Load tool object.
bool	saveTool ($tool)
	Save tool object.
bool	deleteTool ($tool)
	Delete tool object.
Tool[]	getTools ()
	Load tool objects.
Public Member Functions inherited from DataConnector
bool	loadToolConsumer ($consumer)
	Load tool consumer object.
bool	saveToolConsumer ($consumer)
	Save tool consumer object.
bool	deleteToolConsumer ($consumer)
	Delete tool consumer object.
ToolConsumer[]	getToolConsumers ()
	Load tool consumer objects.
bool	loadPlatform ($platform)
	Load platform object.
bool	savePlatform ($platform)
	Save platform object.
bool	deletePlatform ($platform)
	Delete platform object.
Platform[]	getPlatforms ()
	Load platform objects.
bool	loadContext ($context)
	Load context object.
bool	saveContext ($context)
	Save context object.
bool	deleteContext ($context)
	Delete context object.
bool	loadResourceLink ($resourceLink)
	Load resource link object.
bool	saveResourceLink ($resourceLink)
	Save resource link object.
bool	deleteResourceLink ($resourceLink)
	Delete resource link object.
UserResult[]	getUserResultSourcedIDsResourceLink ($resourceLink, $localOnly, $idScope)
	Get array of user objects.
ResourceLinkShare[]	getSharesResourceLink ($resourceLink)
	Get array of shares defined for this resource link.
bool	loadConsumerNonce ($nonce)
	Load nonce object.
bool	saveConsumerNonce ($nonce)
	Save nonce object.
bool	deleteConsumerNonce ($nonce)
	Delete nonce object.
bool	loadPlatformNonce ($nonce)
	Load nonce object.
bool	savePlatformNonce ($nonce)
	Save nonce object.
bool	deletePlatformNonce ($nonce)
	Delete nonce object.
bool	loadAccessToken ($accessToken)
	Load access token object.
bool	saveAccessToken ($accessToken)
	Save access token object.
bool	loadResourceLinkShareKey ($shareKey)
	Load resource link share key object.
bool	saveResourceLinkShareKey ($shareKey)
	Save resource link share key object.
bool	deleteResourceLinkShareKey ($shareKey)
	Delete resource link share key object.
bool	loadUserResult ($userresult)
	Load user object.
bool	saveUserResult ($userresult)
	Save user object.
bool	deleteUserResult ($userresult)
	Delete user object.
bool	loadTool ($tool)
	Load tool object.
bool	saveTool ($tool)
	Save tool object.
bool	deleteTool ($tool)
	Delete tool object.
Tool[]	getTools ()
	Load platform objects.
string	escape ($value, $addQuotes=true)
	Escape a string for use in a database query.

Protected Member Functions
int	getLastInsertId ($tableName)
	Get the ID for the last record inserted into a table.
bool	executeQuery ($sql, $query, $reportError=true)
	Execute a database query.
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.

Additional Inherited Members
Static Public Member Functions inherited from DataConnector
static bool	useMemcache ($host=null, $port=-1)
	Set/check whether memcached should be used when available.
static DataConnector	getDataConnector ($db=null, $dbTableNamePrefix='', $type='')
	Create data connector object.
static string	getRandomString ($length=8)
	Generate a random string.
static string	quoted ($value, $addQuotes=true)
	Quote a string for use in a database query.
Public Attributes 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 Attributes inherited from DataConnector
object resource	$db = null
	Database connection.
string	$dbTableNamePrefix = ''
	Prefix for database table names.
string	$dateFormat = 'Y-m-d'
	SQL date format (default = 'Y-m-d')
string	$timeFormat = 'H:i:s'
	SQL time format (default = 'H:i:s')

Detailed Description

Class to represent an LTI Data Connector for PDO connections.

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

Member Function Documentation

deleteContext()

bool deleteContext

(

$context

)

Delete context object.

Parameters

Context

$context

Context object

Returns

bool True if the Context object was successfully deleted

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

deletePlatform()

bool deletePlatform

(

$platform

)

Delete platform object.

Parameters

Platform

$platform

Platform object

Returns

bool True if the platform object was successfully deleted

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

deletePlatformNonce()

bool deletePlatformNonce

(

$nonce

)

Delete nonce object.

Parameters

PlatformNonce

$nonce

Nonce object

Returns

bool True if the nonce object was successfully deleted

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

deleteResourceLink()

bool 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.

References DataConnector_pdo\executeQuery().

deleteResourceLinkShareKey()

bool 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.

References DataConnector_pdo\executeQuery().

deleteTool()

bool deleteTool

(

$tool

)

Delete tool object.

Parameters

Tool

$tool

Tool object

Returns

bool True if the tool object was successfully deleted

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

deleteUserResult()

bool deleteUserResult

(

$userresult

)

Delete user object.

Parameters

UserResult

$userresult

UserResult object

Returns

bool True if the user object was successfully deleted

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

executeQuery()

bool executeQuery (   $sql,   $query,   $reportError = true  )

protected

Execute a database query.

Info and debug messages are generated.

Parameters

string	$sql	SQL statement
resource	$query	SQL query
bool	$reportError	True if errors are to be reported (default is true)

Returns

bool True if the query was successful.

References Util\$logLevel, Util\logDebug(), Util\logError(), Util\LOGLEVEL_DEBUG, and Util\LOGLEVEL_ERROR.

Referenced by DataConnector_pdo\deleteContext(), DataConnector_pdo\deletePlatform(), DataConnector_pdo\deletePlatformNonce(), DataConnector_pdo\deleteResourceLink(), DataConnector_pdo\deleteResourceLinkShareKey(), DataConnector_pdo\deleteTool(), DataConnector_pdo\deleteUserResult(), DataConnector_pdo\getPlatforms(), DataConnector_pdo\getSharesResourceLink(), DataConnector_pdo\getTools(), DataConnector_pdo\getUserResultSourcedIDsResourceLink(), DataConnector_pdo_pgsql\getUserResultSourcedIDsResourceLink(), DataConnector_pdo\loadAccessToken(), DataConnector_pdo\loadContext(), DataConnector_pdo\loadPlatform(), DataConnector_pdo\loadPlatformNonce(), DataConnector_pdo\loadResourceLink(), DataConnector_pdo\loadResourceLinkShareKey(), DataConnector_pdo\loadTool(), DataConnector_pdo\loadUserResult(), DataConnector_pdo\saveAccessToken(), DataConnector_pdo\saveContext(), DataConnector_pdo\savePlatform(), DataConnector_pdo\savePlatformNonce(), DataConnector_pdo\saveResourceLink(), DataConnector_pdo\saveResourceLinkShareKey(), DataConnector_pdo_pgsql\saveResourceLinkShareKey(), DataConnector_pdo\saveTool(), and DataConnector_pdo\saveUserResult().

getLastInsertId()

int getLastInsertId (   $tableName )

protected

Get the ID for the last record inserted into a table.

Parameters

string

$tableName

Name of database table

Returns

int Id of last inserted record

Reimplemented in DataConnector_pdo_oci.

Referenced by DataConnector_pdo\saveContext(), DataConnector_pdo\savePlatform(), DataConnector_pdo\saveResourceLink(), DataConnector_pdo\saveTool(), and DataConnector_pdo\saveUserResult().

getPlatforms()

Platform[] getPlatforms

(

)

Load platform objects.

Returns

Platform[] Array of all defined Platform objects

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), DataConnector\fixPlatformSettings(), and Platform\fromConsumerKey().

getSharesResourceLink()

ResourceLinkShare[] 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.

References DataConnector_pdo\executeQuery().

getTools()

Tool[] getTools

(

)

Load tool objects.

Returns

Tool[] Array of all defined Tool objects

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), and DataConnector\fixToolSettings().

getUserResultSourcedIDsResourceLink()

UserResult[] 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

Reimplemented from DataConnector.

Reimplemented in DataConnector_pdo_pgsql.

References DataConnector_pdo\executeQuery(), and UserResult\getRecordId().

loadAccessToken()

bool 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.

References DataConnector_pdo\executeQuery().

loadContext()

bool loadContext

(

$context

)

Load context object.

Parameters

Context

$context

Context object

Returns

bool True if the context object was successfully loaded

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

loadPlatform()

bool loadPlatform

(

$platform

)

Load platform object.

Parameters

Platform

$platform

Platform object

Returns

bool True if the platform object was successfully loaded

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), and DataConnector\fixPlatformSettings().

loadPlatformNonce()

bool loadPlatformNonce

(

$nonce

)

Load nonce object.

Parameters

PlatformNonce

$nonce

Nonce object

Returns

bool True if the nonce object was successfully loaded

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

loadResourceLink()

bool 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.

References DataConnector_pdo\executeQuery().

loadResourceLinkShareKey()

bool 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.

References DataConnector_pdo\executeQuery().

loadTool()

bool loadTool

(

$tool

)

Load tool object.

Parameters

Tool

$tool

Tool object

Returns

bool True if the tool object was successfully loaded

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), and DataConnector\fixToolSettings().

loadUserResult()

bool loadUserResult

(

$userresult

)

Load user object.

Parameters

UserResult

$userresult

UserResult object

Returns

bool True if the user object was successfully loaded

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), and Tool\ID_SCOPE_ID_ONLY.

saveAccessToken()

bool 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.

References DataConnector_pdo\executeQuery().

saveContext()

bool saveContext

(

$context

)

Save context object.

Parameters

Context

$context

Context object

Returns

bool True if the context object was successfully saved

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), and DataConnector_pdo\getLastInsertId().

savePlatform()

bool savePlatform

(

$platform

)

Save platform object.

Parameters

Platform

$platform

Platform object

Returns

bool True if the platform object was successfully saved

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), DataConnector\fixPlatformSettings(), and DataConnector_pdo\getLastInsertId().

savePlatformNonce()

bool savePlatformNonce

(

$nonce

)

Save nonce object.

Parameters

PlatformNonce

$nonce

Nonce object

Returns

bool True if the nonce object was successfully saved

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery().

saveResourceLink()

bool 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.

References DataConnector_pdo\executeQuery(), and DataConnector_pdo\getLastInsertId().

saveResourceLinkShareKey()

bool 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.

Reimplemented in DataConnector_pdo_pgsql.

References DataConnector_pdo\executeQuery().

saveTool()

bool saveTool

(

$tool

)

Save tool object.

Parameters

Tool

$tool

Tool object

Returns

bool True if the tool object was successfully saved

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), DataConnector\fixToolSettings(), and DataConnector_pdo\getLastInsertId().

saveUserResult()

bool saveUserResult

(

$userresult

)

Save user object.

Parameters

UserResult

$userresult

UserResult object

Returns

bool True if the user object was successfully saved

Reimplemented from DataConnector.

References DataConnector_pdo\executeQuery(), DataConnector_pdo\getLastInsertId(), and Tool\ID_SCOPE_ID_ONLY.

---

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

• DataConnector_pdo.php