ilCmiXapiStatementsGUI Class Reference

Collaboration diagram for ilCmiXapiStatementsGUI:

Public Member Functions
	__construct (ilObjCmiXapi $object)
	executeCommand ()
	asyncUserAutocompleteCmd ()
	getVerbs ()
	getVerbsPipline ()

Protected Member Functions
	resetFilterCmd ()
	applyFilterCmd ()
	showCmd ()
	initLimitingAndOrdering (ilCmiXapiStatementsReportFilter $filter, ilCmiXapiStatementsTableGUI $table)
	initActorFilter (ilCmiXapiStatementsReportFilter $filter, ilCmiXapiStatementsTableGUI $table)
	initVerbFilter (ilCmiXapiStatementsReportFilter $filter, ilCmiXapiStatementsTableGUI $table)
	initPeriodFilter (ilCmiXapiStatementsReportFilter $filter, ilCmiXapiStatementsTableGUI $table)
	initTableData (ilCmiXapiStatementsTableGUI $table, ilCmiXapiStatementsReportFilter $filter)
	buildTableGUI ()

Protected Attributes
	$object
	$access

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiStatementsGUI::__construct

(

ilObjCmiXapi

$object

)

Parameters

ilObjCmiXapi

$object

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

References $object, and ilCmiXapiAccess\getInstance().

    {
        $this->object = $object;
        
        $this->access = ilCmiXapiAccess::getInstance($this->object);
    }

Here is the call graph for this function:

Member Function Documentation

applyFilterCmd()

ilCmiXapiStatementsGUI::applyFilterCmd ( )

protected

Definition at line 63 of file class.ilCmiXapiStatementsGUI.php.

References buildTableGUI(), and showCmd().

    {
        $table = $this->buildTableGUI();
        $table->writeFilterToSession();
        $table->resetOffset();
        $this->showCmd();
    }

Here is the call graph for this function:

asyncUserAutocompleteCmd()

ilCmiXapiStatementsGUI::asyncUserAutocompleteCmd

(

)

Definition at line 149 of file class.ilCmiXapiStatementsGUI.php.

References $result, exit, ilUserAutoComplete\setSearchFields(), and ilUtil\stripSlashes().

    {
        $auto = new ilCmiXapiUserAutocomplete($this->object->getId());
        $auto->setSearchFields(array('login','firstname','lastname','email'));
        $auto->setResultField('login');
        $auto->enableFieldSearchableCheck(true);
        $auto->setMoreLinkAvailable(true);
        
        //$auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        
        $result = json_decode($auto->getList(ilUtil::stripSlashes($_REQUEST['term'])), true);
        
        echo json_encode($result);
        exit();
    }

Here is the call graph for this function:

buildTableGUI()

ilCmiXapiStatementsGUI::buildTableGUI ( )

protected

Returns

ilCmiXapiStatementsTableGUI

Definition at line 208 of file class.ilCmiXapiStatementsGUI.php.

Referenced by applyFilterCmd(), resetFilterCmd(), and showCmd().

                                       : ilCmiXapiStatementsTableGUI
    {
        $isMultiActorReport = $this->access->hasOutcomesAccess();
        $table = new ilCmiXapiStatementsTableGUI($this, 'show', $isMultiActorReport);
        $table->setFilterCommand('applyFilter');
        $table->setResetCommand('resetFilter');
        return $table;
    }

Here is the caller graph for this function:

executeCommand()

ilCmiXapiStatementsGUI::executeCommand

(

)

Exceptions

ilCmiXapiException

Definition at line 40 of file class.ilCmiXapiStatementsGUI.php.

References $DIC.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if (!$this->access->hasStatementsAccess()) {
            throw new ilCmiXapiException('access denied!');
        }
        
        switch ($DIC->ctrl()->getNextClass($this)) {
            default:
                $cmd = $DIC->ctrl()->getCmd('show') . 'Cmd';
                $this->{$cmd}();
        }
    }

getVerbs()

ilCmiXapiStatementsGUI::getVerbs

(

)

Definition at line 218 of file class.ilCmiXapiStatementsGUI.php.

