UserResult.php

Go to the documentation of this file.

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