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
ilObjLTIConsumer	$object
ilLTIConsumerAccess	$access

Private Attributes
ilGlobalTemplateInterface	$main_tpl
ILIAS DI Container	$dic

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLTIConsumerXapiStatementsGUI::__construct

(

ilObjLTIConsumer

$object

)

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

References $DIC, $object, ILIAS\Repository\access(), and ilLTIConsumerAccess\getInstance().

    {
        global $DIC;
        $this->dic = $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $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 80 of file class.ilLTIConsumerXapiStatementsGUI.php.

References buildTableGUI(), and showCmd().

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

Here is the call graph for this function:

asyncUserAutocompleteCmd()

ilLTIConsumerXapiStatementsGUI::asyncUserAutocompleteCmd

(

)

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

References exit, ILIAS\Repository\object(), ilUserAutoComplete\setSearchFields(), and ilUtil\stripSlashes().

                                              : void
    {
        $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);
        $term = '';
        if ($this->dic->http()->wrapper()->query()->has('term')) {
            $term = $this->dic->http()->wrapper()->query()->retrieve('term', $this->dic->refinery()->kindlyTo()->string());
        } elseif ($this->dic->http()->wrapper()->post()->has('term')) {
            $term = $this->dic->http()->wrapper()->post()->retrieve('term', $this->dic->refinery()->kindlyTo()->string());
        }
        if ($term != '') {
            $result = json_decode($auto->getList(ilUtil::stripSlashes($term)), true);
            echo json_encode($result);
        }
        exit();
    }

Here is the call graph for this function:

buildTableGUI()

ilLTIConsumerXapiStatementsGUI::buildTableGUI ( )

protected

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

References ILIAS\Repository\access().

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 call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilLTIConsumerXapiStatementsGUI::executeCommand

(

)

Exceptions

ilCmiXapiException

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

References $DIC, and ILIAS\Repository\access().

                                    : void
    {
        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}();
        }
    }

Here is the call graph for this function:

initActorFilter()

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

protected

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

References $DIC, ILIAS\Repository\access(), ilTable2GUI\getFilterItemByPostVar(), ilObjUser\getUserIdByLogin(), ILIAS\Repository\object(), and ilCmiXapiStatementsReportFilter\setActor().

Referenced by showCmd().

                                                                                                                   : void
    {
        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 114 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().

                                                                                                                           : void
    {
        $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 157 of file class.ilLTIConsumerXapiStatementsGUI.php.

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

Referenced by showCmd().

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

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

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

Referenced by showCmd().

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

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

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

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

        $statementsReport = $request->queryReport($this->object->getId());
        $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 148 of file class.ilLTIConsumerXapiStatementsGUI.php.

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

Referenced by showCmd().

                                                                                                                  : void
    {
        $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 72 of file class.ilLTIConsumerXapiStatementsGUI.php.

References buildTableGUI(), and showCmd().

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

Here is the call graph for this function:

showCmd()

ilLTIConsumerXapiStatementsGUI::showCmd ( )

protected

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

References $DIC, Vendor\Package\$e, buildTableGUI(), initActorFilter(), initLimitingAndOrdering(), initPeriodFilter(), initTableData(), initVerbFilter(), and ILIAS\Repository\object().

Referenced by applyFilterCmd(), and resetFilterCmd().

                                : void
    {
        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) {
            $this->main_tpl->setOnScreenMessage('failure', $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

ilLTIConsumerAccess ilLTIConsumerXapiStatementsGUI::$access

protected

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

$dic

ILIAS DI Container ilLTIConsumerXapiStatementsGUI::$dic

private

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

$main_tpl

ilGlobalTemplateInterface ilLTIConsumerXapiStatementsGUI::$main_tpl

private

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

$object

ilObjLTIConsumer ilLTIConsumerXapiStatementsGUI::$object

protected

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

Referenced by __construct().

---

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

• components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerXapiStatementsGUI.php