DataConnector.php

Go to the documentation of this file.

<?php

namespace IMSGlobal\LTI\ToolProvider\DataConnector;

use IMSGlobal\LTI\ToolProvider\ConsumerNonce;
use IMSGlobal\LTI\ToolProvider\Context;
use IMSGlobal\LTI\ToolProvider\ResourceLink;
use IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey;
use IMSGlobal\LTI\ToolProvider\ToolConsumer;
use IMSGlobal\LTI\ToolProvider\ToolProxy;
use IMSGlobal\LTI\ToolProvider\User;
use PDO;

class DataConnector
{

    const CONSUMER_TABLE_NAME = 'lti2_consumer';
    const TOOL_PROXY_TABLE_NAME = 'lti2_tool_proxy';
    const CONTEXT_TABLE_NAME = 'lti2_context';
    const RESOURCE_LINK_TABLE_NAME = 'lti2_resource_link';
    const USER_RESULT_TABLE_NAME = 'lti2_user_result';
    const RESOURCE_LINK_SHARE_KEY_TABLE_NAME = 'lti2_share_key';
    const NONCE_TABLE_NAME = 'lti2_nonce';

    protected $db = null;
    protected $dbTableNamePrefix = '';
    protected $dateFormat = 'Y-m-d';
    protected $timeFormat = 'H:i:s';

    public function __construct($db, $dbTableNamePrefix = '')
    {

        $this->db = $db;
        $this->dbTableNamePrefix = $dbTableNamePrefix;

    }

###
###  ToolConsumer methods
###

    public function loadToolConsumer($consumer)
    {

        $consumer->secret = 'secret';
        $consumer->enabled = true;
        $now = time();
        $consumer->created = $now;
        $consumer->updated = $now;

        return true;

    }

    public function saveToolConsumer($consumer)
    {

        $consumer->updated = time();

        return true;

    }

    public function deleteToolConsumer($consumer)
    {

        $consumer->initialize();

        return true;

    }

    public function getToolConsumers()
    {

        return array();

    }


###
###  ToolProxy methods
###

    public function loadToolProxy($toolProxy)
    {

        $now = time();
        $toolProxy->created = $now;
        $toolProxy->updated = $now;

        return true;

    }

    public function saveToolProxy($toolProxy)
    {

        $toolProxy->updated = time();

        return true;

    }

    public function deleteToolProxy($toolProxy)
    {

        $toolProxy->initialize();

        return true;

    }

###
###  Context methods
###

    public function loadContext($context)
    {

        $now = time();
        $context->created = $now;
        $context->updated = $now;

        return true;

    }

    public function saveContext($context)
    {

        $context->updated = time();

        return true;

    }

    public function deleteContext($context)
    {

        $context->initialize();

        return true;

    }

###
###  ResourceLink methods
###

    public function loadResourceLink($resourceLink)
    {

        $now = time();
        $resourceLink->created = $now;
        $resourceLink->updated = $now;

        return true;

    }

    public function saveResourceLink($resourceLink)
    {

        $resourceLink->updated = time();

        return true;

    }

    public function deleteResourceLink($resourceLink)
    {

        $resourceLink->initialize();

        return true;

    }

    public function getUserResultSourcedIDsResourceLink($resourceLink, $localOnly, $idScope)
    {

        return array();

    }

    public function getSharesResourceLink($resourceLink)
    {

        return array();

    }

###
###  ConsumerNonce methods
###

    public function loadConsumerNonce($nonce)
    {
        return false;  // assume the nonce does not already exist

    }

    public function saveConsumerNonce($nonce)
    {

        return true;

    }

###
###  ResourceLinkShareKey methods
###

    public function loadResourceLinkShareKey($shareKey)
    {

        return true;

    }

    public function saveResourceLinkShareKey($shareKey)
    {

        return true;

    }

    public function deleteResourceLinkShareKey($shareKey)
    {

        return true;

    }

###
###  User methods
###

    public function loadUser($user)
    {

        $now = time();
        $user->created = $now;
        $user->updated = $now;

        return true;

    }

    public function saveUser($user)
    {

        $user->updated = time();

        return true;

    }

    public function deleteUser($user)
    {

        $user->initialize();

        return true;

    }

###
###  Other methods
###

    protected static function getConsumerKey($key)
    {

        $len = strlen($key);
        if ($len > 255) {
            $key = 'sha512:' . hash('sha512', $key);
        }

        return $key;

    }

    public static function getDataConnector($dbTableNamePrefix = '', $db = null, $type = '')
    {

        if (is_null($dbTableNamePrefix)) {
            $dbTableNamePrefix = '';
        }
        if (!is_null($db) && empty($type)) {
            if (is_object($db)) {
                $type = get_class($db);
            }
        }
        $type = strtolower($type);
        if (($type === 'pdo') && ($db->getAttribute(PDO::ATTR_DRIVER_NAME) === 'sqlite')) {
            $type .= '_sqlite';
        }
        if (!empty($type)) {
            $type ="DataConnector_{$type}";
        } else {
            $type ='DataConnector';
        }
        $type = "\\IMSGlobal\\LTI\\ToolProvider\\DataConnector\\{$type}";
        $dataConnector = new $type($db, $dbTableNamePrefix);

        return $dataConnector;

    }

    static function getRandomString($length = 8)
    {

        $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';

        $value = '';
        $charsLength = strlen($chars) - 1;

        for ($i = 1 ; $i <= $length; $i++) {
            $value .= $chars[rand(0, $charsLength)];
        }

        return $value;

    }

    static function quoted($value, $addQuotes = true)
    {

        if (is_null($value)) {
            $value = 'null';
        } else {
            $value = str_replace('\'', '\'\'', $value);
            if ($addQuotes) {
                $value = "'{$value}'";
            }
        }

        return $value;

    }

}