Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/ltiprovider/src/ToolProvider/DataConnector/ -> DataConnector_mysql.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 1056 lines (45 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

assumes:: (0 methods):

DataConnector_mysql:: (23 methods):
  loadToolConsumer()
  saveToolConsumer()
  deleteToolConsumer()
  getToolConsumers()
  loadToolProxy()
  saveToolProxy()
  deleteToolProxy()
  loadContext()
  saveContext()
  deleteContext()
  loadResourceLink()
  saveResourceLink()
  deleteResourceLink()
  getUserResultSourcedIDsResourceLink()
  getSharesResourceLink()
  loadConsumerNonce()
  saveConsumerNonce()
  loadResourceLinkShareKey()
  saveResourceLinkShareKey()
  deleteResourceLinkShareKey()
  loadUser()
  saveUser()
  deleteUser()


Class: assumes  - X-Ref

Class to represent an LTI Data Connector for MySQL

Class: DataConnector_mysql  - X-Ref

loadToolConsumer($consumer)   X-Ref
Load tool consumer object.

param: ToolConsumer $consumer ToolConsumer object
return: boolean True if the tool consumer object was successfully loaded

saveToolConsumer($consumer)   X-Ref
Save tool consumer object.

param: ToolConsumer $consumer Consumer object
return: boolean True if the tool consumer object was successfully saved

deleteToolConsumer($consumer)   X-Ref
Delete tool consumer object.

param: ToolConsumer $consumer Consumer object
return: boolean True if the tool consumer object was successfully deleted

getToolConsumers()   X-Ref
No description

loadToolProxy($toolProxy)   X-Ref
No description

saveToolProxy($toolProxy)   X-Ref
No description

deleteToolProxy($toolProxy)   X-Ref
No description

loadContext($context)   X-Ref
Load context object.

param: Context $context Context object
return: boolean True if the context object was successfully loaded

saveContext($context)   X-Ref
Save context object.

param: Context $context Context object
return: boolean True if the context object was successfully saved

deleteContext($context)   X-Ref
Delete context object.

param: Context $context Context object
return: boolean True if the Context object was successfully deleted

loadResourceLink($resourceLink)   X-Ref
Load resource link object.

param: ResourceLink $resourceLink Resource_Link object
return: boolean True if the resource link object was successfully loaded

saveResourceLink($resourceLink)   X-Ref
Save resource link object.

param: ResourceLink $resourceLink Resource_Link object
return: boolean True if the resource link object was successfully saved

deleteResourceLink($resourceLink)   X-Ref
Delete resource link object.

param: ResourceLink $resourceLink Resource_Link object
return: boolean True if the resource link object was successfully deleted

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

Obtain an array of User 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.

param: ResourceLink $resourceLink      Resource link object
param: boolean     $localOnly True if only users within the resource link are to be returned (excluding users sharing this resource link)
param: int         $idScope     Scope value to use for user IDs
return: array Array of User objects

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

param: ResourceLink $resourceLink Resource_Link object
return: array Array of ResourceLinkShare objects

loadConsumerNonce($nonce)   X-Ref
Load nonce object.

param: ConsumerNonce $nonce Nonce object
return: boolean True if the nonce object was successfully loaded

saveConsumerNonce($nonce)   X-Ref
Save nonce object.

param: ConsumerNonce $nonce Nonce object
return: boolean True if the nonce object was successfully saved

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

param: ResourceLinkShareKey $shareKey Resource_Link share key object
return: boolean True if the resource link share key object was successfully loaded

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

param: ResourceLinkShareKey $shareKey Resource link share key object
return: boolean True if the resource link share key object was successfully saved

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

param: ResourceLinkShareKey $shareKey Resource link share key object
return: boolean True if the resource link share key object was successfully deleted

loadUser($user)   X-Ref
Load user object.

param: User $user User object
return: boolean True if the user object was successfully loaded

saveUser($user)   X-Ref
Save user object.

param: User $user User object
return: boolean True if the user object was successfully saved

deleteUser($user)   X-Ref
Delete user object.

param: User $user User object
return: boolean True if the user object was successfully deleted