References $client, $DIC, Vendor\Package\$e, ilCmiXapiAbstractRequest\checkResponse(), and getVerbsPipline().

    {
        global $DIC;
        $lrsType = $this->object->getLrsType();

        //$this->getLrsEndpoint())) . '/api/' . self::ENDPOINT_AGGREGATE_SUFFIX;
        $defaultLrs = $lrsType->getLrsEndpointStatementsAggregationLink();
        //$fallbackLrs = $lrsType->getLrsFallbackEndpoint();
        $defaultBasicAuth = $lrsType->getBasicAuth();
        //$fallbackBasicAuth = $lrsType->getFallbackBasicAuth();
        $defaultHeaders = [
            'X-Experience-API-Version' => '1.0.3',
            'Authorization' => $defaultBasicAuth,
            'Cache-Control' => 'no-cache, no-store, must-revalidate'
        ];
//        $fallbackHeaders = [
//            'X-Experience-API-Version' => '1.0.3',
//            'Authorization' => $fallbackBasicAuth,
//            'Content-Type' => 'application/json;charset=utf-8',
//            'Cache-Control' => 'no-cache, no-store, must-revalidate'
//        ];
        $pipeline = json_encode($this->getVerbsPipline());
//        $pipeline2 = json_encode($this->getVerbsPipline(),JSON_PRETTY_PRINT);
        //$DIC->logger()->root()->log($pipeline2);

        $defaultVerbsUrl = $defaultLrs . "?pipeline=" . urlencode($pipeline);
        //$DIC->logger()->root()->log($defaultVerbsUrl);

        $client = new GuzzleHttp\Client();
        $req_opts = array(
            GuzzleHttp\RequestOptions::VERIFY => true,
            GuzzleHttp\RequestOptions::CONNECT_TIMEOUT => 10,
            GuzzleHttp\RequestOptions::HTTP_ERRORS => false
        );
        //new GuzzleHttp\Psr7\Request('POST', $defaultUrl, $this->defaultHeaders, $body);
        $defaultVerbsRequest = new GuzzleHttp\Psr7\Request(
            'GET',
            $defaultVerbsUrl,
            $defaultHeaders
        );
        $promises = array();
        $promises['defaultVerbs'] = $client->sendAsync($defaultVerbsRequest, $req_opts);
        try
        {
            $responses = GuzzleHttp\Promise\Utils::settle($promises)->wait();
            $body = '';
            //$DIC->logger()->root()->log(var_export($responses['defaultVerbs'],TRUE));
            ilCmiXapiAbstractRequest::checkResponse($responses['defaultVerbs'],$body,[200]);
            return json_decode($body,JSON_OBJECT_AS_ARRAY);
        }
        catch(Exception $e)
        {
            $this->log()->error('error:' . $e->getMessage());
            return null;
        }
        return null;
    }

Here is the call graph for this function:

getVerbsPipline()

ilCmiXapiStatementsGUI::getVerbsPipline

(

)

Definition at line 276 of file class.ilCmiXapiStatementsGUI.php.

References $DIC, and ilObjCmiXapi\CONT_TYPE_CMI5.

Referenced by getVerbs().

    {
        global $DIC;
        $pipeline = array();
        
        // filter activityId
        $match = array();
        $match['statement.object.objectType'] = 'Activity';
        $match['statement.actor.objectType'] = 'Agent';
        
        $activityId = array();

        if ($this->object->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5 && !$this->object->isMixedContentType())
        {
            // https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#963-extensions
            $activityId['statement.context.extensions.https://ilias&46;de/cmi5/activityid'] = $this->object->getActivityId();
        }
        else
        {
            $activityQuery = [
                '$regex' => '^' . preg_quote($this->object->getActivityId()) . ''
            ];
            $activityId['$or'] = [];
            $activityId['$or'][] = ['statement.object.id' => $activityQuery];
            $activityId['$or'][] = ['statement.context.contextActivities.parent.id' => $activityQuery];
        }
        $match['$and'] = [];
        $match['$and'][] = $activityId;
        
        $sort = array();
        $sort['statement.verb.id'] = 1;

        // project distinct verbs
        $group = array('_id' => '$statement.verb.id');
        // $project = array('statement.verb.id' => 1);   
        // project distinct verbs
        
        $pipeline[] = array('$match' => $match);
        $pipeline[] = array('$group' => $group);
        $pipeline[] = array('$sort' => $sort);
        //$pipeline[] = array('$project' => $project);

        return $pipeline;
    }

Here is the caller graph for this function:

initActorFilter()

ilCmiXapiStatementsGUI::initActorFilter ( ilCmiXapiStatementsReportFilter  $filter, ilCmiXapiStatementsTableGUI  $table  )

protected

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

References $DIC, ilTable2GUI\getFilterItemByPostVar(), ilObjUser\getUserIdByLogin(), and ilCmiXapiStatementsReportFilter\setActor().

