ilCmiXapiHighscoreReportLinkBuilder Class Reference

Inheritance diagram for ilCmiXapiHighscoreReportLinkBuilder:

Collaboration diagram for ilCmiXapiHighscoreReportLinkBuilder:

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

Protected Member Functions
	buildPipeline ()
	buildFilterStage ()
	buildOrderStage ()
	getUsersStack ()
Protected Member Functions inherited from ilCmiXapiAbstractReportLinkBuilder
	appendRequestParameters ($url)
	buildPipelineParameter ()
	buildPipeline ()

Additional Inherited Members
Protected Attributes inherited from ilCmiXapiAbstractReportLinkBuilder
	$objId
	$aggregateEndPoint
	$filter
	$obj

Detailed Description

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

Member Function Documentation

buildFilterStage()

ilCmiXapiHighscoreReportLinkBuilder::buildFilterStage ( )

protected

Definition at line 48 of file class.ilCmiXapiHighscoreReportLinkBuilder.php.

References ilCmiXapiAbstractReportLinkBuilder\$obj, ilObjCmiXapi\CONT_TYPE_GENERIC, filter(), ilCmiXapiAbstractReportLinkBuilder\getObj(), and getUsersStack().

Referenced by buildPipeline().

    {
        $stage = array();
        
        $stage['statement.object.objectType'] = 'Activity';
        $stage['statement.actor.objectType'] = 'Agent';

        $stage['statement.object.id'] = $this->filter->getActivityId();
        
        $stage['statement.result.score.scaled'] = [
            '$exists' => 1
        ];
        
        $obj = $this->getObj();
        if ($obj instanceof ilObjLTIConsumer || ($obj->getContentType() == ilObjCmiXapi::CONT_TYPE_GENERIC) || $obj->isMixedContentType()) {
            $stage['$or'] = $this->getUsersStack();
        }
        
        return [
            '$match' => $stage
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildOrderStage()

ilCmiXapiHighscoreReportLinkBuilder::buildOrderStage ( )

protected

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

Referenced by buildPipeline().

    {
        return [ '$sort' => [
            'statement.timestamp' => 1
        ]];
    }

Here is the caller graph for this function:

buildPipeline()

ilCmiXapiHighscoreReportLinkBuilder::buildPipeline ( )

protected

Returns

array

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

References ilCmiXapiAbstractReportLinkBuilder\$obj, buildFilterStage(), buildOrderStage(), ilObjCmiXapi\CONT_TYPE_CMI5, ilObjCmiXapi\CONT_TYPE_GENERIC, and ilCmiXapiAbstractReportLinkBuilder\getObj().

Referenced by getPipelineDebug().

                                       : array
    {
        $pipeline = [];
        
        $pipeline[] = $this->buildFilterStage();
        $pipeline[] = $this->buildOrderStage();

        
        $obj = $this->getObj();
        $id = null;
        if ($obj instanceof ilObjLTIConsumer || $obj->getContentType() == ilObjCmiXapi::CONT_TYPE_GENERIC) {
            $id = '$statement.actor.mbox';
        }
        if ($obj instanceof ilObjCmiXapi && $obj->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5 && !$obj->isMixedContentType()) {
            $id = '$statement.actor.account.name';
        }
        $pipeline[] = ['$group' => [
            '_id' => $id,
            'mbox' => [ '$last' => '$statement.actor.mbox' ],
            'account' => [ '$last' => '$statement.actor.account.name'],
            'username' => [ '$last' => '$statement.actor.name' ],
            'timestamp' => [ '$last' => '$statement.timestamp' ],
            'duration' => [ '$push' => '$statement.result.duration' ],
            'score' => [ '$last' => '$statement.result.score' ]
        ]];
        return $pipeline;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPipelineDebug()

ilCmiXapiHighscoreReportLinkBuilder::getPipelineDebug

(

)

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

References buildPipeline().

    {
        return '<pre>' . json_encode($this->buildPipeline(), JSON_PRETTY_PRINT) . '</pre>';
    }

Here is the call graph for this function:

getUsersStack()

ilCmiXapiHighscoreReportLinkBuilder::getUsersStack ( )

protected

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

References ilCmiXapiAbstractReportLinkBuilder\$obj, ilCmiXapiAbstractReportLinkBuilder\getObj(), ilCmiXapiAbstractReportLinkBuilder\getObjId(), and ilCmiXapiUser\getUsersForObject().

Referenced by buildFilterStage().

    {
        $users = [];
        $obj = $this->getObj();
        if ($obj instanceof ilObjCmiXapi && $obj->isMixedContentType()) {
            foreach (ilCmiXapiUser::getUsersForObject($this->getObjId()) as $cmixUser) {
                $users[] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
                $users[] = ['statement.actor.account.name' => "{$cmixUser->getUsrIdent()}"];
            }
        } else {
            foreach (ilCmiXapiUser::getUsersForObject($this->getObjId()) as $cmixUser) {
                $users[] = [
                    'statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"
                ];
            }
        }
        return $users;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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