LTI Integration Library 4.10.3
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
DataConnector_pdo Class Reference

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

Inheritance diagram for DataConnector_pdo:
DataConnector DataConnector_pdo_oci DataConnector_pdo_pgsql

Public Member Functions

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

Protected Member Functions

 getLastInsertId ($tableName)
 Get the ID for the last record inserted into a table.
 
 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 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 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 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

Definition at line 24 of file DataConnector_pdo.php.

Member Function Documentation

◆ deleteContext()

deleteContext (   $context)

Delete context object.

Parameters
Context$contextContext object
Returns
bool True if the Context object was successfully deleted

Reimplemented from DataConnector.

Definition at line 561 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ deletePlatform()

deletePlatform (   $platform)

Delete platform object.

Parameters
Platform$platformPlatform object
Returns
bool True if the platform object was successfully deleted

Reimplemented from DataConnector.

Definition at line 269 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ deletePlatformNonce()

deletePlatformNonce (   $nonce)

Delete nonce object.

Parameters
PlatformNonce$nonceNonce object
Returns
bool True if the nonce object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1009 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ deleteResourceLink()

deleteResourceLink (   $resourceLink)

Delete resource link object.

Parameters
ResourceLink$resourceLinkResourceLink object
Returns
bool True if the resource link object was successfully deleted

Reimplemented from DataConnector.

Definition at line 791 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ deleteResourceLinkShareKey()

deleteResourceLinkShareKey (   $shareKey)

Delete resource link share key object.

Parameters
ResourceLinkShareKey$shareKeyResource link share key object
Returns
bool True if the resource link share key object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1191 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ deleteTool()

deleteTool (   $tool)

Delete tool object.

Parameters
Tool$toolTool object
Returns
bool True if the tool object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1509 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ deleteUserResult()

deleteUserResult (   $userresult)

Delete user object.

Parameters
UserResult$userresultUserResult object
Returns
bool True if the user object was successfully deleted

Reimplemented from DataConnector.

Definition at line 1303 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ executeQuery()

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

Execute a database query.

Info and debug messages are generated.

Parameters
string$sqlSQL statement
resource$querySQL query
bool$reportErrorTrue if errors are to be reported (default is true)
Returns
bool True if the query was successful.

Definition at line 1620 of file DataConnector_pdo.php.

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

Referenced by DataConnector_pdo_oci\__construct(), DataConnector_pdo\deleteContext(), DataConnector_pdo\deletePlatform(), DataConnector_pdo\deletePlatformNonce(), DataConnector_pdo\deleteResourceLink(), DataConnector_pdo\deleteResourceLinkShareKey(), DataConnector_pdo\deleteTool(), DataConnector_pdo\deleteUserResult(), DataConnector_pdo_oci\getLastInsertId(), 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()

getLastInsertId (   $tableName)
protected

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

Parameters
string$tableNameName of database table
Returns
int Id of last inserted record

Reimplemented in DataConnector_pdo_oci.

Definition at line 1604 of file DataConnector_pdo.php.

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

◆ getPlatforms()

getPlatforms ( )

Load platform objects.

Returns
Platform[] Array of all defined Platform objects

Reimplemented from DataConnector.

Definition at line 379 of file DataConnector_pdo.php.

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

◆ getSharesResourceLink()

getSharesResourceLink (   $resourceLink)

Get array of shares defined for this resource link.

Parameters
ResourceLink$resourceLinkResourceLink object
Returns
ResourceLinkShare[] Array of ResourceLinkShare objects

Reimplemented from DataConnector.

Definition at line 899 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ getTools()

getTools ( )

Load tool objects.

Returns
Tool[] Array of all defined Tool objects

Reimplemented from DataConnector.

Definition at line 1531 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery(), 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$resourceLinkResource link object
bool$localOnlyTrue if only users within the resource link are to be returned (excluding users sharing this resource link)
int | null$idScopeScope value to use for user IDs
Returns
UserResult[] Array of UserResult objects

Reimplemented from DataConnector.

Reimplemented in DataConnector_pdo_pgsql.

Definition at line 849 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ loadAccessToken()

loadAccessToken (   $accessToken)

Load access token object.

