Context.php

Go to the documentation of this file.

<?php
 
namespace ILIAS\LTI\ToolProvider;
 
use ILIAS\LTI\ToolProvider\Service;
use ILIAS\LTI\ToolProvider\Http\HTTPMessage;
use ILIAS\LTI\ToolProvider\ApiHook\ApiHook;
use ILIAS\LTI\ToolProvider\Util;
 
class Context
{
    use ApiHook;
 
    public ?string $ltiContextId = null;
 
    public ?string $title = null;
 
    public ?string $type = null;
 
    public ?array $groupSets = null;
 
    public ?array $groups = null;
 
    public ?HTTPMessage $lastServiceRequest = null;
 
    public ?int $created = null;
 
    public ?int $updated = null;
 
    private ?Platform $platform = null;
 
    private ?int $platformId = null;
 
    private ?int $id = null;
 
    private ?array $settings = null;
 
    private bool $settingsChanged = false;
 
    private ?\ILIAS\LTI\ToolProvider\DataConnector\DataConnector $dataConnector = null;
 
    public function __construct()
    {
        $this->initialize();
    }
 
    public function initialize()
    {
        $this->title = '';
        $this->settings = array();
        $this->groupSets = null;
        $this->groups = null;
        $this->created = null;
        $this->updated = null;
    }
 
    public function initialise()
    {
        $this->initialize();
    }
 
    public function save(): bool
    {
        $ok = $this->getDataConnector()->saveContext($this);
        if ($ok) {
            $this->settingsChanged = false;
        }
 
        return $ok;
    }
 
    public function delete(): bool
    {
        return $this->getDataConnector()->deleteContext($this);
    }
 
//    /**
//     * Get tool consumer.
//     *
//     * @deprecated Use getPlatform() instead
//     * @see Context::getPlatform()
//     *
//     * @return ToolConsumer Tool consumer object for this context.
//     */
//    public function getConsumer()
//    {
//        Util::logDebug('Method ceLTIc\LTI\Context::getConsumer() has been deprecated; please use ceLTIc\LTI\Context::getPlatform() instead.',
//            true);
//        return $this->getPlatform();
//    }
 
//    /**
//     * Set tool consumer ID.
//     *
//     * @deprecated Use setPlatformId() instead
//     * @see Context::setPlatformId()
//     *
//     * @param int $consumerId  Tool Consumer ID for this context.
//     */
//    public function setConsumerId($consumerId)
//    {
//        Util::logDebug('Method ceLTIc\LTI\Context::setConsumerId() has been deprecated; please use ceLTIc\LTI\Context::setPlatformId() instead.',
//            true);
//        $this->setPlatformId($consumerId);
//    }
 
    public function getPlatform(): ?\ilLTIPlatform
    {
        if (is_null($this->platform)) {
            $this->platform = \ilLTIPlatform::fromRecordId($this->platformId, $this->getDataConnector());
        }
 
        return $this->platform;
    }
 
    public function setPlatformId(int $platformId)
    {
        $this->platform = null;
        $this->platformId = $platformId;
    }
 
    public function getKey(): string
    {
        return $this->getPlatform()->getKey();
    }
 
    public function getId(): ?string
    {
        return $this->ltiContextId;
    }
 
    public function getRecordId(): ?int
    {
        return $this->id;
    }
 
    public function setRecordId(int $id)
    {
        $this->id = $id;
    }
 
    public function getDataConnector()
    {
        return $this->dataConnector;
    }
 
    public function getSetting(string $name, string $default = ''): string
    {
        if (array_key_exists($name, $this->settings)) {
            $value = $this->settings[$name];
        } else {
            $value = $default;
        }
 
        return $value;
    }
 
    public function setSetting(string $name, string $value = null)
    {
        $old_value = $this->getSetting($name);
        if ($value !== $old_value) {
            if (!empty($value)) {
                $this->settings[$name] = $value;
            } else {
                unset($this->settings[$name]);
            }
            $this->settingsChanged = true;
        }
    }
 
    public function getSettings(): ?array
    {
        return $this->settings;
    }
 
