ResourceLinkShareKey.php

Go to the documentation of this file.

<?php

namespace IMSGlobal\LTI\ToolProvider;

use IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector;

class ResourceLinkShareKey
{

    const MAX_SHARE_KEY_LIFE = 168;  // in hours (1 week)
    const DEFAULT_SHARE_KEY_LIFE = 24;  // in hours
    const MIN_SHARE_KEY_LENGTH = 5;
    const MAX_SHARE_KEY_LENGTH = 32;

    public $resourceLinkId = null;
    public $length = null;
    public $life = null;  // in hours
    public $autoApprove = false;
    public $expires = null;

    private $id = null;
    private $dataConnector = null;

    public function __construct($resourceLink, $id = null)
    {

        $this->initialize();
        $this->dataConnector = $resourceLink->getDataConnector();
        $this->resourceLinkId = $resourceLink->getRecordId();
        $this->id = $id;
        if (!empty($id)) {
            $this->load();
        }

    }

    public function initialize()
    {

        $this->length = null;
        $this->life = null;
        $this->autoApprove = false;
        $this->expires = null;

    }

    public function initialise()
    {

        $this->initialize();

    }

    public function save()
    {

        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 = DataConnector::getRandomString($this->length);
        }

        return $this->dataConnector->saveResourceLinkShareKey($this);

    }

    public function delete()
    {

        return $this->dataConnector->deleteResourceLinkShareKey($this);

    }

    public function getId()
    {

        return $this->id;

    }

###
###  PRIVATE METHOD
###

    private function load()
    {

        $this->initialize();
        $this->dataConnector->loadResourceLinkShareKey($this);
        if (!is_null($this->id)) {
            $this->length = strlen($this->id);
        }
        if (!is_null($this->expires)) {
            $this->life = ($this->expires - time()) / 60 / 60;
        }

    }

}