ResourceLinkShareKey.php

Go to the documentation of this file.

<?php
 
namespace ILIAS\LTI\ToolProvider;
 
use ILIAS\LTI\ToolProvider\DataConnector\DataConnector;
 
class ResourceLinkShareKey
{
    public const MAX_SHARE_KEY_LIFE = 168;  // in hours (1 week)
 
    public const DEFAULT_SHARE_KEY_LIFE = 24;  // in hours
 
    public const MIN_SHARE_KEY_LENGTH = 5;
 
    public const MAX_SHARE_KEY_LENGTH = 32;
 
    public ?int $resourceLinkId = null;
 
    public ?int $length = null;
 
    public ?int $life = null;  // in hours
 
    public bool $autoApprove = false;
 
    public ?int $expires = null;
 
    private ?string $id = null;
 
    private ?DataConnector $dataConnector = null;
 
    public function __construct(ResourceLink $resourceLink, string $id = null)
    {
        $this->initialize();
        $this->dataConnector = $resourceLink->getDataConnector();
        $this->id = $id;
        if (!empty($id)) {
            $this->load();
        } else {
            $this->resourceLinkId = $resourceLink->getRecordId();
        }
    }
 
    public function initialize()
    {
        $this->length = null;
        $this->life = null;
        $this->autoApprove = false;
        $this->expires = null;
    }
 
    public function initialise()
    {
        $this->initialize();
    }
 
    public function save(): bool
    {
        if (empty($this->life)) {
            $this->life = self::DEFAULT_SHARE_KEY_LIFE;
        } else {
            $this->life = max(min($this->life, self::MAX_SHARE_KEY_LIFE), 0);
        }
        $this->expires = time() + ($this->life * 60 * 60);
        if (empty($this->id)) {
            if (empty($this->length) || !is_numeric($this->length)) {
                $this->length = self::MAX_SHARE_KEY_LENGTH;
            } else {
                $this->length = max(min($this->length, self::MAX_SHARE_KEY_LENGTH), self::MIN_SHARE_KEY_LENGTH);
            }
            $this->id = Util::getRandomString($this->length);
        }
 
        return $this->dataConnector->saveResourceLinkShareKey($this);
    }
 
    public function delete(): bool
    {
        return $this->dataConnector->deleteResourceLinkShareKey($this);
    }
 
    public function getId(): ?string
    {
        return $this->id;
    }
 
    ###
    ###  PRIVATE METHOD
    ###
 
    private function load()
    {
        $this->initialize();
        $this->dataConnector->loadResourceLinkShareKey($this);
        if (!is_null($this->id)) {
            $this->length = strlen(strval($this->id));
        }
        if (!is_null($this->expires)) {
            $this->life = ($this->expires - time()) / 60 / 60;
        }
    }
}