class.ilXapiCompliantStatementsReportLinkBuilder.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilXapiCompliantStatementsReportLinkBuilder
{
    protected $object;
    
    protected $lrsType;
    
    protected $filter;
    
    public function __construct(ilObjCmiXapi $object, ilCmiXapiStatementsReportFilter $filter)
    {
        $this->object = $object;
        $this->lrsType = $object->getLrsType();
        $this->filter = $filter;
    }
    
    public function getUrl()
    {
        $link = $this->lrsType->getLrsEndpointStatementsLink();
        $link = $this->appendRequestParameters($link);
        return $link;
    }
    
    protected function appendRequestParameters($link)
    {
        if ($this->filter->getLimit()) {
            $link = ilUtil::appendUrlParameterString($link, $this->buildParamLimit());
        }
        
        if ($this->filter->getActor()) {
            $link = ilUtil::appendUrlParameterString($link, $this->buildParamAgent());
        }
        
        if ($this->filter->getVerb()) {
            $link = ilUtil::appendUrlParameterString($link, $this->buildParamVerb());
        }
        
        if ($this->filter->getStartDate()) {
            $link = ilUtil::appendUrlParameterString($link, $this->buildParamSince());
        }
        
        if ($this->filter->getEndDate()) {
            $link = ilUtil::appendUrlParameterString($link, $this->buildParamUntil());
        }
        
        $link = ilUtil::appendUrlParameterString($link, $this->buildParamRelatedAgents());
        $link = ilUtil::appendUrlParameterString($link, $this->buildParamRelatedActivities());
        $link = ilUtil::appendUrlParameterString($link, $this->buildParamActivity());
        
        return $link;
    }
    
    protected function buildParamAgent()
    {
        $agent = json_encode([
            'objectType' => 'Agent',
            'mbox' => 'mailto:' . $this->filter->getActor()->getUsrIdent()
        ]);
        
        return "agent={$agent}";
    }
    
    protected function buildParamVerb()
    {
        $verb = urlencode($this->filter->getVerb());
        return "verb={$verb}";
    }
    
    protected function buildParamSince()
    {
        $since = urlencode($this->filter->getStartDate()->toXapiTimestamp());
        return "since={$since}";
    }
    
    protected function buildParamUntil()
    {
        $until = urlencode($this->filter->getEndDate()->toXapiTimestamp());
        return "until={$until}";
    }
    
    protected function buildParamActivity()
    {
        return "activity={$this->object->getActivityId()}";
    }
    
    protected function buildParamRelatedAgents()
    {
        return "related_agents=false";
    }
    
    protected function buildParamRelatedActivities()
    {
        return "related_activities=false";
    }
    
    protected function buildParamLimit()
    {
        return "limit={$this->filter->getLimit()}";
    }
}