Context.php

Go to the documentation of this file.

<?php

namespace IMSGlobal\LTI\ToolProvider;

use IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector;
use IMSGlobal\LTI\ToolProvider\Service;

class Context
{

    public $ltiContextId = null;
    public $title = null;
    public $settings = null;
    public $created = null;
    public $updated = null;

    private $consumer = null;
    private $consumerId = null;
    private $id = null;
    private $settingsChanged = false;
    private $dataConnector = null;

    public function __construct()
    {

        $this->initialize();

    }

    public function initialize()
    {

        $this->title = '';
        $this->settings = array();
        $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()
    {

        $url = $this->getSetting('custom_context_setting_url');

        return !empty($url);

    }

    public function getToolSettings($mode = Service\ToolSettings::MODE_CURRENT_LEVEL, $simple = true)
    {

        $url = $this->getSetting('custom_context_setting_url');
        $service = new Service\ToolSettings($this, $url, $simple);
        $response = $service->get($mode);

        return $response;

    }

    public function setToolSettings($settings = array())
    {

        $url = $this->getSetting('custom_context_setting_url');
        $service = new Service\ToolSettings($this, $url);
        $response = $service->set($settings);

        return $response;

    }

    public function hasMembershipService()
    {

        $url = $this->getSetting('custom_context_memberships_url');

        return !empty($url);

    }

    public function getMembership()
    {

        $url = $this->getSetting('custom_context_memberships_url');
        $service = new Service\Membership($this, $url);
        $response = $service->get();

        return $response;

    }

    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);

    }

}