class.ilLTIPlatform.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ceLTIc\LTI\DataConnector\DataConnector;
use ceLTIc\LTI\Enum\IdScope;
use ceLTIc\LTI\Platform;
use ceLTIc\LTI\Util;

class ilLTIPlatform extends Platform
{
    protected int $ref_id = 0;

    protected int $ext_consumer_id = 0;

    protected string $title = '';

    protected string $description = '';

    protected string $prefix = '';

    protected string $user_language = '';

    protected int $role = 0;

    protected bool $active = false;

    private ?array $settings = null;

    private ?int $id = null;

    private ?string $key = null;

    public function __construct(?ilLTIDataConnector $dataConnector = null)
    {
        $this->initialize();
        if (empty($dataConnector)) {
            $dataConnector = ilLTIDataConnector::getDataConnector();
        }
        $this->dataConnector = $dataConnector;
    }

    public function initialize(): void
    {
        $this->id = null;
        $this->key = null;
        $this->name = null;
        $this->secret = null;
        $this->signatureMethod = 'HMAC-SHA1';
        $this->encryptionMethod = '';
        $this->rsaKey = null;
        $this->kid = null;
        $this->jku = '';
        $this->platformId = null;
        $this->clientId = null;
        $this->deploymentId = null;
        $this->ltiVersion = null;
        $this->consumerName = null;
        $this->consumerVersion = null;
        $this->consumerGuid = null;
        $this->profile = null;
        $this->toolProxy = null;
        $this->settings = array();
        $this->setSettings(array());
        $this->protected = false;
        $this->enabled = false;
        $this->enableFrom = null;
        $this->enableUntil = null;
        $this->lastAccess = null;
        $this->idScope = IdScope::IdOnly;
        $this->defaultEmail = '';
        $this->created = null;
        $this->updated = null;
        //added
        $this->authorizationServerId = '';
        $this->authenticationUrl = '';
        $this->accessTokenUrl = '';
        $this->debugMode = false;
    }


    public function setExtConsumerId(int $a_id): void
    {
        $this->ext_consumer_id = $a_id;
    }

    public function getExtConsumerId(): int
    {
        return $this->ext_consumer_id;
    }

    public function setRefId(int $a_ref_id): void
    {
        $this->ref_id = $a_ref_id;
    }

    public function getRefId(): int
    {
        return $this->ref_id;
    }

    //    public function getId() : ?int
    //    {
    //        return $this->getRecordId();
    //    }

    public function setTitle(string $title): void
    {
        $this->title = $title;
        // $this->consumerName = $title;
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function setDescription(string $description): void
    {
        $this->description = $description;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setPrefix(string $prefix): void
    {
        $this->prefix = $prefix;
    }

    public function getPrefix(): string
    {
        return $this->prefix;
    }

    public function setSecret(string $secret): void
    {
        $this->secret = $secret;
    }

    public function getSecret(): ?string
    {
        return $this->secret;
    }

    public function createSecret(): void
    {
        $this->setSecret(Util::getRandomString(12));
    }

    public function setLanguage(string $lang): void
    {
        $this->user_language = $lang;
    }

    public function getLanguage(): string
    {
        return $this->user_language;
    }

    public function setActive(bool $value): void
    {
        $this->active = $value;
    }

    public function getActive(): bool
    {
        return $this->active;
    }

    public function setRole(int $role_id): void
    {
        $this->role = $role_id;
    }

    public function getRole(): int
    {
        return $this->role;
    }


    public function setEnabled(bool $a_status): void
    {
        $this->enabled = $a_status;
    }

    public function getEnabled(): bool
    {
        return $this->enabled;
    }

    // local_role_always_member, default_skin

    public static function fromPlatformId(string $platformId, ?string $clientId, ?string $deploymentId, ?DataConnector $dataConnector = null, bool $autoEnable = false): ilLTIPlatform
    {
        $platform = new ilLTIPlatform($dataConnector);
        $platform->initialize();
        $platform->platformId = $platformId;
        $platform->clientId = $clientId;
        $platform->deploymentId = $deploymentId;
        $dataConnector->loadPlatform($platform);
        $dataConnector->loadGlobalToolConsumerSettings($platform);
        return $platform;
    }

    public static function fromConsumerKey(?string $key = null, $dataConnector = null, bool $autoEnable = false): ilLTIPlatform
    {
        $platform = new ilLTIPlatform($dataConnector);
        $platform->initialize();
        $platform->setKey($key);
        ilLoggerFactory::getLogger('ltis')->debug('Loading with key: ' . $platform->getKey());
        $dataConnector->loadPlatform($platform);
        $dataConnector->loadGlobalToolConsumerSettings($platform);
        return $platform;
    }

    public static function fromRecordId(int|string $id, DataConnector $dataConnector): ilLTIPlatform
    {
        //        $platform = new static($dataConnector);
        $platform = new ilLTIPlatform($dataConnector);
        $platform->initialize();
        $platform->setRecordId((int) $id);
        ilLoggerFactory::getLogger('ltis')->info('Loading with record id: ' . $platform->getRecordId());
        $dataConnector->loadPlatform($platform);
        $dataConnector->loadGlobalToolConsumerSettings($platform);
        return $platform;
    }

    public static function fromExternalConsumerId(int $id, ilLTIDataConnector $dataConnector): ilLTIPlatform
    {
        $platform = new ilLTIPlatform($dataConnector);
        //$platform->setRecordId((int) $id);
        //$dataConnector->loadPlatform($platform);
        $platform->initialize();
        $platform->setExtConsumerId($id);
        if (!$dataConnector->loadGlobalToolConsumerSettings($platform)) {
            $platform->initialize();
        }
        return $platform;
    }

    public static function fromGlobalSettingsAndRefId(int $a_ext_consumer_id, int $a_ref_id, ilLTIDataConnector $a_data_connector): ilLTIPlatform
    {
        $toolConsumer = new ilLTIPlatform(null, $a_data_connector);
        $toolConsumer->initialize();
        $toolConsumer->setExtConsumerId($a_ext_consumer_id);
        $toolConsumer->setRefId($a_ref_id);

        $consumer_pk = $a_data_connector->lookupRecordIdByGlobalSettingsAndRefId($toolConsumer);
        if ($consumer_pk != null) {
            $toolConsumer = self::fromRecordId($consumer_pk, $a_data_connector);
        }
        return $toolConsumer;
    }


    public function saveGlobalToolConsumerSettings(ilLTIDataConnector $dataConnector): void
    {
        $dataConnector->saveGlobalToolConsumerSettings($this);
    }

    public function deleteGlobalToolConsumerSettings(ilLTIDataConnector $dataConnector): void
    {
        $dataConnector->deleteGlobalToolConsumerSettings($this);
    }

    public function saveLTI(ilLTIDataConnector $dataConnector): bool
    {
        $ok = $dataConnector->saveToolConsumerILIAS($this);
        return $ok;
    }
}