Parameters
AccessToken$accessTokenAccess token object
Returns
bool True if the nonce object was successfully loaded

Reimplemented from DataConnector.

Definition at line 1038 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery(), and Util\jsonDecode().

◆ loadContext()

loadContext (   $context)

Load context object.

Parameters
Context$contextContext object
Returns
bool True if the context object was successfully loaded

Reimplemented from DataConnector.

Definition at line 458 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery(), and Util\jsonDecode().

◆ loadPlatform()

loadPlatform (   $platform)

Load platform object.

Parameters
Platform$platformPlatform object
Returns
bool True if the platform object was successfully loaded

Reimplemented from DataConnector.

Definition at line 37 of file DataConnector_pdo.php.

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

◆ loadPlatformNonce()

loadPlatformNonce (   $nonce)

Load nonce object.

Parameters
PlatformNonce$nonceNonce object
Returns
bool True if the nonce object was successfully loaded

Reimplemented from DataConnector.

Definition at line 945 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ loadResourceLink()

loadResourceLink (   $resourceLink)

Load resource link object.

Parameters
ResourceLink$resourceLinkResourceLink object
Returns
bool True if the resource link object was successfully loaded

Reimplemented from DataConnector.

Definition at line 622 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery(), and Util\jsonDecode().

◆ loadResourceLinkShareKey()

loadResourceLinkShareKey (   $shareKey)

Load resource link share key object.

Parameters
ResourceLinkShareKey$shareKeyResourceLink share key object
Returns
bool True if the resource link share key object was successfully loaded

Reimplemented from DataConnector.

Definition at line 1127 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ loadTool()

loadTool (   $tool)

Load tool object.

Parameters
Tool$toolTool object
Returns
bool True if the tool object was successfully loaded

Reimplemented from DataConnector.

Definition at line 1329 of file DataConnector_pdo.php.

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

◆ loadUserResult()

loadUserResult (   $userresult)

Load user object.

Parameters
UserResult$userresultUserResult object
Returns
bool True if the user object was successfully loaded

Reimplemented from DataConnector.

Definition at line 1217 of file DataConnector_pdo.php.

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

◆ saveAccessToken()

saveAccessToken (   $accessToken)

Save access token object.

Parameters
AccessToken$accessTokenAccess token object
Returns
bool True if the access token object was successfully saved

Reimplemented from DataConnector.

Definition at line 1077 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ saveContext()

saveContext (   $context)

Save context object.

Parameters
Context$contextContext object
Returns
bool True if the context object was successfully saved

Reimplemented from DataConnector.

Definition at line 509 of file DataConnector_pdo.php.

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

◆ savePlatform()

savePlatform (   $platform)

Save platform object.

Parameters
Platform$platformPlatform object
Returns
bool True if the platform object was successfully saved

Reimplemented from DataConnector.

Definition at line 159 of file DataConnector_pdo.php.

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

◆ savePlatformNonce()

savePlatformNonce (   $nonce)

Save nonce object.

Parameters
PlatformNonce$nonceNonce object
Returns
bool True if the nonce object was successfully saved

Reimplemented from DataConnector.

Definition at line 983 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ saveResourceLink()

saveResourceLink (   $resourceLink)

Save resource link object.

Parameters
ResourceLink$resourceLinkResourceLink object
Returns
bool True if the resource link object was successfully saved

Reimplemented from DataConnector.

Definition at line 701 of file DataConnector_pdo.php.

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

◆ saveResourceLinkShareKey()

saveResourceLinkShareKey (   $shareKey)

Save resource link share key object.

Parameters
ResourceLinkShareKey$shareKeyResource 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.

Definition at line 1166 of file DataConnector_pdo.php.

References DataConnector_pdo\executeQuery().

◆ saveTool()

saveTool (   $tool)

Save tool object.

Parameters
Tool$toolTool object
Returns
bool True if the tool object was successfully saved

Reimplemented from DataConnector.

Definition at line 1416 of file DataConnector_pdo.php.

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

◆ saveUserResult()

saveUserResult (   $userresult)

Save user object.

Parameters
UserResult$userresultUserResult object
Returns
bool True if the user object was successfully saved

Reimplemented from DataConnector.

Definition at line 1261 of file DataConnector_pdo.php.

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

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