    public function setSettings(array $settings)
    {
        $this->settings = $settings;
    }
 
    public function saveSettings(): bool
    {
        if ($this->settingsChanged) {
            $ok = $this->save();
        } else {
            $ok = true;
        }
 
        return $ok;
    }
 
    public function hasToolSettingsService(): bool
    {
        $has = !empty($this->getSetting('custom_context_setting_url'));
        if (!$has) {
            $has = self::hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        }
        return $has;
    }
 
    public function getToolSettings(int $mode = Service\ToolSettings::MODE_CURRENT_LEVEL, bool $simple = true)
    {
        $ok = false;
        $settings = array();
        if (!empty($this->getSetting('custom_context_setting_url'))) {
            $url = $this->getSetting('custom_context_setting_url');
            $service = new Service\ToolSettings($this, $url, $simple);
            $settings = $service->get($mode);
            $this->lastServiceRequest = $service->getHttpMessage();
            $ok = $settings !== false;
        }
        if (!$ok && $this->hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
            $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
            $hook = new $className($this);
            $settings = $hook->getToolSettings($mode, $simple);
        }
 
        return $settings;
    }
 
    public function setToolSettings(array $settings = array()): bool
    {
        $ok = false;
        if (!empty($this->getSetting('custom_context_setting_url'))) {
            $url = $this->getSetting('custom_context_setting_url');
            $service = new Service\ToolSettings($this, $url);
            $ok = $service->set($settings);
            $this->lastServiceRequest = $service->getHttpMessage();
        }
        if (!$ok && $this->hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
            $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
            $hook = new $className($this);
            $ok = $hook->setToolSettings($settings);
        }
 
        return $ok;
    }
 
    public function hasGroupService(): bool
    {
        $has = !empty($this->getSetting('custom_context_groups_url'));
        if (!$has) {
            $has = self::hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        }
        return $has;
    }
 