Referenced by showCmd().

    {
        global $DIC;
        if ($this->access->hasOutcomesAccess()) {
            $actor = $table->getFilterItemByPostVar('actor')->getValue();
            if (strlen($actor)) {
                $usrId = ilObjUser::getUserIdByLogin($actor);
                if ($usrId) {
                    $filter->setActor(new ilCmiXapiUser($this->object->getId(), $usrId, $this->object->getPrivacyIdent()));
                } else {
                    throw new ilCmiXapiInvalidStatementsFilterException(
                        "given actor ({$actor}) is not a valid actor for object ({$this->object->getId()})"
                    );
                }
            }
        } else {
            $filter->setActor(new ilCmiXapiUser($this->object->getId(), $DIC->user()->getId(), $this->object->getPrivacyIdent()));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initLimitingAndOrdering()

ilCmiXapiStatementsGUI::initLimitingAndOrdering ( ilCmiXapiStatementsReportFilter  $filter, ilCmiXapiStatementsTableGUI  $table  )

protected

Definition at line 96 of file class.ilCmiXapiStatementsGUI.php.

References ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilCmiXapiStatementsReportFilter\setLimit(), ilCmiXapiStatementsReportFilter\setOffset(), ilCmiXapiStatementsReportFilter\setOrderDirection(), and ilCmiXapiStatementsReportFilter\setOrderField().

Referenced by showCmd().

    {
        $table->determineOffsetAndOrder();
        
        $filter->setLimit($table->getLimit());
        $filter->setOffset($table->getOffset());
        
        $filter->setOrderField($table->getOrderField());
        $filter->setOrderDirection($table->getOrderDirection());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPeriodFilter()

ilCmiXapiStatementsGUI::initPeriodFilter ( ilCmiXapiStatementsReportFilter  $filter, ilCmiXapiStatementsTableGUI  $table  )

protected

Definition at line 136 of file class.ilCmiXapiStatementsGUI.php.

References ilTable2GUI\getFilterItemByPostVar(), ilCmiXapiStatementsReportFilter\setEndDate(), and ilCmiXapiStatementsReportFilter\setStartDate().

Referenced by showCmd().

    {
        $period = $table->getFilterItemByPostVar('period');
        
        if ($period->getStartXapiDateTime()) {
            $filter->setStartDate($period->getStartXapiDateTime());
        }
        
        if ($period->getEndXapiDateTime()) {
            $filter->setEndDate($period->getEndXapiDateTime());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTableData()

ilCmiXapiStatementsGUI::initTableData ( ilCmiXapiStatementsTableGUI  $table, ilCmiXapiStatementsReportFilter  $filter  )

protected

Parameters

ilCmiXapiStatementsTableGUI	$table
ilCmiXapiStatementsReportFilter	$filter

Definition at line 169 of file class.ilCmiXapiStatementsGUI.php.

References $data, $DIC, ilCmiXapiUser\getUsersForObject(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Referenced by showCmd().

    {
        global $DIC;
        if ($this->access->hasOutcomesAccess()) {
            if (!ilCmiXapiUser::getUsersForObject($this->object->getId())) {
                $table->setData(array());
                $table->setMaxCount(0);
                $table->resetOffset();
                return;
            }
        }
        else {
            $usrId = $DIC->user()->getId();
            if (!ilCmiXapiUser::getUsersForObject($this->object->getId(),$usrId)) {
                $table->setData(array());
                $table->setMaxCount(0);
                $table->resetOffset();
                return;
            }
        }
        $linkBuilder = new ilCmiXapiStatementsReportLinkBuilder(
            $this->object,
            $this->object->getLrsType()->getLrsEndpointStatementsAggregationLink(),
            $filter
        );
        
        $request = new ilCmiXapiStatementsReportRequest(
            $this->object->getLrsType()->getBasicAuth(),
            $linkBuilder
        );
        $statementsReport = $request->queryReport($this->object);
        $data = $statementsReport->getTableData();
        $table->setData($data);
        $table->setMaxCount($statementsReport->getMaxCount());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initVerbFilter()

ilCmiXapiStatementsGUI::initVerbFilter ( ilCmiXapiStatementsReportFilter  $filter, ilCmiXapiStatementsTableGUI  $table  )

protected

Definition at line 127 of file class.ilCmiXapiStatementsGUI.php.

References ilTable2GUI\getFilterItemByPostVar(), ilCmiXapiVerbList\getInstance(), and ilCmiXapiStatementsReportFilter\setVerb().

Referenced by showCmd().

    {
        $verb = urldecode($table->getFilterItemByPostVar('verb')->getValue());
        
        if (ilCmiXapiVerbList::getInstance()->isValidVerb($verb)) {
            $filter->setVerb($verb);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilterCmd()

ilCmiXapiStatementsGUI::resetFilterCmd ( )

protected

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

References buildTableGUI(), and showCmd().

    {
        $table = $this->buildTableGUI();
        $table->resetFilter();
        $table->resetOffset();
        $this->showCmd();
    }

Here is the call graph for this function:

showCmd()

ilCmiXapiStatementsGUI::showCmd ( )

protected

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

References $DIC, Vendor\Package\$e, buildTableGUI(), initActorFilter(), initLimitingAndOrdering(), initPeriodFilter(), initTableData(), initVerbFilter(), and ilUtil\sendFailure().

Referenced by applyFilterCmd(), and resetFilterCmd().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        $table = $this->buildTableGUI();
        
        try {
            $statementsFilter = new ilCmiXapiStatementsReportFilter();
            $statementsFilter->setActivityId($this->object->getActivityId());
            $this->initLimitingAndOrdering($statementsFilter, $table);
            $this->initActorFilter($statementsFilter, $table);
            $this->initVerbFilter($statementsFilter, $table);
            $this->initPeriodFilter($statementsFilter, $table);
            
            $this->initTableData($table, $statementsFilter);
        } catch (Exception $e) {
            ilUtil::sendFailure($e->getMessage());
            $table->setData(array());
            $table->setMaxCount(0);
            $table->resetOffset();
        }
        
        $DIC->ui()->mainTemplate()->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilCmiXapiStatementsGUI::$access

protected

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

$object

ilCmiXapiStatementsGUI::$object

protected

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

Referenced by __construct().

---

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

• Modules/CmiXapi/classes/class.ilCmiXapiStatementsGUI.php