ilLTIConsumerGradeSynchronizationGUI Class Reference

Collaboration diagram for ilLTIConsumerGradeSynchronizationGUI:

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

Protected Member Functions
	resetFilterCmd ()
	applyFilterCmd ()
	showCmd ()
	initLimitingAndOrdering (ilLTIConsumerGradeSynchronizationFilter $filter, ilLTIConsumerGradeSynchronizationTableGUI $table)
	initActorFilter (ilLTIConsumerGradeSynchronizationFilter $filter, ilLTIConsumerGradeSynchronizationTableGUI $table)
	initActivityProgressFilter (ilLTIConsumerGradeSynchronizationFilter $filter, ilLTIConsumerGradeSynchronizationTableGUI $table)
	initGradingProgressFilter (ilLTIConsumerGradeSynchronizationFilter $filter, ilLTIConsumerGradeSynchronizationTableGUI $table)
	initPeriodFilter (ilLTIConsumerGradeSynchronizationFilter $filter, ilLTIConsumerGradeSynchronizationTableGUI $table)
	initTableData (ilLTIConsumerGradeSynchronizationTableGUI $table, ilLTIConsumerGradeSynchronizationFilter $filter)
	buildTableGUI ()

Protected Attributes
ilObjLTIConsumer	$object
ilLTIConsumerAccess	$access

Private Attributes
ilGlobalTemplateInterface	$main_tpl
ILIAS DI Container	$dic

Detailed Description

Definition at line 29 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumerGradeSynchronizationGUI::__construct

(

ilObjLTIConsumer

$object

)

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

ilLTIConsumerGradeSynchronizationGUI::applyFilterCmd ( )

protected

Definition at line 74 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

References buildTableGUI(), and showCmd().

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

Here is the call graph for this function:

asyncUserAutocompleteCmd()

ilLTIConsumerGradeSynchronizationGUI::asyncUserAutocompleteCmd

(

)

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

ilLTIConsumerGradeSynchronizationGUI::buildTableGUI ( )

protected

Definition at line 233 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

