ilCmiXapiAbstractReportLinkBuilder Class Reference

Inheritance diagram for ilCmiXapiAbstractReportLinkBuilder:

Collaboration diagram for ilCmiXapiAbstractReportLinkBuilder:

Public Member Functions
	__construct (int $objId, string $aggregateEndPoint, ilCmiXapiStatementsReportFilter $filter)
	ilCmiXapiAbstractReportLinkBuilder constructor. More...
	getUrl ()
	getObjId ()
	getAggregateEndPoint ()
	getObj ()

Protected Member Functions
	appendRequestParameters (string $url)
	buildPipelineParameter ()
	buildPipeline ()

Protected Attributes
int	$objId
string	$aggregateEndPoint
ilCmiXapiStatementsReportFilter	$filter

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiAbstractReportLinkBuilder::__construct	(	int	$objId,
		string	$aggregateEndPoint,
		ilCmiXapiStatementsReportFilter	$filter
	)

ilCmiXapiAbstractReportLinkBuilder constructor.

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

References $aggregateEndPoint, $filter, $objId, and ILIAS\UI\examples\Symbol\Glyph\Filter\filter().

      {
        $this->objId = $objId;
        $this->aggregateEndPoint = $aggregateEndPoint;
        $this->filter = $filter;
    }

Here is the call graph for this function:

Member Function Documentation

appendRequestParameters()

ilCmiXapiAbstractReportLinkBuilder::appendRequestParameters ( string  $url )

protected

Definition at line 55 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

References ilUtil\appendUrlParameterString(), and buildPipelineParameter().

Referenced by getUrl().

                                                           : string
    {
        return ilUtil::appendUrlParameterString($url, $this->buildPipelineParameter());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPipeline()

ilCmiXapiAbstractReportLinkBuilder::buildPipeline ( )

abstractprotected

Returns

mixed[]

Referenced by buildPipelineParameter().

Here is the caller graph for this function:

buildPipelineParameter()

ilCmiXapiAbstractReportLinkBuilder::buildPipelineParameter ( )

protected

Definition at line 60 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

References buildPipeline().

Referenced by appendRequestParameters().

                                               : string
    {
        $pipeline = urlencode(json_encode($this->buildPipeline()));
        return "pipeline={$pipeline}";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAggregateEndPoint()

ilCmiXapiAbstractReportLinkBuilder::getAggregateEndPoint

(

)

Definition at line 76 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

References $aggregateEndPoint.

                                          : string
    {
        return $this->aggregateEndPoint;
    }

getObj()

ilCmiXapiAbstractReportLinkBuilder::getObj

(

)

Returns

ilObjCmiXapi|ilObjLTIConsumer

Definition at line 84 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

References ilObject\_lookupType(), ilObjCmiXapi\getInstance(), ilObjLTIConsumer\getInstance(), and getObjId().

Referenced by ilCmiXapiHighscoreReportLinkBuilder\buildFilterStage(), ilCmiXapiStatementsReportLinkBuilder\buildFilterStage(), ilCmiXapiStatementsReportLinkBuilder\buildOrderingStage(), ilCmiXapiHighscoreReportLinkBuilder\buildPipeline(), and ilCmiXapiHighscoreReportLinkBuilder\getUsersStack().

    {
        if (ilObject::_lookupType($this->getObjId()) == 'lti') {
            return ilObjLTIConsumer::getInstance($this->getObjId(), false);
        }
        return ilObjCmiXapi::getInstance($this->getObjId(), false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjId()

ilCmiXapiAbstractReportLinkBuilder::getObjId

(

)

Definition at line 71 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

References $objId.

Referenced by ilCmiXapiHighscoreReportLinkBuilder\buildFilterStage(), ilCmiXapiStatementsReportLinkBuilder\buildFilterStage(), ilCmiXapiHighscoreReportLinkBuilder\buildPipeline(), getObj(), and ilCmiXapiHighscoreReportLinkBuilder\getUsersStack().

                              : int
    {
        return $this->objId;
    }

Here is the caller graph for this function:

getUrl()

ilCmiXapiAbstractReportLinkBuilder::getUrl

(

)

Definition at line 49 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

References appendRequestParameters().

                            : string
    {
        return $this->appendRequestParameters($this->aggregateEndPoint);
    }

Here is the call graph for this function:

Field Documentation

$aggregateEndPoint

string ilCmiXapiAbstractReportLinkBuilder::$aggregateEndPoint

protected

Definition at line 33 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

Referenced by __construct(), and getAggregateEndPoint().

$filter

ilCmiXapiStatementsReportFilter ilCmiXapiAbstractReportLinkBuilder::$filter

protected

Definition at line 34 of file class.ilCmiXapiAbstractReportLinkBuilder.php.

Referenced by __construct().

$objId

int ilCmiXapiAbstractReportLinkBuilder::$objId

protected

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

Referenced by __construct(), and getObjId().

---

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

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