UserResult.php

<?php
 
namespace ceLTIc\LTI;
 
use ceLTIc\LTI\DataConnector\DataConnector;
use ceLTIc\LTI\Platform;
use ceLTIc\LTI\Context;
 
class UserResult extends User
{
 
    public $ltiResultSourcedId = null;
 
    public $created = null;
 
    public $updated = null;
 
    private $resourceLink = null;
 
    private $resourceLinkId = null;
 
    private $id = null;
 
    private $dataConnector = null;
 
    public function __construct()
    {
        $this->initialize();
    }
 
    public function initialize()
    {
        parent::initialize();
        $this->ltiResultSourcedId = null;
        $this->created = null;
        $this->updated = null;
    }
 
    public function save()
    {
        if (!is_null($this->resourceLinkId)) {
            $ok = $this->getDataConnector()->saveUserResult($this);
        } else {
            $ok = true;
        }
 
        return $ok;
    }
 
    public function delete()
    {
        $ok = $this->getDataConnector()->deleteUserResult($this);
 
        return $ok;
    }
 
    public function getResourceLink()
    {
        if (is_null($this->resourceLink) && !is_null($this->resourceLinkId)) {
            $this->resourceLink = ResourceLink::fromRecordId($this->resourceLinkId, $this->getDataConnector());
        }
 
        return $this->resourceLink;
    }
 
    public function setResourceLink($resourceLink)
    {
        $this->resourceLink = $resourceLink;
    }
 
    public function getRecordId()
    {
        return $this->id;
    }
 
    public function setRecordId($id)
    {
        $this->id = $id;
    }
 
    public function setResourceLinkId($resourceLinkId)
    {
        $this->resourceLink = null;
        $this->resourceLinkId = $resourceLinkId;
    }
 
    public function getDataConnector()
    {
        return $this->dataConnector;
    }
 
    public function setDataConnector($dataConnector)
    {
        $this->dataConnector = $dataConnector;
    }
 
    public function getId($idScope = null, $source = null)
    {
        $resourceLink = $this->getResourceLink();
        $context = null;
        $platform = null;
        if ($source instanceof Context) {
            $context = $source;
            $platform = $context->getPlatform();
        } elseif (!is_null($resourceLink)) {
            $context = $resourceLink->getContext();
            $platform = $resourceLink->getPlatform();
        } elseif ($source instanceof Platform) {
            $platform = $source;
        }
        $key = '';
        if (!is_null($platform)) {
            $key = $platform->getId();
            if (is_null($idScope)) {
                $idScope = $platform->idScope;
            }
        }
        if (is_null($idScope)) {
            $idScope = Tool::ID_SCOPE_ID_ONLY;
        }
        $ok = !empty($key) || ($idScope === Tool::ID_SCOPE_ID_ONLY);
        if ($ok) {
            $id = $key . Tool::ID_SCOPE_SEPARATOR;
            switch ($idScope) {
                case Tool::ID_SCOPE_GLOBAL:
                    $id .= $this->ltiUserId;
                    break;
                case Tool::ID_SCOPE_CONTEXT:
                    $ok = !is_null($context) && !empty($context->ltiContextId);
                    if ($ok) {
                        $id .= $context->ltiContextId . Tool::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                    }
                    break;
                case Tool::ID_SCOPE_RESOURCE:
                    $ok = !is_null($resourceLink) && !empty($resourceLink->ltiResourceLinkId);
                    if ($ok) {
                        $id .= $resourceLink->ltiResourceLinkId . Tool::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                    }
                    break;
                default:
                    $id = $this->ltiUserId;
                    break;
            }
        }
        if (!$ok) {
            $id = null;
        }
 
        return $id;
    }
 
    public static function fromRecordId($id, $dataConnector)
    {
        $userresult = new UserResult();
        $userresult->dataConnector = $dataConnector;
        $userresult->load($id);
 
        return $userresult;
    }
 
    public static function fromResourceLink($resourceLink, $ltiUserId)
    {
        $userresult = new UserResult();
        $userresult->resourceLink = $resourceLink;
        if (!is_null($resourceLink)) {
            $userresult->resourceLinkId = $resourceLink->getRecordId();
            $userresult->dataConnector = $resourceLink->getDataConnector();
        }
        $userresult->ltiUserId = $ltiUserId;
        if (!empty($ltiUserId)) {
            $userresult->load();
        }
 
        return $userresult;
    }
 
###
###  PRIVATE METHODS
###
 
    private function load($id = null)
    {
        $this->initialize();
        $this->id = $id;
        $dataConnector = $this->getDataConnector();
        if (!is_null($dataConnector)) {
            return $dataConnector->loadUserResult($this);
        }
 
        return false;
    }
 
}