class.ilLTIToolConsumer.php

Go to the documentation of this file.

<?php
 
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
 
use IMSGlobal\LTI\ToolProvider\ToolConsumer;
 
class ilLTIToolConsumer extends ToolConsumer
{
    protected $ref_id;
 
 
    protected $ext_consumer_id = 0;
 
    protected $title = '';
 
    protected $description = '';
 
    protected $prefix = '';
 
    protected $user_language = '';
 
    protected $role = 0;
 
    
    public function setExtConsumerId($a_id)
    {
        $this->ext_consumer_id = $a_id;
    }
    
    public function getExtConsumerId()
    {
        return $this->ext_consumer_id;
    }
    
    public function setRefId($a_ref_id)
    {
        $this->ref_id = $a_ref_id;
    }
    
    public function getRefId()
    {
        return $this->ref_id;
    }
 
    public function getId()
    {
        return $this->getRecordId();
    }
 
    public function setTitle($title)
    {
        $this->title = $title;
        // $this->consumerName = $title;
    }
 
    public function getTitle()
    {
        return $this->title;
    }
 
    public function setDescription($description)
    {
        $this->description = $description;
    }
 
    public function getDescription()
    {
        return $this->description;
    }
 
    public function setPrefix($prefix)
    {
        $this->prefix = $prefix;
    }
 
    public function getPrefix()
    {
        return $this->prefix;
    }
 
    public function setSecret($secret)
    {
        $this->secret = $secret;
    }
 
    public function getSecret()
    {
        return $this->secret;
    }
    
    
    public function createSecret()
    {
        $this->setSecret(\IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector::getRandomString(12));
    }
 
    public function setLanguage($lang)
    {
        $this->user_language = $lang;
    }
 
    public function getLanguage()
    {
        return $this->user_language;
    }
 
    public function setActive($value)
    {
        $this->active = $value;
    }
 
    public function getActive()
    {
        return $this->active;
    }
 
    public function setRole($role_id)
    {
        $this->role = $role_id;
    }
 
    public function getRole()
    {
        return $this->role;
    }
    
    
    public function setEnabled($a_status)
    {
        $this->enabled = $a_status;
    }
    
    public function getEnabled()
    {
        return $this->enabled;
    }
 
    // local_role_always_member, default_skin
 
    public static function fromRecordId($id, $dataConnector)
    {
        $toolConsumer = new ilLTIToolConsumer(null, $dataConnector);
 
        $toolConsumer->initialize();
        $toolConsumer->setRecordId($id);
        if (!$dataConnector->loadToolConsumerILIAS($toolConsumer)) {
            $toolConsumer->initialize();
        }
        $toolConsumer->setRecordId($id);
 
        ilLoggerFactory::getLogger('lti')->info('Loading with record id: ' . $toolConsumer->getRecordId());
 
        return $toolConsumer;
    }
    
    public static function fromExternalConsumerId($id, $dataConnector)
    {
        $toolConsumer = new ilLTIToolConsumer(null, $dataConnector);
        $toolConsumer->initialize();
        $toolConsumer->setExtConsumerId($id);
        if (!$dataConnector->loadGlobalToolConsumerSettings($toolConsumer)) {
            $toolConsumer->initialize();
        }
        return $toolConsumer;
    }
    
    
    public static function fromGlobalSettingsAndRefId($a_ext_consumer_id, $a_ref_id, ilLTIDataConnector $a_data_connector)
    {
        $toolConsumer = new ilLTIToolConsumer(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) {
            return self::fromRecordId($consumer_pk, $a_data_connector);
        }
        $toolConsumer->initialize();
        return $toolConsumer;
    }
 
 
    public function saveGlobalToolConsumerSettings(ilLTIDataConnector $dataConnector)
    {
        $dataConnector->saveGlobalToolConsumerSettings($this);
    }
    
    public function deleteGlobalToolConsumerSettings(ilLTIDataConnector $dataConnector)
    {
        $dataConnector->deleteGlobalToolConsumerSettings($this);
    }
 
 
    public function saveLTI($dataConnector)
    {
        $ok = $dataConnector->saveToolConsumerILIAS($this);
        return $ok;
    }
}