ilCmiXapiAbstractReportLinkBuilder Class Reference

Inheritance diagram for ilCmiXapiAbstractReportLinkBuilder:

Collaboration diagram for ilCmiXapiAbstractReportLinkBuilder:

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

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

Protected Attributes
	$objId
	$aggregateEndPoint
	$filter
	$obj

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiAbstractReportLinkBuilder::__construct	(		$obj,
			$aggregateEndPoint,
		ilCmiXapiStatementsReportFilter	$filter
	)

ilCmiXapiAbstractReportLinkBuilder constructor.

Parameters

	$obj
	$userIdentMode
	$aggregateEndPoint
ilCmiXapiStatementsReportFilter	$filter

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

References $aggregateEndPoint, $filter, and $obj.

      {
        $this->obj = $obj;
        $this->objId = $obj->getID();
        $this->aggregateEndPoint = $aggregateEndPoint;
        $this->filter = $filter;
    }

Member Function Documentation

appendRequestParameters()

ilCmiXapiAbstractReportLinkBuilder::appendRequestParameters (   $url )

protected

Parameters

string

$link

Returns

string

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

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

Referenced by getUrl().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildPipeline()

ilCmiXapiAbstractReportLinkBuilder::buildPipeline ( )

abstractprotected

Returns

array

Referenced by buildPipelineParameter().

Here is the caller graph for this function:

buildPipelineParameter()

ilCmiXapiAbstractReportLinkBuilder::buildPipelineParameter ( )

protected

Returns

string

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

References buildPipeline().

Referenced by appendRequestParameters().

    {
        $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

(

)

Returns

string

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

References $aggregateEndPoint.

    {
        return $this->aggregateEndPoint;
    }

getObj()

ilCmiXapiAbstractReportLinkBuilder::getObj

(

)

Returns

ilObjCmiXapi

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

References $obj.

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

    {
        return $this->obj;
    }

Here is the caller graph for this function:

getObjId()

ilCmiXapiAbstractReportLinkBuilder::getObjId

(

)

Returns

int

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

References $objId.

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

    {
        return $this->objId;
    }

Here is the caller graph for this function:

getUrl()

ilCmiXapiAbstractReportLinkBuilder::getUrl

(

)

Returns

string

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

References $aggregateEndPoint, $url, and appendRequestParameters().

    {
        $url = $this->aggregateEndPoint;
        $url = $this->appendRequestParameters($url);
        return $url;
    }

Here is the call graph for this function:

Field Documentation

$aggregateEndPoint

ilCmiXapiAbstractReportLinkBuilder::$aggregateEndPoint

protected

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

Referenced by __construct(), getAggregateEndPoint(), and getUrl().

$filter

ilCmiXapiAbstractReportLinkBuilder::$filter

protected

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

Referenced by __construct().

$obj

ilCmiXapiAbstractReportLinkBuilder::$obj

protected

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

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

$objId

ilCmiXapiAbstractReportLinkBuilder::$objId

protected

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

Referenced by getObjId().

---

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

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