 |
LTI Integration Library 5.0.0-rc2
PHP class library for building LTI integrations
|
|
|
LTI Integration Library 5.0.0-rc2
PHP class library for building LTI integrations
|
|
Class to represent an LTI Data Connector for PDO variations for PostgreSQL connections. More...
Public Member Functions | |
| UserResult[] | getUserResultSourcedIDsResourceLink ($resourceLink, $localOnly, $idScope) |
| Get array of user objects. | |
| bool | saveResourceLinkShareKey ($shareKey) |
| Save resource link share key object. | |
 Public Member Functions inherited from DataConnector_pdo | |
| 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. | |
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 Member Functions inherited from DataConnector_pdo | |
| 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. | |
| 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') | |
Class to represent an LTI Data Connector for PDO variations for PostgreSQL connections.
| 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.
| 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 |
Reimplemented from DataConnector_pdo.
References DataConnector_pdo\executeQuery(), and UserResult\getRecordId().
| bool saveResourceLinkShareKey | ( | $shareKey | ) |
Save resource link share key object.
| ResourceLinkShareKey | $shareKey | Resource link share key object |
Reimplemented from DataConnector_pdo.
References DataConnector_pdo\executeQuery().