ILIAS\Course\Grouping\Table\AssignmentRetrieval Class Reference

Inheritance diagram for ILIAS\Course\Grouping\Table\AssignmentRetrieval:

Collaboration diagram for ILIAS\Course\Grouping\Table\AssignmentRetrieval:

Public Member Functions
	__construct (protected int $content_obj_id, protected ilObjCourseGrouping $grouping, protected ilObjUser $user, protected ilTree $tree, protected UIFactory $ui_factory, protected ilLanguage $lng, protected DataFactory $data_factory)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...
	getAllEligibleRefIDs ()

Protected Member Functions
	buildPath (ReferenceId $ref_id)
	sortRecords (array $records, Order $order)

Detailed Description

Definition at line 38 of file AssignmentRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Course\Grouping\Table\AssignmentRetrieval::__construct	(	protected int	$content_obj_id,
		protected ilObjCourseGrouping	$grouping,
		protected ilObjUser	$user,
		protected ilTree	$tree,
		protected UIFactory	$ui_factory,
		protected ilLanguage	$lng,
		protected DataFactory	$data_factory
	)

Definition at line 40 of file AssignmentRetrieval.php.

      {
    }

Member Function Documentation

buildPath()

ILIAS\Course\Grouping\Table\AssignmentRetrieval::buildPath ( ReferenceId  $ref_id )

protected

Definition at line 120 of file AssignmentRetrieval.php.

References ILIAS\Data\ReferenceId\toInt().

Referenced by ILIAS\Course\Grouping\Table\AssignmentRetrieval\getRows().

                                                     : string
    {
        $titles = [];
        foreach ($this->tree->getPathFull($ref_id->toInt()) as $step) {
            $titles[] = $step['title'];
        }
        return implode(' > ', $titles);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllEligibleRefIDs()

ILIAS\Course\Grouping\Table\AssignmentRetrieval::getAllEligibleRefIDs

(

)

Returns

ReferenceId[]

Definition at line 100 of file AssignmentRetrieval.php.

References ilUtil\_getObjectsByOperations(), ilObject\_lookupType(), and ILIAS\Repository\user().

Referenced by ILIAS\Course\Grouping\Table\AssignmentRetrieval\getRows(), and ILIAS\Course\Grouping\Table\AssignmentRetrieval\getTotalRowCount().

                                          : array
    {
        $type = ilObject::_lookupType($this->content_obj_id);
        $item_ref_ids = ilUtil::_getObjectsByOperations(
            $type,
            'write',
            $this->user->getId(),
            -1
        );

        $filtered_ref_ids = [];
        foreach ($item_ref_ids as $item_ref_id) {
            if ($this->tree->checkForParentType($item_ref_id, 'adm')) {
                continue;
            }
            $filtered_ref_ids[] = $this->data_factory->refId($item_ref_id);
        }
        return $filtered_ref_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRows()

ILIAS\Course\Grouping\Table\AssignmentRetrieval::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

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 51 of file AssignmentRetrieval.php.

References $ref_id, ilObject\_lookupTitle(), ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Course\Grouping\Table\AssignmentRetrieval\buildPath(), ILIAS\Course\Grouping\Table\AssignmentHandler\COL_ASSIGNED, ILIAS\Course\Grouping\Table\AssignmentHandler\COL_PATH, ILIAS\Course\Grouping\Table\AssignmentHandler\COL_TITLE, ILIAS\Course\Grouping\Table\AssignmentRetrieval\getAllEligibleRefIDs(), ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), ILIAS\Repository\lng(), and ILIAS\Course\Grouping\Table\AssignmentRetrieval\sortRecords().

     : Generator {
        $ref_ids = $this->getAllEligibleRefIDs();

        $assigned = $this->grouping->getAssignedItems();
        $assigned_ref_ids = [];
        foreach ($assigned as $item) {
            $assigned_ref_ids[] = $item['target_ref_id'];
        }

        $ok_icon = $this->ui_factory->symbol()->icon()->custom(
            'assets/images/standard/icon_ok.svg',
            $this->lng->txt('assigned')
        );

        $records = [];
        foreach ($ref_ids as $ref_id) {
            $record = [
                AssignmentHandler::COL_TITLE => ilObject::_lookupTitle($ref_id->toObjectId()->toInt()),
                AssignmentHandler::COL_PATH => $this->buildPath($ref_id),
            ];
            if (in_array($ref_id->toInt(), $assigned_ref_ids)) {
                $record[AssignmentHandler::COL_ASSIGNED] = $ok_icon;
            }
            $records[$ref_id->toInt()] = $record;
        }

        $records = $this->sortRecords($records, $order);
        $records = array_slice($records, $range->getStart(), $range->getLength(), true);

        foreach ($records as $ref_id => $record) {
            yield $row_builder->buildDataRow((string) $ref_id, $record);
        }
    }

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Course\Grouping\Table\AssignmentRetrieval::getTotalRowCount	(	?array	$filter_data,
		?array	$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 92 of file AssignmentRetrieval.php.

References ILIAS\Course\Grouping\Table\AssignmentRetrieval\getAllEligibleRefIDs().

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

Here is the call graph for this function:

sortRecords()

ILIAS\Course\Grouping\Table\AssignmentRetrieval::sortRecords ( array  $records, Order  $order  )

protected

Definition at line 129 of file AssignmentRetrieval.php.

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\Data\Order\ASC, ILIAS\Course\Grouping\Table\AssignmentHandler\COL_ASSIGNED, ILIAS\Course\Grouping\Table\AssignmentHandler\COL_PATH, ILIAS\Course\Grouping\Table\AssignmentHandler\COL_TITLE, and ILIAS\Data\Order\get().

Referenced by ILIAS\Course\Grouping\Table\AssignmentRetrieval\getRows().

                                                                : array
    {
        $order_field = array_keys($order->get())[0] ?? AssignmentHandler::COL_TITLE;
        $order_direction = $order->get()[$order_field] ?? Order::ASC;

        $ordering_callable_without_direction = match ($order_field) {
            AssignmentHandler::COL_TITLE, AssignmentHandler::COL_PATH =>
                fn($a, $b) => $a[$order_field] ?? '' <=> $b[$order_field] ?? '',
            AssignmentHandler::COL_ASSIGNED =>
                fn($a, $b) => isset($a[$order_field]) <=> isset($b[$order_field])
        };
        $ordering_callable = fn($a, $b) => $order_direction === Order::ASC ?
            $ordering_callable_without_direction($a, $b) :
            $ordering_callable_without_direction($b, $a);

        uasort($records, $ordering_callable);
        return $records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Course/classes/Grouping/Table/AssignmentRetrieval.php