    public function getGroups(): bool
    {
        $groupsUrl = $this->getSetting('custom_context_groups_url');
        $groupsetsUrl = $this->getSetting('custom_context_group_sets_url');
        $service = new Service\Groups($this, $groupsUrl, $groupsetsUrl);
        $ok = $service->get();
        if (!empty($service->getHttpMessage())) {
            $this->lastServiceRequest = $service->getHttpMessage();
        }
        if (!$ok && $this->hasConfiguredApiHook(self::$GROUPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
            $className = $this->getApiHook(self::$GROUPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
            $hook = new $className($this);
            $ok = $hook->getGroups();
        }
 
        return $ok;
    }
 
    public function hasMembershipService(): bool
    {
        Util::logDebug(
            'Method ceLTIc\LTI\Context::hasMembershipService() has been deprecated; please use ceLTIc\LTI\Context::hasMembershipsService() instead.',
            true
        );
        return $this->hasMembershipsService();
    }
 
    public function hasMembershipsService(): bool
    {
        $has = !empty($this->getSetting('custom_context_memberships_url')) || !empty($this->getSetting('custom_context_memberships_v2_url'));
        if (!$has) {
            $has = self::hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        }
        return $has;
    }
 
    public function getMembership()
    {
        Util::logDebug(
            'Method ceLTIc\LTI\Context::getMembership() has been deprecated; please use ceLTIc\LTI\Context::getMemberships() instead.',
            true
        );
        return $this->getMemberships();
    }
 
    public function getMemberships(bool $withGroups = false)
    {
        $ok = false;
        $userResults = array();
        $hasMembershipsService = !empty($this->getSetting('custom_context_memberships_url'));
        $hasNRPService = !empty($this->getSetting('custom_context_memberships_v2_url'));
        $hasGroupsService = !empty($this->getSetting('custom_context_groups_url')) ||
            $this->hasConfiguredApiHook(self::$GROUPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        $hasApiHook = $this->hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        if (($hasMembershipsService || $hasNRPService) && (!$withGroups || ($hasNRPService && $hasGroupsService) || !$hasApiHook)) {
            if ($hasNRPService) {
                $url = $this->getSetting('custom_context_memberships_v2_url');
                $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_NRPS;
            } else {
                $url = $this->getSetting('custom_context_memberships_url');
                $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_V1;
            }
            $service = new Service\Membership($this, $url, $format);
            if (!$withGroups || !$hasNRPService) {
                $userResults = $service->get();
            } else {
                $userResults = $service->getWithGroups();
            }
            if (!empty($service->getHttpMessage())) {
                $this->lastServiceRequest = $service->getHttpMessage();
            }
            $ok = $userResults !== false;
        }
        if (!$ok && $hasApiHook) {
            $className = $this->getApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
            $hook = new $className($this);
            $userResults = $hook->getMemberships($withGroups);
        }
 
        return $userResults;
    }
 
    public function hasLineItemService(): bool
    {
        $has = false;
        if (!empty($this->getSetting('custom_ags_scopes'))) {
            $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
            if (in_array(Service\LineItem::$SCOPE, $scopes) || in_array(Service\LineItem::$SCOPE_READONLY, $scopes)) {
                $has = !empty($this->getSetting('custom_lineitems_url'));
            }
        }
 
        return $has;
    }
 
    public function hasScoreService(): bool
    {
        $has = false;
        if (!empty($this->getSetting('custom_ags_scopes'))) {
            $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
            if (in_array(Service\Score::$SCOPE, $scopes)) {
                $has = !empty($this->getSetting('custom_lineitems_url'));
            }
        }
 
        return $has;
    }
 
    public function hasResultService(): bool
    {
        $has = false;
        if (!empty($this->getSetting('custom_ags_scopes'))) {
            $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
            if (in_array(Service\Result::$SCOPE, $scopes)) {
                $has = !empty($this->getSetting('custom_lineitems_url'));
            }
        }
 
        return $has;
    }
 
    public function getLineItems(string $resourceId = null, string $tag = null, int $limit = null)
    {
        $lineItems = false;
        $this->lastServiceRequest = null;
        $lineItemService = $this->getLineItemService();
        if (!empty($lineItemService)) {
            $lineItems = $lineItemService->getAll(null, $resourceId, $tag);
            $http = $lineItemService->getHttpMessage();
            $this->lastServiceRequest = $http;
        }
 
        return $lineItems;
    }
 
    public function createLineItem(LineItem $lineItem): bool
    {
        $ok = false;
        $lineItemService = $this->getLineItemService();
        if (!empty($lineItemService)) {
            $ok = $lineItemService->createLineItem($lineItem);
        }
 
        return $ok;
    }
 
    public static function fromRecordId(int $id, \ILIAS\LTI\ToolProvider\DataConnector\DataConnector $dataConnector): Context
    {
        $context = new Context();
        $context->dataConnector = $dataConnector;
        $context->load($id);
 
        return $context;
    }
 
//    /**
//     * Class constructor from consumer.
//     *
//     * @deprecated Use fromPlatform() instead
//     * @see Context::fromPlatform()
//     *
//     * @param ToolConsumer    $consumer       Consumer instance
//     * @param string          $ltiContextId   LTI Context ID value
//     *
//     * @return Context
//     */
//    public static function fromConsumer($consumer, $ltiContextId)
//    {
//        return self::fromPlatform($consumer, $ltiContextId);
//    }
 
    public static function fromPlatform(Platform $platform, string $ltiContextId): Context
    {
        $context = new Context();
        $context->platform = $platform;
        $context->dataConnector = $platform->getDataConnector();
        $context->ltiContextId = $ltiContextId;
        if (!empty($ltiContextId)) {
            $context->load();
        }
 
        return $context;
    }
 
    ###
    ###  PRIVATE METHODS
    ###
 
    private function load(int $id = null): bool
    {
        $this->initialize();
        $this->id = $id;
        return $this->getDataConnector()->loadContext($this);
    }
 
    private function getLineItemService()
    {
        $url = $this->getSetting('custom_lineitems_url');
        if (!empty($url)) {
            $lineItemService = new Service\LineItem($this->getPlatform(), $url);
        } else {
            $lineItemService = false;
        }
 
        return $lineItemService;
    }
}