ilLOTestAssignmentTableDataRetrieval Class Reference

Inheritance diagram for ilLOTestAssignmentTableDataRetrieval:

Collaboration diagram for ilLOTestAssignmentTableDataRetrieval:

Public Member Functions
	__construct (protected ilLanguage $lng, protected ilDBInterface $db, protected ilUIServices $ui_services, protected ilCtrl $ctrl, protected int $assignment_type)
	getRows (\ILIAS\UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, \ILIAS\Data\Range $range, \ILIAS\Data\Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...
	parseSingleAssignment (int $a_tst_ref_id, int $a_objective_id=0)
	parseMultipleAssignments (int $container_id, int $test_type)
	allIds ()
Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Protected Member Functions
	doParse (int $a_tst_ref_id, int $a_objective_id=0)

Protected Attributes
array	$data

Detailed Description

Definition at line 24 of file class.ilLOTestAssignmentTableDataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ilLOTestAssignmentTableDataRetrieval::__construct	(	protected ilLanguage	$lng,
		protected ilDBInterface	$db,
		protected ilUIServices	$ui_services,
		protected ilCtrl	$ctrl,
		protected int	$assignment_type
	)

Definition at line 28 of file class.ilLOTestAssignmentTableDataRetrieval.php.

      {
    }

Member Function Documentation

allIds()

ilLOTestAssignmentTableDataRetrieval::allIds

(

)

Definition at line 186 of file class.ilLOTestAssignmentTableDataRetrieval.php.

                            : array
    {
        $ids = [];
        foreach ($this->data as $assignment) {
            $id = $this->assignment_type === ilLOTestAssignmentTableGUI::TYPE_MULTIPLE_ASSIGNMENTS
                ? $assignment['assignment_id']
                : $assignment['ref_id'];
            $ids[] = $id;
        }
        return $ids;
    }

References $id, and ilLOTestAssignmentTableGUI\TYPE_MULTIPLE_ASSIGNMENTS.

doParse()

ilLOTestAssignmentTableDataRetrieval::doParse ( int  $a_tst_ref_id, int  $a_objective_id = 0  )

protected

Definition at line 101 of file class.ilLOTestAssignmentTableDataRetrieval.php.

     : array {
        $tst = ilObjectFactory::getInstanceByRefId($a_tst_ref_id, false);
        if (!$tst instanceof ilObjTest) {
            throw new ilLOInvalidConfigurationException('No valid test given');
        }
        $tst_data['ref_id'] = $tst->getRefId();
        $tst_data['title'] = $tst->getTitle();
        $tst_data['description'] = $tst->getLongDescription();
        $tst_data['ttype'] = $tst->getQuestionSetType();
        if ($this->assignment_type == ilLOTestAssignmentTableGUI::TYPE_MULTIPLE_ASSIGNMENTS) {
            $tst_data['objective'] = ilCourseObjective::lookupObjectiveTitle($a_objective_id);
        }
        switch ($tst->getQuestionSetType()) {
            case ilObjTest::QUESTION_SET_TYPE_FIXED:
                $tst_data['qst_info'] = $this->lng->txt('crs_loc_tst_num_qst');
                $tst_data['qst_info'] .= (' ' . count($tst->getAllQuestions()));
                break;
            default:
                // get available assiged question pools
                $list = new ilTestRandomQuestionSetSourcePoolDefinitionList(
                    $GLOBALS['DIC']['ilDB'],
                    $tst,
                    new ilTestRandomQuestionSetSourcePoolDefinitionFactory(
                        $GLOBALS['DIC']['ilDB'],
                        $tst
                    )
                );
                $list->loadDefinitions();
                // tax translations
                $translator = new ilTestQuestionFilterLabelTranslator($this->db, $this->lng);
                $translator->loadLabels($list);
                $tst_data['qst_info'] = $this->lng->txt('crs_loc_tst_qpls');
                $num = 0;
                foreach ($list as $definition) {
                    $title = $definition->getPoolTitle();
                    $filterTitle = [];
                    $filterTitle[] = $translator->getTaxonomyFilterLabel($definition->getMappedTaxonomyFilter());
                    $filterTitle[] = $translator->getTypeFilterLabel($definition->getTypeFilter());
                    if (!empty($filterTitle)) {
                        $title .= ' -> ' . implode(' / ', $filterTitle);
                    }
                    $tst_data['qpls'][] = $title;
                    ++$num;
                }
                if ($num === 0) {
                    $tst_data['qst_info'] .= (' ' . 0);
                }
                break;
        }
        return $tst_data;
    }

getRows()

ilLOTestAssignmentTableDataRetrieval::getRows	(	\ILIAS\UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		\ILIAS\Data\Range	$range,
		\ILIAS\Data\Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Definition at line 37 of file class.ilLOTestAssignmentTableDataRetrieval.php.

     : Generator {
        [$column_name, $direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        if ($column_name === ilLOTestAssignmentTableGUI::TABLE_COL_TITLE) {
            uasort($this->data, function ($a, $b) {
                return strcmp($a['title'], $b['title']);
            });
        }
        if ($direction === 'DESC') {
            $rows = array_reverse($this->data);
        } else {
            $rows = $this->data;
        }
        foreach ($rows as $row) {
            $id = $this->assignment_type === ilLOTestAssignmentTableGUI::TYPE_MULTIPLE_ASSIGNMENTS
                ? $row['assignment_id']
                : $row['ref_id'];
            $type = '';
            switch ($row['ttype']) {
                case ilObjTest::QUESTION_SET_TYPE_FIXED:
                    $type = $this->lng->txt('tst_question_set_type_fixed');
                    break;
 
                case ilObjTest::QUESTION_SET_TYPE_RANDOM:
                    $type = $this->lng->txt('tst_question_set_type_random');
                    break;
            }
            $this->ctrl->setParameterByClass('ilobjtestgui', 'ref_id', $row['ref_id']);
            $this->ctrl->setParameterByClass('ilobjtestgui', 'cmd', 'questionsTabGateway');
            $title_link = $this->ui_services->factory()->link()->standard($row['title'], $this->ctrl->getLinkTargetByClass('ilobjtestgui'));
            $data = [];
            $data[ilLOTestAssignmentTableGUI::TABLE_COL_TITLE] = $title_link;
            if ($this->assignment_type === ilLOTestAssignmentTableGUI::TYPE_MULTIPLE_ASSIGNMENTS) {
                $data[ilLOTestAssignmentTableGUI::TABLE_COL_COURSE_OBJECTIVES] = $row['objective'];
            }
            $data[ilLOTestAssignmentTableGUI::TABLE_COL_SELECTION_OF_TEST_QUESTIONS] = $type;
            $data[ilLOTestAssignmentTableGUI::TABLE_COL_QESTIONS] = $row['qst_info'];
 
            if (isset($row['qpls']) && count($row['qpls']) > 0) {
                $data[ilLOTestAssignmentTableGUI::TABLE_COL_QESTIONS] .= '<br>' . implode('<br>', $row['qpls']);
            }
 
            yield $row_builder->buildDataRow(
                $id . '',
                $data
            );
        }
    }

References Vendor\Package\$a, and Vendor\Package\$b.

getTotalRowCount()

ilLOTestAssignmentTableDataRetrieval::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 93 of file class.ilLOTestAssignmentTableDataRetrieval.php.

     : ?int {
        return count($this->data);
    }

parseMultipleAssignments()

ilLOTestAssignmentTableDataRetrieval::parseMultipleAssignments	(	int	$container_id,
		int	$test_type
	)

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

     : void {
        $assignments = ilLOTestAssignments::getInstance($container_id);
        $available = $assignments->getAssignmentsByType($test_type);
        $data = [];
        foreach ($available as $assignment) {
            try {
                $tmp = $this->doParse($assignment->getTestRefId(), $assignment->getObjectiveId());
            } catch (ilLOInvalidConfigurationException $e) {
                $assignment->delete();
                continue;
            }
            if ($tmp !== []) {
                // add assignment id
                $tmp['assignment_id'] = $assignment->getAssignmentId();
                $data[] = $tmp;
            }
        }
        $this->data = $data;
    }

References $data, and Vendor\Package\$e.

parseSingleAssignment()

ilLOTestAssignmentTableDataRetrieval::parseSingleAssignment	(	int	$a_tst_ref_id,
		int	$a_objective_id = 0
	)

Definition at line 156 of file class.ilLOTestAssignmentTableDataRetrieval.php.

     : void {
        $this->data = [$this->doParse($a_tst_ref_id, $a_objective_id)];
    }

Field Documentation

$data

array ilLOTestAssignmentTableDataRetrieval::$data

protected

Definition at line 26 of file class.ilLOTestAssignmentTableDataRetrieval.php.

---

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

• components/ILIAS/Course/classes/Objectives/class.ilLOTestAssignmentTableDataRetrieval.php