ilLTIConsumerXapiStatementsGUI Class Reference

Collaboration diagram for ilLTIConsumerXapiStatementsGUI:

Public Member Functions
	__construct (ilObjLTIConsumer $object)
	executeCommand ()
	asyncUserAutocompleteCmd ()

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.ilLTIConsumerXapiStatementsGUI.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumerXapiStatementsGUI::__construct

(

ilObjLTIConsumer

$object

)

Parameters

ilObjLTIConsumer

$object

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

References $object, and ilLTIConsumerAccess\getInstance().

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

Here is the call graph for this function:

Member Function Documentation

applyFilterCmd()

ilLTIConsumerXapiStatementsGUI::applyFilterCmd ( )

protected

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

References buildTableGUI(), and showCmd().

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

Here is the call graph for this function:

asyncUserAutocompleteCmd()

ilLTIConsumerXapiStatementsGUI::asyncUserAutocompleteCmd

(

)

Definition at line 153 of file class.ilLTIConsumerXapiStatementsGUI.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()

ilLTIConsumerXapiStatementsGUI::buildTableGUI ( )

protected

Returns

ilCmiXapiStatementsTableGUI

Definition at line 205 of file class.ilLTIConsumerXapiStatementsGUI.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()

ilLTIConsumerXapiStatementsGUI::executeCommand

(

)

Exceptions

ilCmiXapiException

Definition at line 40 of file class.ilLTIConsumerXapiStatementsGUI.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}();
        }
    }

initActorFilter()

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

protected

Definition at line 108 of file class.ilLTIConsumerXapiStatementsGUI.php.

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

Referenced by showCmd().

    {
        global $DIC; /* @var \ILIAS\DI\Container $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->getProvider()->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->getProvider()->getPrivacyIdent()));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initLimitingAndOrdering()

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

protected

Definition at line 97 of file class.ilLTIConsumerXapiStatementsGUI.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()

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

protected

Definition at line 140 of file class.ilLTIConsumerXapiStatementsGUI.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()

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

protected

Parameters

ilCmiXapiStatementsTableGUI	$table
ilCmiXapiStatementsReportFilter	$filter

Definition at line 173 of file class.ilLTIConsumerXapiStatementsGUI.php.

References ilCmiXapiLrsType\buildBasicAuth(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Referenced by showCmd().

    {
        $aggregateEndPointUrl = str_replace(
            'data/xAPI',
            'api/statements/aggregate',
            $this->object->getProvider()->getXapiLaunchUrl() // should be named endpoint not launch url
        );

        $linkBuilder = new ilCmiXapiStatementsReportLinkBuilder(
            $this->object,
            $aggregateEndPointUrl,
            $filter
        );

        $basicAuth = ilCmiXapiLrsType::buildBasicAuth(
            $this->object->getProvider()->getXapiLaunchKey(),
            $this->object->getProvider()->getXapiLaunchSecret()
        );

        $request = new ilCmiXapiStatementsReportRequest(
            $basicAuth,
            $linkBuilder
        );

        $statementsReport = $request->queryReport($this->object);
        $table->setData($statementsReport->getTableData());
        $table->setMaxCount($statementsReport->getMaxCount());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initVerbFilter()

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

protected

Definition at line 131 of file class.ilLTIConsumerXapiStatementsGUI.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()

ilLTIConsumerXapiStatementsGUI::resetFilterCmd ( )

protected

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

References buildTableGUI(), and showCmd().

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

Here is the call graph for this function:

showCmd()

ilLTIConsumerXapiStatementsGUI::showCmd ( )

protected

Definition at line 71 of file class.ilLTIConsumerXapiStatementsGUI.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

ilLTIConsumerXapiStatementsGUI::$access

protected

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

$object

ilLTIConsumerXapiStatementsGUI::$object

protected

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

Referenced by __construct().

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerXapiStatementsGUI.php