ILIAS\SystemCheck\Table\Task\DataRetrieval Class Reference

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

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

Public Member Functions
	__construct (protected readonly int $group_id)
	getSCTasks ()
	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...
	getAllActions ()
	getSCTasks ()
	getAllActions ()
	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
	getInactiveActions (ilSCTask $task)

Protected Attributes
array	$sc_tasks
array	$actions

Detailed Description

Definition at line 36 of file DataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\SystemCheck\Table\Task\DataRetrieval::__construct

(

protected readonly int

$group_id

)

Definition at line 43 of file DataRetrieval.php.

      {
    }

Member Function Documentation

getAllActions()

ILIAS\SystemCheck\Table\Task\DataRetrieval::getAllActions ( )

final

Returns

array<string, string>

Implements ILIAS\SystemCheck\I\Table\Task\DataRetrievalInterface.

Definition at line 135 of file DataRetrieval.php.

                                         : array
    {
        if (isset($this->actions)) {
            return $this->actions;
        }
        $this->actions = [];
        foreach ($this->getSCTasks() as $task) {
            $task_gui = ilSCComponentTaskFactory::getComponentTask($task->getId());
            foreach ($task_gui->getActions() as $action) {
                $this->actions[$action['command']] = $action['txt'];
            }
        }
        return $this->actions;
    }

References ilSCComponentTaskFactory\getComponentTask().

Here is the call graph for this function:

getInactiveActions()

ILIAS\SystemCheck\Table\Task\DataRetrieval::getInactiveActions ( ilSCTask  $task )

finalprotected

Definition at line 150 of file DataRetrieval.php.

     : array {
        $active_actions = [];
        $task_gui = ilSCComponentTaskFactory::getComponentTask($task->getId());
        foreach ($task_gui->getActions() as $action) {
            $active_actions[$action['command']] = $action['txt'];
        }
        return array_diff(array_keys($this->getAllActions()), array_keys($active_actions));
    }

getRows()

ILIAS\SystemCheck\Table\Task\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 67 of file DataRetrieval.php.

     : Generator {
        [$column_name, $direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        $titles = $descriptions = $last_updates = $status = [];
        foreach ($this->getSCTasks() as $task) {
            $task_handler = ilSCComponentTaskFactory::getComponentTask($task->getId());
            $titles[$task->getId()] = $task_handler->getTitle();
            $descriptions[$task->getId()] = $task_handler->getDescription();
            $last_updates[$task->getId()] = $task->getLastUpdate();
            $status[$task->getId()] = $task->getStatus();
        }
        $comparator = match ($column_name) {
            Handler::TABLE_COL_TITLE => function (ilSCTask $f1, ilSCTask $f2) use ($titles) {
                return strcasecmp($titles[$f1->getId()], $titles[$f2->getId()]);
            },
            Handler::TABLE_COL_DESCRIPTION => function (ilSCTask $f1, ilSCTask $f2) use ($descriptions) {
                return strcasecmp($descriptions[$f1->getId()], $descriptions[$f2->getId()]);
            },
            Handler::TABLE_COL_LAST_UPDATE => function (ilSCTask $f1, ilSCTask $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_STATUS => function (ilSCTask $f1, ilSCTask $f2) use ($status) {
                return $status[$f1->getId()] - $status[$f2->getId()];
            },
            default => fn(ilSCTask $f1, ilSCTask $f2) => 0
        };
        $sc_tasks = $this->getSCTasks();
        uasort($sc_tasks, $comparator);
        if ($direction === "DESC") {
            $sc_tasks = array_reverse($sc_tasks, true);
        }
        $sc_tasks = array_slice($sc_tasks, $range->getStart(), $range->getLength(), true);
        foreach ($sc_tasks as $sc_task) {
            $data_row = $row_builder->buildDataRow(
                (string) $sc_task->getId(),
                [
                    Handler::TABLE_COL_TITLE => $titles[$sc_task->getId()],
                    Handler::TABLE_COL_DESCRIPTION => $descriptions[$sc_task->getId()],
                    Handler::TABLE_COL_LAST_UPDATE => ilDatePresentation::formatDate($last_updates[$sc_task->getId()]),
                    Handler::TABLE_COL_STATUS => ilSCUtils::taskStatus2Text($status[$sc_task->getId()])
                ]
            );
            foreach ($this->getInactiveActions($sc_task) as $action_name) {
                $data_row = $data_row->withDisabledAction($action_name);
            }
            yield $data_row;
        }
    }

References ilSCComponentTaskFactory\getComponentTask().

Here is the call graph for this function:

getSCTasks()

ILIAS\SystemCheck\Table\Task\DataRetrieval::getSCTasks ( )

final

Returns

ilSCTask[]

Implements ILIAS\SystemCheck\I\Table\Task\DataRetrievalInterface.

Definition at line 51 of file DataRetrieval.php.

                                      : array
    {
        if (isset($this->sc_tasks)) {
            return $this->sc_tasks;
        }
 
        $this->sc_tasks = [];
        foreach (ilSCTasks::getInstanceByGroupId($this->group_id)->getTasks() as $task) {
            if (!$task->isActive()) {
                continue;
            }
            $this->sc_tasks[$task->getId()] = $task;
        }
        return $this->sc_tasks;
    }

References ILIAS\SystemCheck\Table\Task\DataRetrieval\$sc_tasks, and ilSCTasks\getInstanceByGroupId().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\SystemCheck\Table\Task\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 126 of file DataRetrieval.php.

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

Field Documentation

$actions

array ILIAS\SystemCheck\Table\Task\DataRetrieval::$actions

protected

Definition at line 41 of file DataRetrieval.php.

$sc_tasks

array ILIAS\SystemCheck\Table\Task\DataRetrieval::$sc_tasks

protected

Definition at line 39 of file DataRetrieval.php.

Referenced by ILIAS\SystemCheck\Table\Task\DataRetrieval\getSCTasks().

---

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

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