ilXapiCompliantStatementsReportLinkBuilder Class Reference

Collaboration diagram for ilXapiCompliantStatementsReportLinkBuilder:

Public Member Functions
	__construct (ilObjCmiXapi $object, ilCmiXapiStatementsReportFilter $filter)
	getUrl ()

Protected Member Functions
	appendRequestParameters ($link)
	buildParamAgent ()
	buildParamVerb ()
	buildParamSince ()
	buildParamUntil ()
	buildParamActivity ()
	buildParamRelatedAgents ()
	buildParamRelatedActivities ()
	buildParamLimit ()

Protected Attributes
	$object
	$lrsType
	$filter

Detailed Description

Definition at line 15 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Constructor & Destructor Documentation

__construct()

ilXapiCompliantStatementsReportLinkBuilder::__construct	(	ilObjCmiXapi	$object,
		ilCmiXapiStatementsReportFilter	$filter
	)

Definition at line 32 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References $filter, $object, filter(), and ilObjCmiXapi\getLrsType().

    {
        $this->object = $object;
        $this->lrsType = $object->getLrsType();
        $this->filter = $filter;
    }

Here is the call graph for this function:

Member Function Documentation

appendRequestParameters()

ilXapiCompliantStatementsReportLinkBuilder::appendRequestParameters (   $link )

protected

Parameters

string

$link

Returns

string

Definition at line 50 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References ilUtil\appendUrlParameterString(), buildParamActivity(), buildParamAgent(), buildParamLimit(), buildParamRelatedActivities(), buildParamRelatedAgents(), buildParamSince(), buildParamUntil(), buildParamVerb(), and filter().

Referenced by getUrl().

    {
        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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildParamActivity()

ilXapiCompliantStatementsReportLinkBuilder::buildParamActivity ( )

protected

Definition at line 107 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Referenced by appendRequestParameters().

    {
        return "activity={$this->object->getActivityId()}";
    }

Here is the caller graph for this function:

buildParamAgent()

ilXapiCompliantStatementsReportLinkBuilder::buildParamAgent ( )

protected

Definition at line 79 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References filter().

Referenced by appendRequestParameters().

    {
        $agent = json_encode([
            'objectType' => 'Agent',
            'mbox' => 'mailto:' . $this->filter->getActor()->getUsrIdent()
        ]);
        
        return "agent={$agent}";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildParamLimit()

ilXapiCompliantStatementsReportLinkBuilder::buildParamLimit ( )

protected

Definition at line 122 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Referenced by appendRequestParameters().

    {
        return "limit={$this->filter->getLimit()}";
    }

Here is the caller graph for this function:

buildParamRelatedActivities()

ilXapiCompliantStatementsReportLinkBuilder::buildParamRelatedActivities ( )

protected

Definition at line 117 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Referenced by appendRequestParameters().

    {
        return "related_activities=false";
    }

Here is the caller graph for this function:

buildParamRelatedAgents()

ilXapiCompliantStatementsReportLinkBuilder::buildParamRelatedAgents ( )

protected

Definition at line 112 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Referenced by appendRequestParameters().

    {
        return "related_agents=false";
    }

Here is the caller graph for this function:

buildParamSince()

ilXapiCompliantStatementsReportLinkBuilder::buildParamSince ( )

protected

Definition at line 95 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References filter().

Referenced by appendRequestParameters().

    {
        $since = urlencode($this->filter->getStartDate()->toXapiTimestamp());
        return "since={$since}";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildParamUntil()

ilXapiCompliantStatementsReportLinkBuilder::buildParamUntil ( )

protected

Definition at line 101 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References filter().

Referenced by appendRequestParameters().

    {
        $until = urlencode($this->filter->getEndDate()->toXapiTimestamp());
        return "until={$until}";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildParamVerb()

ilXapiCompliantStatementsReportLinkBuilder::buildParamVerb ( )

protected

Definition at line 89 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References filter().

Referenced by appendRequestParameters().

    {
        $verb = urlencode($this->filter->getVerb());
        return "verb={$verb}";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUrl()

ilXapiCompliantStatementsReportLinkBuilder::getUrl

(

)

Definition at line 39 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

References appendRequestParameters().

    {
        $link = $this->lrsType->getLrsEndpointStatementsLink();
        $link = $this->appendRequestParameters($link);
        return $link;
    }

Here is the call graph for this function:

Field Documentation

$filter

ilXapiCompliantStatementsReportLinkBuilder::$filter

protected

Definition at line 30 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Referenced by __construct().

$lrsType

ilXapiCompliantStatementsReportLinkBuilder::$lrsType

protected

Definition at line 25 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

$object

ilXapiCompliantStatementsReportLinkBuilder::$object

protected

Definition at line 20 of file class.ilXapiCompliantStatementsReportLinkBuilder.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• Modules/CmiXapi/classes/XapiReport/class.ilXapiCompliantStatementsReportLinkBuilder.php