LineItem.php

Go to the documentation of this file.

<?php

namespace ILIAS\LTI\ToolProvider;

use ILIAS\LTI\ToolProvider\Service;

class LineItem
{
    public ?string $label = null;

    public int $pointsPossible = 1;

    public ?string $ltiResourceLinkId = null;

    public ?string $resourceId = null;

    public ?string $tag = null;

    public ?int $submitFrom = null;

    public ?int $submitUntil = null;

    public ?string $endpoint = null;

    private ?Platform $platform = null;

    public function __construct(Platform $platform, string $label, int $pointsPossible)
    {
        $this->platform = $platform;
        $this->label = $label;
        $this->pointsPossible = $pointsPossible;
    }

    public function getPlatform(): ?Platform
    {
        return $this->platform;
    }

    public function save(): bool
    {
        $service = new Service\LineItem($this->platform, $this->endpoint);
        return $service->saveLineItem($this);
    }

    public function delete(): bool
    {
        $service = new Service\LineItem($this->platform, $this->endpoint);
        return $service->deleteLineItem($this);
    }

    public function getOutcomes(int $limit = null)
    {
        $resultService = new Service\Result($this->platform, $this->endpoint);
        return $resultService->getAll();
    }

    public function readOutcome(User $user)
    {
        $resultService = new Service\Result($this->platform, $this->endpoint);
        return $resultService->get($user);
    }

    public function submitOutcome(Outcome $ltiOutcome, User $user): bool
    {
        $scoreService = new Service\Score($this->platform, $this->endpoint);
        return $scoreService->submit($ltiOutcome, $user);
    }

    public function deleteOutcome(User $user): bool
    {
        $ltiOutcome = new Outcome();
        $scoreService = new Service\Score($this->platform, $this->endpoint);
        return $scoreService->submit($ltiOutcome, $user);
    }

    public static function fromEndpoint(Platform $platform, string $endpoint)
    {
        return Service\LineItem::getLineItem($platform, $endpoint);
    }
}