Context.php

Go to the documentation of this file.

<?php

namespace ceLTIc\LTI;

use ceLTIc\LTI\Service;
use ceLTIc\LTI\HTTPMessage;
use ceLTIc\LTI\ApiHook\ApiHook;

class Context
{
    use ApiHook;

    public $ltiContextId = null;

    public $title = null;

    public $type = null;

    public $groupSets = null;

    public $groups = null;

    public $lastServiceRequest = null;

    public $created = null;

    public $updated = null;

    private $consumer = null;

    private $consumerId = null;

    private $id = null;

    private $settings = null;

    private $settingsChanged = false;

    private $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()
    {
        $ok = $this->getDataConnector()->saveContext($this);
        if ($ok) {
            $this->settingsChanged = false;
        }

        return $ok;
    }

    public function delete()
    {
        return $this->getDataConnector()->deleteContext($this);
    }

    public function getConsumer()
    {
        if (is_null($this->consumer)) {
            $this->consumer = ToolConsumer::fromRecordId($this->consumerId, $this->getDataConnector());
        }

        return $this->consumer;
    }

    public function setConsumerId($consumerId)
    {
        $this->consumer = null;
        $this->consumerId = $consumerId;
    }

    public function getKey()
    {
        return $this->getConsumer()->getKey();
    }

    public function getId()
    {
        return $this->ltiContextId;
    }

    public function getRecordId()
    {
        return $this->id;
    }

    public function setRecordId($id)
    {
        $this->id = $id;
    }

    public function getDataConnector()
    {
        return $this->dataConnector;
    }

    public function getSetting($name, $default = '')
    {
        if (array_key_exists($name, $this->settings)) {
            $value = $this->settings[$name];
        } else {
            $value = $default;
        }

        return $value;
    }

    public function setSetting($name, $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()
    {
        return $this->settings;
    }

    public function setSettings($settings)
    {
        $this->settings = $settings;
    }

    public function saveSettings()
    {
        if ($this->settingsChanged) {
            $ok = $this->save();
        } else {
            $ok = true;
        }

        return $ok;
    }

    public function hasToolSettingsService()
    {
        $has = !empty($this->getSetting('custom_context_setting_url'));
        if (!$has) {
            $has = self::hasApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode());
        }
        return $has;
    }

    public function getToolSettings($mode = Service\ToolSettings::MODE_CURRENT_LEVEL, $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->hasApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode())) {
            $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode());
            $hook = new $className($this);
            $settings = $hook->getToolSettings($mode, $simple);
        }

        return $settings;
    }

    public function setToolSettings($settings = array())
    {
        $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->hasApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode())) {
            $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode());
            $hook = new $className($this);
            $ok = $hook->setToolSettings($settings);
        }

        return $ok;
    }

    public function hasMembershipService()
    {
        return $this->hasMembershipsService();
    }

    public function hasMembershipsService()
    {
        $has = !empty($this->getSetting('custom_context_memberships_url'));
        if (!$has) {
            $has = self::hasApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode());
        }
        return $has;
    }

    public function getMembership()
    {
        return $this->getMemberships();
    }

    public function getMemberships($withGroups = false)
    {
        $ok = false;
        $userResults = array();
        $hasLtiService = !empty($this->getSetting('custom_context_memberships_url'));
        $hasApiHook = $this->hasApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode());
        if ($hasLtiService && (!$withGroups || !$hasApiHook)) {
            $url = $this->getSetting('custom_context_memberships_url');
            $service = new Service\Membership($this, $url);
            $userResults = $service->get();
            $this->lastServiceRequest = $service->getHTTPMessage();
            $ok = $userResults !== false;
        }
        if (!$ok && $hasApiHook) {
            $className = $this->getApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getConsumer()->getFamilyCode());
            $hook = new $className($this);
            $userResults = $hook->getMemberships($withGroups);
        }

        return $userResults;
    }

    public static function fromRecordId($id, $dataConnector)
    {
        $context = new Context();
        $context->dataConnector = $dataConnector;
        $context->load($id);

        return $context;
    }

    public static function fromConsumer($consumer, $ltiContextId)
    {
        $context = new Context();
        $context->consumer = $consumer;
        $context->dataConnector = $consumer->getDataConnector();
        $context->ltiContextId = $ltiContextId;
        if (!empty($ltiContextId)) {
            $context->load();
        }

        return $context;
    }

###
###  PRIVATE METHODS
###

    private function load($id = null)
    {
        $this->initialize();
        $this->id = $id;
        return $this->getDataConnector()->loadContext($this);
    }

}