References ILIAS\Repository\access().

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

                                      : ilLTIConsumerGradeSynchronizationTableGUI
    {
        $isMultiActorReport = $this->access->hasOutcomesAccess();

        $table = new ilLTIConsumerGradeSynchronizationTableGUI($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()

ilLTIConsumerGradeSynchronizationGUI::executeCommand

(

)

Exceptions

ilLtiConsumerException

Definition at line 50 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

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

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

        if (!$this->object->getProvider()->isGradeSynchronization()) {
            throw new ilLtiConsumerException('access denied!');
        }

        switch ($DIC->ctrl()->getNextClass($this)) {
            default:
                $cmd = $DIC->ctrl()->getCmd('show') . 'Cmd';
                $this->{$cmd}();
        }
        return true;
    }

Here is the call graph for this function:

initActivityProgressFilter()

ilLTIConsumerGradeSynchronizationGUI::initActivityProgressFilter ( ilLTIConsumerGradeSynchronizationFilter  $filter, ilLTIConsumerGradeSynchronizationTableGUI  $table  )

protected

Definition at line 141 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

References ilTable2GUI\getFilterItemByPostVar(), and ilLTIConsumerGradeSynchronizationFilter\setActivityProgress().

Referenced by showCmd().

                                                                                                                                                    : void
    {
        $activityProgress = urldecode($table->getFilterItemByPostVar('activity_progress')->getValue());

        $allowed = ['Initialized', 'Started', 'InProgress', 'Submitted', 'Completed'];

        if (in_array($activityProgress, $allowed)) {
            $filter->setActivityProgress($activityProgress);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initActorFilter()

ilLTIConsumerGradeSynchronizationGUI::initActorFilter ( ilLTIConsumerGradeSynchronizationFilter  $filter, ilLTIConsumerGradeSynchronizationTableGUI  $table  )

protected

Definition at line 118 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

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

Referenced by showCmd().

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

        if ($this->object->getProvider()->isGradeSynchronization()) {
            if ($table->getFilterItemByPostVar('actor') !== null) {
                $actor = $table->getFilterItemByPostVar('actor')->getValue();
            } else {
                $actor = $DIC->user()->getLogin();
            }

            if (strlen($actor)) {
                $usrId = ilObjUser::getUserIdByLogin($actor);

                if ($usrId) {
                    $filter->setActor($usrId);
                }
            }
        } else {
            $filter->setActor($DIC->user()->getId());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initGradingProgressFilter()

ilLTIConsumerGradeSynchronizationGUI::initGradingProgressFilter ( ilLTIConsumerGradeSynchronizationFilter  $filter, ilLTIConsumerGradeSynchronizationTableGUI  $table  )

protected

Definition at line 152 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

References ilTable2GUI\getFilterItemByPostVar(), and ilLTIConsumerGradeSynchronizationFilter\setGradingProgress().

Referenced by showCmd().

                                                                                                                                                   : void
    {
        $gradingProgress = urldecode($table->getFilterItemByPostVar('grading_progress')->getValue());

        $allowed = ['FullyGraded', 'Pending', 'PendingManual', 'Failed', 'NotReady'];

        if (in_array($gradingProgress, $allowed)) {
            $filter->setGradingProgress($gradingProgress);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initLimitingAndOrdering()

ilLTIConsumerGradeSynchronizationGUI::initLimitingAndOrdering ( ilLTIConsumerGradeSynchronizationFilter  $filter, ilLTIConsumerGradeSynchronizationTableGUI  $table  )

protected

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

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

Referenced by showCmd().

                                                                                                                                                 : void
    {
        $table->determineOffsetAndOrder(true);

        $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()

ilLTIConsumerGradeSynchronizationGUI::initPeriodFilter ( ilLTIConsumerGradeSynchronizationFilter  $filter, ilLTIConsumerGradeSynchronizationTableGUI  $table  )

protected

Definition at line 163 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

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

Referenced by showCmd().

                                                                                                                                          : void
    {
        $period = $table->getFilterItemByPostVar('period');

        if ($period->getStart()) {
            $filter->setStartDate($period->getStart());
        }

        if ($period->getEnd()) {
            $filter->setEndDate($period->getEnd());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTableData()

ilLTIConsumerGradeSynchronizationGUI::initTableData ( ilLTIConsumerGradeSynchronizationTableGUI  $table, ilLTIConsumerGradeSynchronizationFilter  $filter  )

protected

Definition at line 198 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

References $data, ILIAS\Repository\access(), ilLTIConsumerGradeSynchronizationFilter\getActivityProgress(), ilLTIConsumerGradeSynchronizationFilter\getActor(), ilLTIConsumerGradeSynchronizationFilter\getEndDate(), ilLTIConsumerGradeSynchronization\getGradesForObject(), ilLTIConsumerGradeSynchronizationFilter\getGradingProgress(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilLTIConsumerGradeSynchronizationFilter\getStartDate(), null, ILIAS\Repository\object(), ilTable2GUI\setData(), and ilArrayUtil\sortArray().

Referenced by showCmd().

                                                                                                                                       : void
    {
        $cUser = null;
        if (!$this->access->hasOutcomesAccess()) {
            $cUser = $this->dic->user()->getId();
        } else {
            $cUser = $filter->getActor();
        }
        $data = ilLTIConsumerGradeSynchronization::getGradesForObject(
            $this->object->getId(),
            $cUser,
            $filter->getActivityProgress(),
            $filter->getGradingProgress(),
            $filter->getStartDate(),
            $filter->getEndDate()
        );

        for ((int) $i = 0; $i < count($data); $i++) {
            $usr = new ilObjUser((int) $data[$i]['usr_id']);
            $data[$i]['actor'] = $usr->getFullname();
        }
        $sortNum = false;
        if ($table->getOrderField() == 'score_given') {
            $sortNum = true;
        }

        $data = ilArrayUtil::sortArray(
            $data,
            $table->getOrderField(),
            $table->getOrderDirection(),
            $sortNum
        );
        $table->setData($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilterCmd()

ilLTIConsumerGradeSynchronizationGUI::resetFilterCmd ( )

protected

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

References buildTableGUI(), and showCmd().

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

Here is the call graph for this function:

showCmd()

ilLTIConsumerGradeSynchronizationGUI::showCmd ( )

protected

Definition at line 82 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

References $DIC, Vendor\Package\$e, buildTableGUI(), initActivityProgressFilter(), initActorFilter(), initGradingProgressFilter(), initLimitingAndOrdering(), initPeriodFilter(), and initTableData().

Referenced by applyFilterCmd(), and resetFilterCmd().

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

        $table = $this->buildTableGUI();

        try {
            $statementsFilter = new ilLTIConsumerGradeSynchronizationFilter();

            $this->initLimitingAndOrdering($statementsFilter, $table);
            $this->initActorFilter($statementsFilter, $table);
            $this->initActivityProgressFilter($statementsFilter, $table);
            $this->initGradingProgressFilter($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 ilLTIConsumerGradeSynchronizationGUI::$access

protected

Definition at line 33 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

$dic

ILIAS DI Container ilLTIConsumerGradeSynchronizationGUI::$dic

private

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

$main_tpl

ilGlobalTemplateInterface ilLTIConsumerGradeSynchronizationGUI::$main_tpl

private

Definition at line 34 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

$object

ilObjLTIConsumer ilLTIConsumerGradeSynchronizationGUI::$object

protected

Definition at line 31 of file class.ilLTIConsumerGradeSynchronizationGUI.php.

Referenced by __construct().

---

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

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