ILIAS\Course\Grouping\Table\GroupingRetrieval Class Reference

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

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

Public Member Functions
	__construct (protected int $content_obj_id, protected ilLanguage $lng, protected UIFactory $ui_factory, protected DataFactory $data_factory, protected StaticURL $static_url)
	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...
	getAllGroupingIDs ()
	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
	buildLinkToObject (int $ref_id)
	buildLinkListing (int ... $ref_ids)
	sortRecords (array $records, Order $order)

Detailed Description

Definition at line 39 of file GroupingRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Course\Grouping\Table\GroupingRetrieval::__construct	(	protected int	$content_obj_id,
		protected ilLanguage	$lng,
		protected UIFactory	$ui_factory,
		protected DataFactory	$data_factory,
		protected StaticURL	$static_url
	)

Definition at line 41 of file GroupingRetrieval.php.

      {
    }

Member Function Documentation

buildLinkListing()

ILIAS\Course\Grouping\Table\GroupingRetrieval::buildLinkListing ( int ...  $ref_ids )

protected

Definition at line 121 of file GroupingRetrieval.php.

                                                        : UnorderedListing
    {
        $links = [];
        foreach ($ref_ids as $ref_id) {
            $link = $this->buildLinkToObject($ref_id);
            if ($link !== null) {
                $links[] = $link;
            }
        }
        return $this->ui_factory->listing()->unordered($links);
    }

References $ref_id.

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

Here is the caller graph for this function:

buildLinkToObject()

ILIAS\Course\Grouping\Table\GroupingRetrieval::buildLinkToObject ( int  $ref_id )

protected

Definition at line 109 of file GroupingRetrieval.php.

                                                     : ?StandardLink
    {
        $ref_id = $this->data_factory->refId($ref_id);
        if (ilObject::_exists($ref_id->toInt(), true)) {
            $type = ilObject::_lookupType($ref_id->toInt(), true);
            $title = ilObject::_lookupTitle($ref_id->toObjectId()->toInt());
            $link = $this->static_url->builder()->build($type, $ref_id);
            return $this->ui_factory->link()->standard($title, (string) $link);
        }
        return null;
    }

References $ref_id, ilObject\_exists(), ilObject\_lookupTitle(), and ilObject\_lookupType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAllGroupingIDs()

ILIAS\Course\Grouping\Table\GroupingRetrieval::getAllGroupingIDs

(

)

Returns

int[]

Definition at line 96 of file GroupingRetrieval.php.

                                       : array
    {
        return ilObjCourseGrouping::_getVisibleGroupings($this->content_obj_id);
    }

References ilObjCourseGrouping\_getVisibleGroupings().

Here is the call graph for this function:

getRows()

ILIAS\Course\Grouping\Table\GroupingRetrieval::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.

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

Parameters

string[]

$visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 50 of file GroupingRetrieval.php.

     : Generator {
        $grouping_ids = $this->getAllGroupingIDs();
 
        $records = [];
        foreach ($grouping_ids as $grouping_id) {
            $grouping = new ilObjCourseGrouping($grouping_id);
            $record = [];
 
            $record[GroupingHandler::COL_TITLE] = $grouping->getTitle();
            $record[GroupingHandler::COL_DESCRIPTION] = $grouping->getDescription();
 
            $link = $this->buildLinkToObject($grouping->getContainerRefId());
            if ($link !== null) {
                $record[GroupingHandler::COL_SOURCE] = $link;
            }
 
            $record[GroupingHandler::COL_UNIQUE_FIELD] = $this->lng->txt($grouping->getUniqueField());
 
            $condition_ref_ids = [];
            foreach ($grouping->getAssignedItems() as $condition) {
                $condition_ref_ids[] = $condition['target_ref_id'];
            }
            $record[GroupingHandler::COL_ASSIGNED_OBJS] = $this->buildLinkListing(...$condition_ref_ids);
 
            $records[$grouping->getId()] = $record;
        }
 
        $records = $this->sortRecords($records, $order);
        $records = array_slice($records, $range->getStart(), $range->getLength(), true);
 
        foreach ($records as $id => $record) {
            yield $row_builder->buildDataRow((string) $id, $record);
        }
    }

References ILIAS\Course\Grouping\Table\GroupingRetrieval\buildLinkListing(), ILIAS\Course\Grouping\Table\GroupingRetrieval\buildLinkToObject(), ILIAS\Course\Grouping\Table\GroupingHandler\COL_ASSIGNED_OBJS, ILIAS\Course\Grouping\Table\GroupingHandler\COL_DESCRIPTION, ILIAS\Course\Grouping\Table\GroupingHandler\COL_SOURCE, ILIAS\Course\Grouping\Table\GroupingHandler\COL_TITLE, ILIAS\Course\Grouping\Table\GroupingHandler\COL_UNIQUE_FIELD, and ILIAS\Repository\lng().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Course\Grouping\Table\GroupingRetrieval::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 101 of file GroupingRetrieval.php.

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

sortRecords()

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

protected

Definition at line 133 of file GroupingRetrieval.php.

                                                                : array
    {
        $order_field = array_keys($order->get())[0] ?? GroupingHandler::COL_TITLE;
        $order_direction = $order->get()[$order_field] ?? Order::ASC;
 
        $ordering_callable_without_direction = match ($order_field) {
            GroupingHandler::COL_TITLE, GroupingHandler::COL_DESCRIPTION, GroupingHandler::COL_UNIQUE_FIELD =>
                fn($a, $b) => ($a[$order_field] ?? '') <=> ($b[$order_field] ?? ''),
            GroupingHandler::COL_SOURCE =>
                fn($a, $b) => ($a[GroupingHandler::COL_SOURCE]?->getLabel() ?? '') <=> ($b[GroupingHandler::COL_SOURCE]?->getLabel() ?? ''),
            GroupingHandler::COL_ASSIGNED_OBJS =>
                function ($a, $b) {
                    $a_items = ($a[GroupingHandler::COL_ASSIGNED_OBJS] ?? null)?->getItems() ?? [];
                    $b_items = ($b[GroupingHandler::COL_ASSIGNED_OBJS] ?? null)?->getItems() ?? [];
                    $a_first_item_label = ($a_items[0] ?? null)?->getLabel() ?? '';
                    $b_first_item_label = ($b_items[0] ?? null)?->getLabel() ?? '';
                    return $a_first_item_label <=> $b_first_item_label;
                }
        };
        $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;
    }

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\Data\Order\get(), and ILIAS\Test\Questions\Presentation\getLabel.

Here is the call graph for this function:

---

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

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