ILIAS\SystemCheck\Table\Group\DataRetrieval Class Reference

Inheritance diagram for ILIAS\SystemCheck\Table\Group\DataRetrieval:

Collaboration diagram for ILIAS\SystemCheck\Table\Group\DataRetrieval:

Public Member Functions
	__construct (protected readonly UIServices $ui, protected readonly ilCtrl $ctrl)
	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...
	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
	getSCGroups ()

Protected Attributes
array	$groups

Detailed Description

Definition at line 38 of file DataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\SystemCheck\Table\Group\DataRetrieval::__construct	(	protected readonly UIServices	$ui,
		protected readonly ilCtrl	$ctrl
	)

Definition at line 43 of file DataRetrieval.php.

      {
    }

Member Function Documentation

getRows()

ILIAS\SystemCheck\Table\Group\DataRetrieval::getRows ( DataRowBuilder  $row_builder, array  $visible_column_ids, Range  $range, Order  $order, mixed  $additional_viewcontrol_data, mixed  $filter_data, mixed  $additional_parameters  )

final

This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[]

$visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 57 of file DataRetrieval.php.

     : Generator {
        [$column_name, $direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        $titles = $descriptions = $last_updates = $complete = $failed = [];
        foreach ($this->getSCGroups() as $group) {
            $task_gui = ilSCComponentTaskFactory::getComponentTaskGUIForGroup($group->getId());
            $titles[$group->getId()] = $task_gui->getGroupTitle();
            $descriptions[$group->getId()] = $task_gui->getGroupDescription();
            $complete[$group->getId()] = ilSCTasks::lookupCompleted($group->getId());
            $failed[$group->getId()] = ilSCTasks::lookupFailed($group->getId());
            $last_updates[$group->getId()] = ilSCTasks::lookupLastUpdate($group->getId());
        }
        $comparator = match ($column_name) {
            Handler::TABLE_COL_TITLE => function (ilSCGroup $f1, ilSCGroup $f2) use ($titles) {
                return strcasecmp($titles[$f1->getId()], $titles[$f2->getId()]);
            },
            Handler::TABLE_COL_DESCRIPTION => function (ilSCGroup $f1, ilSCGroup $f2) use ($descriptions) {
                return strcasecmp($descriptions[$f1->getId()], $descriptions[$f2->getId()]);
            },
            Handler::TABLE_COL_LAST_UPDATE => function (ilSCGroup $f1, ilSCGroup $f2) use ($last_updates) {
                if (ilDateTime::_equals($last_updates[$f1->getId()], $last_updates[$f2->getId()])) {
                    return 0;
                }
                return ilDateTime::_before($last_updates[$f1->getId()], $last_updates[$f2->getId()]) ? -1 : 1;
            },
            Handler::TABLE_COL_SOLVED_TASKS => function (ilSCGroup $f1, ilSCGroup $f2) use ($complete) {
                return $complete[$f1->getId()] - $complete[$f2->getId()];
            },
            Handler::TABLE_COL_UNSOLVED_TASKS => function (ilSCGroup $f1, ilSCGroup $f2) use ($failed) {
                return $failed[$f1->getId()] - $failed[$f2->getId()];
            },
            default => fn(ilSCGroup $f1, ilSCGroup $f2) => 0
        };
        $sc_groups = $this->getSCGroups();
        uasort($sc_groups, $comparator);
        if ($direction === "DESC") {
            $sc_groups = array_reverse($sc_groups, true);
        }
        $sc_groups = array_slice($sc_groups, $range->getStart(), $range->getLength(), true);
        foreach ($sc_groups as $sc_group) {
            $this->ctrl->setParameterByClass(ilObjSystemCheckGUI::class, 'grp_id', $sc_group->getId());
            $link = $this->ctrl->getLinkTargetByClass(ilObjSystemCheckGUI::class, 'showGroup');
            $this->ctrl->clearParameterByClass(ilObjSystemCheckGUI::class, 'grp_id');
            yield $row_builder->buildDataRow(
                $sc_group->getId() . '',
                [
                    Handler::TABLE_COL_TITLE => $this->ui->factory()->link()->standard($titles[$sc_group->getId()], $link),
                    Handler::TABLE_COL_DESCRIPTION => $descriptions[$sc_group->getId()],
                    Handler::TABLE_COL_LAST_UPDATE => ilDatePresentation::formatDate($last_updates[$sc_group->getId()]),
                    Handler::TABLE_COL_SOLVED_TASKS => $complete[$sc_group->getId()],
                    Handler::TABLE_COL_UNSOLVED_TASKS => $failed[$sc_group->getId()],
                ]
            );
        }
    }

References ilSCComponentTaskFactory\getComponentTaskGUIForGroup(), ilSCTasks\lookupCompleted(), ilSCTasks\lookupFailed(), and ilSCTasks\lookupLastUpdate().

Here is the call graph for this function:

getSCGroups()

ILIAS\SystemCheck\Table\Group\DataRetrieval::getSCGroups ( )

finalprotected

Returns

ilSCGroup[]

Definition at line 52 of file DataRetrieval.php.

                                          : array
    {
        return $this->groups ??= ilSCGroups::getInstance()->getGroups();
    }

References ilSCGroups\getInstance().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\SystemCheck\Table\Group\DataRetrieval::getTotalRowCount ( mixed  $additional_viewcontrol_data, mixed  $filter_data, mixed  $additional_parameters  )

final

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 120 of file DataRetrieval.php.

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

Field Documentation

$groups

array ILIAS\SystemCheck\Table\Group\DataRetrieval::$groups

protected

Definition at line 41 of file DataRetrieval.php.

---

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

• components/ILIAS/SystemCheck/classes/Table/Group/DataRetrieval.php