LtiLinkItem.php

Go to the documentation of this file.

<?php

namespace ILIAS\LTI\ToolProvider\Content;

class LtiLinkItem extends Item
{
    private array $custom = array();

    private ?LineItem $lineItem = null;

    private ?string $available = null;

    private ?string $submission = null;

    private ?bool $noUpdate = null;

    public function __construct($placementAdvices = null, $id = null)
    {
        parent::__construct(Item::TYPE_LTI_LINK, $placementAdvices, $id);
        $this->setMediaType(Item::LTI_LINK_MEDIA_TYPE);
    }

    public function addCustom(string $name, ?string $value = null)
    {
        if (!empty($name)) {
            if (!empty($value)) {
                $this->custom[$name] = $value;
            } else {
                reset($this->custom[$name]);
            }
        }
    }

    public function setLineItem(LineItem $lineItem)
    {
        $this->lineItem = $lineItem;
    }

    public function setAvailable($available)
    {
        $this->available = $available;
    }

    public function setSubmission($submission)
    {
        $this->submission = $submission;
    }

    public function setNoUpdate(?bool $noUpdate)
    {
        $this->noUpdate = $noUpdate;
    }

    public function toJsonldObject(): object
    {
        $item = parent::toJsonldObject();
        if (!empty($this->lineItem)) {
            $item->lineItem = $this->lineItem->toJsonldObject();
        }
        if (!is_null($this->noUpdate)) {
            $item->noUpdate = $this->noUpdate;
        }
        //ToDo: Check
//        if (!is_null($this->available)) {
//            $item->available = $this->available->toJsonldObject();
//        }
//        if (!is_null($this->submission)) {
//            $item->submission = $this->submission->toJsonldObject();
//        }
        if (!empty($this->custom)) {
            $item->custom = $this->custom;
        }

        return $item;
    }

    public function toJsonObject(): object
    {
        $item = parent::toJsonObject();
        if (!empty($this->lineItem)) {
            $item->lineItem = $this->lineItem->toJsonObject();
        }
        if (!is_null($this->noUpdate)) {
            $item->noUpdate = $this->noUpdate;
        }
        //ToDo: Check
//        if (!is_null($this->available)) {
//            $item->available = $this->available->toJsonObject();
//        }
//        if (!is_null($this->submission)) {
//            $item->submission = $this->submission->toJsonObject();
//        }
        if (!empty($this->custom)) {
            $item->custom = $this->custom;
        }

        return $item;
    }

    protected function fromJsonObject(object $item)
    {
        parent::fromJsonObject($item);
        foreach (get_object_vars($item) as $name => $value) {
            switch ($name) {
                case 'custom':
                    foreach ($item->custom as $paramName => $paramValue) {
                        $this->addCustom($paramName, $paramValue);
                    }
                    break;
                case 'lineItem':
                    $this->setLineItem(LineItem::fromJsonObject($item->lineItem));
                    break;
                case 'available':
                    $this->setAvailable(TimePeriod::fromJsonObject($item->available));
                    break;
                case 'submission':
                    $this->setSubmission(TimePeriod::fromJsonObject($item->submission));
                    break;
                case 'noUpdate':
                    $this->noUpdate = $item->noUpdate;
                    break;
            }
        }
    }
}