@phpstan-import-type RelationRecord from \ILIAS\Contact\BuddySystem\Tables\RelationsTable More...

Inheritance diagram for ILIAS\Contact\TableRows:

Collaboration diagram for ILIAS\Contact\TableRows:

Public Member Functions
	__construct (private readonly array $records, private readonly array $sigle_actions, private readonly Closure $link_to_profile)

	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...

Detailed Description

@phpstan-import-type RelationRecord from \ILIAS\Contact\BuddySystem\Tables\RelationsTable

Definition at line 33 of file TableRows.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Contact\TableRows::__construct	(	private readonly array	$records,
		private readonly array	$sigle_actions,
		private readonly Closure	$link_to_profile
	)

Parameters

list<RelationRecord>	$records
list<string>	$sigle_actions
Closure(int,string)	string $link_to_profile

Definition at line 40 of file TableRows.php.

44 {

45 }

Member Function Documentation

◆ getRows()

ILIAS\Contact\TableRows::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 47 of file TableRows.php.

     : Generator {
        [$order_field, $order_direction] = $order->join(
            [],
            fn($ret, $key, $value) => [$key, $value]
        );
 
        $records = $this->records;
 
        $times = $order_direction === 'ASC' ? 1 : -1;
        usort(
            $records,
            static fn(array $a, array $b): int => $times * strcasecmp(
                $a[$order_field],
                $b[$order_field]
            )
        );
 
        if ($range) {
            $records = \array_slice($records, $range->getStart(), $range->getLength());
        }
 
        foreach ($records as $row) {
            $row['public_name'] = ($this->link_to_profile)($row['user_id'], $row['public_name']);
            $row['login'] = ($this->link_to_profile)($row['user_id'], $row['login']);
 
            $transitions = array_map(
                static fn($s): string => $row['state'] . '->' . $s,
                $row['target_states']
            );
 
            $data_row = $row_builder->buildDataRow((string) $row['user_id'], $row);
            foreach ($this->sigle_actions as $action) {
                if (!\in_array($action, $transitions, true)) {
                    $data_row = $data_row->withDisabledAction($action);
                }
            }
 
            yield $data_row;
        }
    }

◆ getTotalRowCount()

ILIAS\Contact\TableRows::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.